553 lines
27 KiB
C
553 lines
27 KiB
C
|
|
/**
|
|||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#pragma once
|
|||
|
|
#include <aws/dynamodb/DynamoDB_EXPORTS.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|||
|
|
#include <aws/dynamodb/model/Projection.h>
|
|||
|
|
#include <aws/dynamodb/model/IndexStatus.h>
|
|||
|
|
#include <aws/dynamodb/model/ProvisionedThroughputDescription.h>
|
|||
|
|
#include <aws/dynamodb/model/KeySchemaElement.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace Utils
|
|||
|
|
{
|
|||
|
|
namespace Json
|
|||
|
|
{
|
|||
|
|
class JsonValue;
|
|||
|
|
class JsonView;
|
|||
|
|
} // namespace Json
|
|||
|
|
} // namespace Utils
|
|||
|
|
namespace DynamoDB
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the properties of a global secondary index.</p><p><h3>See
|
|||
|
|
* Also:</h3> <a
|
|||
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GlobalSecondaryIndexDescription">AWS
|
|||
|
|
* API Reference</a></p>
|
|||
|
|
*/
|
|||
|
|
class AWS_DYNAMODB_API GlobalSecondaryIndexDescription
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
GlobalSecondaryIndexDescription();
|
|||
|
|
GlobalSecondaryIndexDescription(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
GlobalSecondaryIndexDescription& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetIndexName() const{ return m_indexName; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexName(const Aws::String& value) { m_indexNameHasBeenSet = true; m_indexName = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexName(Aws::String&& value) { m_indexNameHasBeenSet = true; m_indexName = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexName(const char* value) { m_indexNameHasBeenSet = true; m_indexName.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexName(const Aws::String& value) { SetIndexName(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexName(Aws::String&& value) { SetIndexName(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the global secondary index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexName(const char* value) { SetIndexName(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::Vector<KeySchemaElement>& GetKeySchema() const{ return m_keySchema; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool KeySchemaHasBeenSet() const { return m_keySchemaHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetKeySchema(const Aws::Vector<KeySchemaElement>& value) { m_keySchemaHasBeenSet = true; m_keySchema = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetKeySchema(Aws::Vector<KeySchemaElement>&& value) { m_keySchemaHasBeenSet = true; m_keySchema = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithKeySchema(const Aws::Vector<KeySchemaElement>& value) { SetKeySchema(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithKeySchema(Aws::Vector<KeySchemaElement>&& value) { SetKeySchema(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& AddKeySchema(const KeySchemaElement& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The complete key schema for a global secondary index, which consists of one
|
|||
|
|
* or more pairs of attribute names and key types:</p> <ul> <li> <p>
|
|||
|
|
* <code>HASH</code> - partition key</p> </li> <li> <p> <code>RANGE</code> - sort
|
|||
|
|
* key</p> </li> </ul> <p>The partition key of an item is also known as its
|
|||
|
|
* <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB's usage
|
|||
|
|
* of an internal hash function to evenly distribute data items across partitions,
|
|||
|
|
* based on their partition key values.</p> <p>The sort key of an item is also
|
|||
|
|
* known as its <i>range attribute</i>. The term "range attribute" derives from the
|
|||
|
|
* way DynamoDB stores items with the same partition key physically close together,
|
|||
|
|
* in sorted order by the sort key value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& AddKeySchema(KeySchemaElement&& value) { m_keySchemaHasBeenSet = true; m_keySchema.push_back(std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline const Projection& GetProjection() const{ return m_projection; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline bool ProjectionHasBeenSet() const { return m_projectionHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline void SetProjection(const Projection& value) { m_projectionHasBeenSet = true; m_projection = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline void SetProjection(Projection&& value) { m_projectionHasBeenSet = true; m_projection = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithProjection(const Projection& value) { SetProjection(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents attributes that are copied (projected) from the table into the
|
|||
|
|
* global secondary index. These are in addition to the primary key attributes and
|
|||
|
|
* index key attributes, which are automatically projected. </p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithProjection(Projection&& value) { SetProjection(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline const IndexStatus& GetIndexStatus() const{ return m_indexStatus; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline bool IndexStatusHasBeenSet() const { return m_indexStatusHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexStatus(const IndexStatus& value) { m_indexStatusHasBeenSet = true; m_indexStatus = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexStatus(IndexStatus&& value) { m_indexStatusHasBeenSet = true; m_indexStatus = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexStatus(const IndexStatus& value) { SetIndexStatus(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The current state of the global secondary index:</p> <ul> <li> <p>
|
|||
|
|
* <code>CREATING</code> - The index is being created.</p> </li> <li> <p>
|
|||
|
|
* <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p>
|
|||
|
|
* <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p>
|
|||
|
|
* <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexStatus(IndexStatus&& value) { SetIndexStatus(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is
|
|||
|
|
* the process of reading items from the table and determining whether they can be
|
|||
|
|
* added to the index. (Not all items will qualify: For example, a partition key
|
|||
|
|
* cannot have any duplicate values.) If an item can be added to the index,
|
|||
|
|
* DynamoDB will do so. After all items have been processed, the backfilling
|
|||
|
|
* operation is complete and <code>Backfilling</code> is false.</p> <p>You can
|
|||
|
|
* delete an index that is being created during the <code>Backfilling</code> phase
|
|||
|
|
* when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* true. You can't delete the index that is being created when
|
|||
|
|
* <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* false. </p> <p>For indexes that were created during a
|
|||
|
|
* <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does
|
|||
|
|
* not appear in the <code>DescribeTable</code> output.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool GetBackfilling() const{ return m_backfilling; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is
|
|||
|
|
* the process of reading items from the table and determining whether they can be
|
|||
|
|
* added to the index. (Not all items will qualify: For example, a partition key
|
|||
|
|
* cannot have any duplicate values.) If an item can be added to the index,
|
|||
|
|
* DynamoDB will do so. After all items have been processed, the backfilling
|
|||
|
|
* operation is complete and <code>Backfilling</code> is false.</p> <p>You can
|
|||
|
|
* delete an index that is being created during the <code>Backfilling</code> phase
|
|||
|
|
* when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* true. You can't delete the index that is being created when
|
|||
|
|
* <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* false. </p> <p>For indexes that were created during a
|
|||
|
|
* <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does
|
|||
|
|
* not appear in the <code>DescribeTable</code> output.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool BackfillingHasBeenSet() const { return m_backfillingHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is
|
|||
|
|
* the process of reading items from the table and determining whether they can be
|
|||
|
|
* added to the index. (Not all items will qualify: For example, a partition key
|
|||
|
|
* cannot have any duplicate values.) If an item can be added to the index,
|
|||
|
|
* DynamoDB will do so. After all items have been processed, the backfilling
|
|||
|
|
* operation is complete and <code>Backfilling</code> is false.</p> <p>You can
|
|||
|
|
* delete an index that is being created during the <code>Backfilling</code> phase
|
|||
|
|
* when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* true. You can't delete the index that is being created when
|
|||
|
|
* <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* false. </p> <p>For indexes that were created during a
|
|||
|
|
* <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does
|
|||
|
|
* not appear in the <code>DescribeTable</code> output.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetBackfilling(bool value) { m_backfillingHasBeenSet = true; m_backfilling = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Indicates whether the index is currently backfilling. <i>Backfilling</i> is
|
|||
|
|
* the process of reading items from the table and determining whether they can be
|
|||
|
|
* added to the index. (Not all items will qualify: For example, a partition key
|
|||
|
|
* cannot have any duplicate values.) If an item can be added to the index,
|
|||
|
|
* DynamoDB will do so. After all items have been processed, the backfilling
|
|||
|
|
* operation is complete and <code>Backfilling</code> is false.</p> <p>You can
|
|||
|
|
* delete an index that is being created during the <code>Backfilling</code> phase
|
|||
|
|
* when <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* true. You can't delete the index that is being created when
|
|||
|
|
* <code>IndexStatus</code> is set to CREATING and <code>Backfilling</code> is
|
|||
|
|
* false. </p> <p>For indexes that were created during a
|
|||
|
|
* <code>CreateTable</code> operation, the <code>Backfilling</code> attribute does
|
|||
|
|
* not appear in the <code>DescribeTable</code> output.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithBackfilling(bool value) { SetBackfilling(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline const ProvisionedThroughputDescription& GetProvisionedThroughput() const{ return m_provisionedThroughput; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool ProvisionedThroughputHasBeenSet() const { return m_provisionedThroughputHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetProvisionedThroughput(const ProvisionedThroughputDescription& value) { m_provisionedThroughputHasBeenSet = true; m_provisionedThroughput = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetProvisionedThroughput(ProvisionedThroughputDescription&& value) { m_provisionedThroughputHasBeenSet = true; m_provisionedThroughput = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithProvisionedThroughput(const ProvisionedThroughputDescription& value) { SetProvisionedThroughput(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Represents the provisioned throughput settings for the specified global
|
|||
|
|
* secondary index.</p> <p>For current minimum and maximum provisioned throughput
|
|||
|
|
* values, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a>
|
|||
|
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithProvisionedThroughput(ProvisionedThroughputDescription&& value) { SetProvisionedThroughput(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline long long GetIndexSizeBytes() const{ return m_indexSizeBytes; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool IndexSizeBytesHasBeenSet() const { return m_indexSizeBytesHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexSizeBytes(long long value) { m_indexSizeBytesHasBeenSet = true; m_indexSizeBytes = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexSizeBytes(long long value) { SetIndexSizeBytes(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The number of items in the specified index. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline long long GetItemCount() const{ return m_itemCount; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The number of items in the specified index. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool ItemCountHasBeenSet() const { return m_itemCountHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The number of items in the specified index. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetItemCount(long long value) { m_itemCountHasBeenSet = true; m_itemCount = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The number of items in the specified index. DynamoDB updates this value
|
|||
|
|
* approximately every six hours. Recent changes might not be reflected in this
|
|||
|
|
* value.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithItemCount(long long value) { SetItemCount(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetIndexArn() const{ return m_indexArn; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool IndexArnHasBeenSet() const { return m_indexArnHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexArn(const Aws::String& value) { m_indexArnHasBeenSet = true; m_indexArn = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexArn(Aws::String&& value) { m_indexArnHasBeenSet = true; m_indexArn = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetIndexArn(const char* value) { m_indexArnHasBeenSet = true; m_indexArn.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexArn(const Aws::String& value) { SetIndexArn(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexArn(Aws::String&& value) { SetIndexArn(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|||
|
|
*/
|
|||
|
|
inline GlobalSecondaryIndexDescription& WithIndexArn(const char* value) { SetIndexArn(value); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::String m_indexName;
|
|||
|
|
bool m_indexNameHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::Vector<KeySchemaElement> m_keySchema;
|
|||
|
|
bool m_keySchemaHasBeenSet;
|
|||
|
|
|
|||
|
|
Projection m_projection;
|
|||
|
|
bool m_projectionHasBeenSet;
|
|||
|
|
|
|||
|
|
IndexStatus m_indexStatus;
|
|||
|
|
bool m_indexStatusHasBeenSet;
|
|||
|
|
|
|||
|
|
bool m_backfilling;
|
|||
|
|
bool m_backfillingHasBeenSet;
|
|||
|
|
|
|||
|
|
ProvisionedThroughputDescription m_provisionedThroughput;
|
|||
|
|
bool m_provisionedThroughputHasBeenSet;
|
|||
|
|
|
|||
|
|
long long m_indexSizeBytes;
|
|||
|
|
bool m_indexSizeBytesHasBeenSet;
|
|||
|
|
|
|||
|
|
long long m_itemCount;
|
|||
|
|
bool m_itemCountHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_indexArn;
|
|||
|
|
bool m_indexArnHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace DynamoDB
|
|||
|
|
} // namespace Aws
|