AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDB::Model::CreateTableRequest Class Reference

#include <CreateTableRequest.h>

+ Inheritance diagram for Aws::DynamoDB::Model::CreateTableRequest:

Public Member Functions

 CreateTableRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< AttributeDefinition > & GetAttributeDefinitions () const
 
bool AttributeDefinitionsHasBeenSet () const
 
void SetAttributeDefinitions (const Aws::Vector< AttributeDefinition > &value)
 
void SetAttributeDefinitions (Aws::Vector< AttributeDefinition > &&value)
 
CreateTableRequestWithAttributeDefinitions (const Aws::Vector< AttributeDefinition > &value)
 
CreateTableRequestWithAttributeDefinitions (Aws::Vector< AttributeDefinition > &&value)
 
CreateTableRequestAddAttributeDefinitions (const AttributeDefinition &value)
 
CreateTableRequestAddAttributeDefinitions (AttributeDefinition &&value)
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
CreateTableRequestWithTableName (const Aws::String &value)
 
CreateTableRequestWithTableName (Aws::String &&value)
 
CreateTableRequestWithTableName (const char *value)
 
const Aws::Vector< KeySchemaElement > & GetKeySchema () const
 
bool KeySchemaHasBeenSet () const
 
void SetKeySchema (const Aws::Vector< KeySchemaElement > &value)
 
void SetKeySchema (Aws::Vector< KeySchemaElement > &&value)
 
CreateTableRequestWithKeySchema (const Aws::Vector< KeySchemaElement > &value)
 
CreateTableRequestWithKeySchema (Aws::Vector< KeySchemaElement > &&value)
 
CreateTableRequestAddKeySchema (const KeySchemaElement &value)
 
CreateTableRequestAddKeySchema (KeySchemaElement &&value)
 
const Aws::Vector< LocalSecondaryIndex > & GetLocalSecondaryIndexes () const
 
bool LocalSecondaryIndexesHasBeenSet () const
 
void SetLocalSecondaryIndexes (const Aws::Vector< LocalSecondaryIndex > &value)
 
void SetLocalSecondaryIndexes (Aws::Vector< LocalSecondaryIndex > &&value)
 
CreateTableRequestWithLocalSecondaryIndexes (const Aws::Vector< LocalSecondaryIndex > &value)
 
CreateTableRequestWithLocalSecondaryIndexes (Aws::Vector< LocalSecondaryIndex > &&value)
 
CreateTableRequestAddLocalSecondaryIndexes (const LocalSecondaryIndex &value)
 
CreateTableRequestAddLocalSecondaryIndexes (LocalSecondaryIndex &&value)
 
const Aws::Vector< GlobalSecondaryIndex > & GetGlobalSecondaryIndexes () const
 
bool GlobalSecondaryIndexesHasBeenSet () const
 
void SetGlobalSecondaryIndexes (const Aws::Vector< GlobalSecondaryIndex > &value)
 
void SetGlobalSecondaryIndexes (Aws::Vector< GlobalSecondaryIndex > &&value)
 
CreateTableRequestWithGlobalSecondaryIndexes (const Aws::Vector< GlobalSecondaryIndex > &value)
 
CreateTableRequestWithGlobalSecondaryIndexes (Aws::Vector< GlobalSecondaryIndex > &&value)
 
CreateTableRequestAddGlobalSecondaryIndexes (const GlobalSecondaryIndex &value)
 
CreateTableRequestAddGlobalSecondaryIndexes (GlobalSecondaryIndex &&value)
 
const BillingModeGetBillingMode () const
 
bool BillingModeHasBeenSet () const
 
void SetBillingMode (const BillingMode &value)
 
void SetBillingMode (BillingMode &&value)
 
CreateTableRequestWithBillingMode (const BillingMode &value)
 
CreateTableRequestWithBillingMode (BillingMode &&value)
 
const ProvisionedThroughputGetProvisionedThroughput () const
 
bool ProvisionedThroughputHasBeenSet () const
 
void SetProvisionedThroughput (const ProvisionedThroughput &value)
 
void SetProvisionedThroughput (ProvisionedThroughput &&value)
 
CreateTableRequestWithProvisionedThroughput (const ProvisionedThroughput &value)
 
CreateTableRequestWithProvisionedThroughput (ProvisionedThroughput &&value)
 
const StreamSpecificationGetStreamSpecification () const
 
bool StreamSpecificationHasBeenSet () const
 
void SetStreamSpecification (const StreamSpecification &value)
 
void SetStreamSpecification (StreamSpecification &&value)
 
CreateTableRequestWithStreamSpecification (const StreamSpecification &value)
 
CreateTableRequestWithStreamSpecification (StreamSpecification &&value)
 
const SSESpecificationGetSSESpecification () const
 
bool SSESpecificationHasBeenSet () const
 
void SetSSESpecification (const SSESpecification &value)
 
void SetSSESpecification (SSESpecification &&value)
 
CreateTableRequestWithSSESpecification (const SSESpecification &value)
 
CreateTableRequestWithSSESpecification (SSESpecification &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateTableRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateTableRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateTableRequestAddTags (const Tag &value)
 
CreateTableRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::DynamoDB::DynamoDBRequest
virtual ~DynamoDBRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input of a CreateTable operation.

See Also:

AWS API Reference

Definition at line 35 of file CreateTableRequest.h.

Constructor & Destructor Documentation

◆ CreateTableRequest()

Aws::DynamoDB::Model::CreateTableRequest::CreateTableRequest ( )

Member Function Documentation

◆ AddAttributeDefinitions() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddAttributeDefinitions ( const AttributeDefinition value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 91 of file CreateTableRequest.h.

◆ AddAttributeDefinitions() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddAttributeDefinitions ( AttributeDefinition &&  value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 97 of file CreateTableRequest.h.

◆ AddGlobalSecondaryIndexes() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddGlobalSecondaryIndexes ( const GlobalSecondaryIndex value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 778 of file CreateTableRequest.h.

◆ AddGlobalSecondaryIndexes() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddGlobalSecondaryIndexes ( GlobalSecondaryIndex &&  value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 805 of file CreateTableRequest.h.

◆ AddKeySchema() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddKeySchema ( const KeySchemaElement value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 335 of file CreateTableRequest.h.

◆ AddKeySchema() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddKeySchema ( KeySchemaElement &&  value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 363 of file CreateTableRequest.h.

◆ AddLocalSecondaryIndexes() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddLocalSecondaryIndexes ( const LocalSecondaryIndex value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 560 of file CreateTableRequest.h.

◆ AddLocalSecondaryIndexes() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddLocalSecondaryIndexes ( LocalSecondaryIndex &&  value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 588 of file CreateTableRequest.h.

◆ AddTags() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddTags ( const Tag value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1147 of file CreateTableRequest.h.

◆ AddTags() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::AddTags ( Tag &&  value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1154 of file CreateTableRequest.h.

◆ AttributeDefinitionsHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::AttributeDefinitionsHasBeenSet ( ) const
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 61 of file CreateTableRequest.h.

◆ BillingModeHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::BillingModeHasBeenSet ( ) const
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 834 of file CreateTableRequest.h.

◆ GetAttributeDefinitions()

const Aws::Vector<AttributeDefinition>& Aws::DynamoDB::Model::CreateTableRequest::GetAttributeDefinitions ( ) const
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 55 of file CreateTableRequest.h.

◆ GetBillingMode()

const BillingMode& Aws::DynamoDB::Model::CreateTableRequest::GetBillingMode ( ) const
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 820 of file CreateTableRequest.h.

◆ GetGlobalSecondaryIndexes()

const Aws::Vector<GlobalSecondaryIndex>& Aws::DynamoDB::Model::CreateTableRequest::GetGlobalSecondaryIndexes ( ) const
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 616 of file CreateTableRequest.h.

◆ GetKeySchema()

const Aws::Vector<KeySchemaElement>& Aws::DynamoDB::Model::CreateTableRequest::GetKeySchema ( ) const
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 167 of file CreateTableRequest.h.

◆ GetLocalSecondaryIndexes()

const Aws::Vector<LocalSecondaryIndex>& Aws::DynamoDB::Model::CreateTableRequest::GetLocalSecondaryIndexes ( ) const
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 392 of file CreateTableRequest.h.

◆ GetProvisionedThroughput()

const ProvisionedThroughput& Aws::DynamoDB::Model::CreateTableRequest::GetProvisionedThroughput ( ) const
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 903 of file CreateTableRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDB::Model::CreateTableRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDB::Model::CreateTableRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file CreateTableRequest.h.

◆ GetSSESpecification()

const SSESpecification& Aws::DynamoDB::Model::CreateTableRequest::GetSSESpecification ( ) const
inline

Represents the settings used to enable server-side encryption.

Definition at line 1072 of file CreateTableRequest.h.

◆ GetStreamSpecification()

const StreamSpecification& Aws::DynamoDB::Model::CreateTableRequest::GetStreamSpecification ( ) const
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 981 of file CreateTableRequest.h.

◆ GetTableName()

const Aws::String& Aws::DynamoDB::Model::CreateTableRequest::GetTableName ( ) const
inline

The name of the table to create.

Definition at line 103 of file CreateTableRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::DynamoDB::Model::CreateTableRequest::GetTags ( ) const
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1105 of file CreateTableRequest.h.

◆ GlobalSecondaryIndexesHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::GlobalSecondaryIndexesHasBeenSet ( ) const
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 643 of file CreateTableRequest.h.

◆ KeySchemaHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::KeySchemaHasBeenSet ( ) const
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 195 of file CreateTableRequest.h.

◆ LocalSecondaryIndexesHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::LocalSecondaryIndexesHasBeenSet ( ) const
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 420 of file CreateTableRequest.h.

◆ ProvisionedThroughputHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::ProvisionedThroughputHasBeenSet ( ) const
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 915 of file CreateTableRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDB::Model::CreateTableRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeDefinitions() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetAttributeDefinitions ( const Aws::Vector< AttributeDefinition > &  value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 67 of file CreateTableRequest.h.

◆ SetAttributeDefinitions() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetAttributeDefinitions ( Aws::Vector< AttributeDefinition > &&  value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 73 of file CreateTableRequest.h.

◆ SetBillingMode() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetBillingMode ( const BillingMode value)
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 848 of file CreateTableRequest.h.

◆ SetBillingMode() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetBillingMode ( BillingMode &&  value)
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 862 of file CreateTableRequest.h.

◆ SetGlobalSecondaryIndexes() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetGlobalSecondaryIndexes ( const Aws::Vector< GlobalSecondaryIndex > &  value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 670 of file CreateTableRequest.h.

◆ SetGlobalSecondaryIndexes() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetGlobalSecondaryIndexes ( Aws::Vector< GlobalSecondaryIndex > &&  value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 697 of file CreateTableRequest.h.

◆ SetKeySchema() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetKeySchema ( const Aws::Vector< KeySchemaElement > &  value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 223 of file CreateTableRequest.h.

◆ SetKeySchema() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetKeySchema ( Aws::Vector< KeySchemaElement > &&  value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 251 of file CreateTableRequest.h.

◆ SetLocalSecondaryIndexes() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetLocalSecondaryIndexes ( const Aws::Vector< LocalSecondaryIndex > &  value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 448 of file CreateTableRequest.h.

◆ SetLocalSecondaryIndexes() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetLocalSecondaryIndexes ( Aws::Vector< LocalSecondaryIndex > &&  value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 476 of file CreateTableRequest.h.

◆ SetProvisionedThroughput() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetProvisionedThroughput ( const ProvisionedThroughput value)
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 927 of file CreateTableRequest.h.

◆ SetProvisionedThroughput() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetProvisionedThroughput ( ProvisionedThroughput &&  value)
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 939 of file CreateTableRequest.h.

◆ SetSSESpecification() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetSSESpecification ( const SSESpecification value)
inline

Represents the settings used to enable server-side encryption.

Definition at line 1082 of file CreateTableRequest.h.

◆ SetSSESpecification() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetSSESpecification ( SSESpecification &&  value)
inline

Represents the settings used to enable server-side encryption.

Definition at line 1087 of file CreateTableRequest.h.

◆ SetStreamSpecification() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetStreamSpecification ( const StreamSpecification value)
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 1015 of file CreateTableRequest.h.

◆ SetStreamSpecification() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetStreamSpecification ( StreamSpecification &&  value)
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 1032 of file CreateTableRequest.h.

◆ SetTableName() [1/3]

void Aws::DynamoDB::Model::CreateTableRequest::SetTableName ( const Aws::String value)
inline

The name of the table to create.

Definition at line 113 of file CreateTableRequest.h.

◆ SetTableName() [2/3]

void Aws::DynamoDB::Model::CreateTableRequest::SetTableName ( Aws::String &&  value)
inline

The name of the table to create.

Definition at line 118 of file CreateTableRequest.h.

◆ SetTableName() [3/3]

void Aws::DynamoDB::Model::CreateTableRequest::SetTableName ( const char *  value)
inline

The name of the table to create.

Definition at line 123 of file CreateTableRequest.h.

◆ SetTags() [1/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1119 of file CreateTableRequest.h.

◆ SetTags() [2/2]

void Aws::DynamoDB::Model::CreateTableRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1126 of file CreateTableRequest.h.

◆ SSESpecificationHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::SSESpecificationHasBeenSet ( ) const
inline

Represents the settings used to enable server-side encryption.

Definition at line 1077 of file CreateTableRequest.h.

◆ StreamSpecificationHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::StreamSpecificationHasBeenSet ( ) const
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 998 of file CreateTableRequest.h.

◆ TableNameHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::TableNameHasBeenSet ( ) const
inline

The name of the table to create.

Definition at line 108 of file CreateTableRequest.h.

◆ TagsHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::TagsHasBeenSet ( ) const
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1112 of file CreateTableRequest.h.

◆ WithAttributeDefinitions() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithAttributeDefinitions ( const Aws::Vector< AttributeDefinition > &  value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 79 of file CreateTableRequest.h.

◆ WithAttributeDefinitions() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithAttributeDefinitions ( Aws::Vector< AttributeDefinition > &&  value)
inline

An array of attributes that describe the key schema for the table and indexes.

Definition at line 85 of file CreateTableRequest.h.

◆ WithBillingMode() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithBillingMode ( const BillingMode value)
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 876 of file CreateTableRequest.h.

◆ WithBillingMode() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithBillingMode ( BillingMode &&  value)
inline

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

Definition at line 890 of file CreateTableRequest.h.

◆ WithGlobalSecondaryIndexes() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithGlobalSecondaryIndexes ( const Aws::Vector< GlobalSecondaryIndex > &  value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 724 of file CreateTableRequest.h.

◆ WithGlobalSecondaryIndexes() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithGlobalSecondaryIndexes ( Aws::Vector< GlobalSecondaryIndex > &&  value)
inline

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

Definition at line 751 of file CreateTableRequest.h.

◆ WithKeySchema() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithKeySchema ( const Aws::Vector< KeySchemaElement > &  value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 279 of file CreateTableRequest.h.

◆ WithKeySchema() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithKeySchema ( Aws::Vector< KeySchemaElement > &&  value)
inline

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE

      • sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. 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.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Definition at line 307 of file CreateTableRequest.h.

◆ WithLocalSecondaryIndexes() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithLocalSecondaryIndexes ( const Aws::Vector< LocalSecondaryIndex > &  value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 504 of file CreateTableRequest.h.

◆ WithLocalSecondaryIndexes() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithLocalSecondaryIndexes ( Aws::Vector< LocalSecondaryIndex > &&  value)
inline

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Definition at line 532 of file CreateTableRequest.h.

◆ WithProvisionedThroughput() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithProvisionedThroughput ( const ProvisionedThroughput value)
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 951 of file CreateTableRequest.h.

◆ WithProvisionedThroughput() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithProvisionedThroughput ( ProvisionedThroughput &&  value)
inline

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Definition at line 963 of file CreateTableRequest.h.

◆ WithSSESpecification() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithSSESpecification ( const SSESpecification value)
inline

Represents the settings used to enable server-side encryption.

Definition at line 1092 of file CreateTableRequest.h.

◆ WithSSESpecification() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithSSESpecification ( SSESpecification &&  value)
inline

Represents the settings used to enable server-side encryption.

Definition at line 1097 of file CreateTableRequest.h.

◆ WithStreamSpecification() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithStreamSpecification ( const StreamSpecification value)
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 1049 of file CreateTableRequest.h.

◆ WithStreamSpecification() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithStreamSpecification ( StreamSpecification &&  value)
inline

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

Definition at line 1066 of file CreateTableRequest.h.

◆ WithTableName() [1/3]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithTableName ( const Aws::String value)
inline

The name of the table to create.

Definition at line 128 of file CreateTableRequest.h.

◆ WithTableName() [2/3]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithTableName ( Aws::String &&  value)
inline

The name of the table to create.

Definition at line 133 of file CreateTableRequest.h.

◆ WithTableName() [3/3]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithTableName ( const char *  value)
inline

The name of the table to create.

Definition at line 138 of file CreateTableRequest.h.

◆ WithTags() [1/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1133 of file CreateTableRequest.h.

◆ WithTags() [2/2]

CreateTableRequest& Aws::DynamoDB::Model::CreateTableRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Definition at line 1140 of file CreateTableRequest.h.


The documentation for this class was generated from the following file: