Aws::DynamoDB::Model::CreateTableRequest Class Reference

#include <CreateTableRequest.h>

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

Public Member Functions

AWS_DYNAMODB_API CreateTableRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_DYNAMODB_API Aws::String SerializePayload () const override

 

AWS_DYNAMODB_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

AWS_DYNAMODB_API EndpointParameters GetEndpointContextParams () const override

 

const Aws::Vector< AttributeDefinition > & GetAttributeDefinitions () const

 

bool AttributeDefinitionsHasBeenSet () const

 

template<typename AttributeDefinitionsT = Aws::Vector<AttributeDefinition>>

void SetAttributeDefinitions (AttributeDefinitionsT &&value)

 

template<typename AttributeDefinitionsT = Aws::Vector<AttributeDefinition>>

CreateTableRequest & WithAttributeDefinitions (AttributeDefinitionsT &&value)

 

template<typename AttributeDefinitionsT = AttributeDefinition>

CreateTableRequest & AddAttributeDefinitions (AttributeDefinitionsT &&value)

 

const Aws::String & GetTableName () const

 

bool TableNameHasBeenSet () const

 

template<typename TableNameT = Aws::String>

void SetTableName (TableNameT &&value)

 

template<typename TableNameT = Aws::String>

CreateTableRequest & WithTableName (TableNameT &&value)

 

const Aws::Vector< KeySchemaElement > & GetKeySchema () const

 

bool KeySchemaHasBeenSet () const

 

template<typename KeySchemaT = Aws::Vector<KeySchemaElement>>

void SetKeySchema (KeySchemaT &&value)

 

template<typename KeySchemaT = Aws::Vector<KeySchemaElement>>

CreateTableRequest & WithKeySchema (KeySchemaT &&value)

 

template<typename KeySchemaT = KeySchemaElement>

CreateTableRequest & AddKeySchema (KeySchemaT &&value)

 

const Aws::Vector< LocalSecondaryIndex > & GetLocalSecondaryIndexes () const

 

bool LocalSecondaryIndexesHasBeenSet () const

 

template<typename LocalSecondaryIndexesT = Aws::Vector<LocalSecondaryIndex>>

void SetLocalSecondaryIndexes (LocalSecondaryIndexesT &&value)

 

template<typename LocalSecondaryIndexesT = Aws::Vector<LocalSecondaryIndex>>

CreateTableRequest & WithLocalSecondaryIndexes (LocalSecondaryIndexesT &&value)

 

template<typename LocalSecondaryIndexesT = LocalSecondaryIndex>

CreateTableRequest & AddLocalSecondaryIndexes (LocalSecondaryIndexesT &&value)

 

const Aws::Vector< GlobalSecondaryIndex > & GetGlobalSecondaryIndexes () const

 

bool GlobalSecondaryIndexesHasBeenSet () const

 

template<typename GlobalSecondaryIndexesT = Aws::Vector<GlobalSecondaryIndex>>

void SetGlobalSecondaryIndexes (GlobalSecondaryIndexesT &&value)

 

template<typename GlobalSecondaryIndexesT = Aws::Vector<GlobalSecondaryIndex>>

CreateTableRequest & WithGlobalSecondaryIndexes (GlobalSecondaryIndexesT &&value)

 

template<typename GlobalSecondaryIndexesT = GlobalSecondaryIndex>

CreateTableRequest & AddGlobalSecondaryIndexes (GlobalSecondaryIndexesT &&value)

 

BillingMode GetBillingMode () const

 

bool BillingModeHasBeenSet () const

 

void SetBillingMode (BillingMode value)

 

CreateTableRequest & WithBillingMode (BillingMode value)

 

const ProvisionedThroughput & GetProvisionedThroughput () const

 

bool ProvisionedThroughputHasBeenSet () const

 

template<typename ProvisionedThroughputT = ProvisionedThroughput>

void SetProvisionedThroughput (ProvisionedThroughputT &&value)

 

template<typename ProvisionedThroughputT = ProvisionedThroughput>

CreateTableRequest & WithProvisionedThroughput (ProvisionedThroughputT &&value)

 

const StreamSpecification & GetStreamSpecification () const

 

bool StreamSpecificationHasBeenSet () const

 

template<typename StreamSpecificationT = StreamSpecification>

void SetStreamSpecification (StreamSpecificationT &&value)

 

template<typename StreamSpecificationT = StreamSpecification>

CreateTableRequest & WithStreamSpecification (StreamSpecificationT &&value)

 

const SSESpecification & GetSSESpecification () const

 

bool SSESpecificationHasBeenSet () const

 

template<typename SSESpecificationT = SSESpecification>

void SetSSESpecification (SSESpecificationT &&value)

 

template<typename SSESpecificationT = SSESpecification>

CreateTableRequest & WithSSESpecification (SSESpecificationT &&value)

 

const Aws::Vector< Tag > & GetTags () const

 

bool TagsHasBeenSet () const

 

template<typename TagsT = Aws::Vector<Tag>>

void SetTags (TagsT &&value)

 

template<typename TagsT = Aws::Vector<Tag>>

CreateTableRequest & WithTags (TagsT &&value)

 

template<typename TagsT = Tag>

CreateTableRequest & AddTags (TagsT &&value)

 

TableClass GetTableClass () const

 

bool TableClassHasBeenSet () const

 

void SetTableClass (TableClass value)

 

CreateTableRequest & WithTableClass (TableClass value)

 

bool GetDeletionProtectionEnabled () const

 

bool DeletionProtectionEnabledHasBeenSet () const

 

void SetDeletionProtectionEnabled (bool value)

 

CreateTableRequest & WithDeletionProtectionEnabled (bool value)

 

const WarmThroughput & GetWarmThroughput () const

 

bool WarmThroughputHasBeenSet () const

 

template<typename WarmThroughputT = WarmThroughput>

void SetWarmThroughput (WarmThroughputT &&value)

 

template<typename WarmThroughputT = WarmThroughput>

CreateTableRequest & WithWarmThroughput (WarmThroughputT &&value)

 

const Aws::String & GetResourcePolicy () const

 

bool ResourcePolicyHasBeenSet () const

 

template<typename ResourcePolicyT = Aws::String>

void SetResourcePolicy (ResourcePolicyT &&value)

 

template<typename ResourcePolicyT = Aws::String>

CreateTableRequest & WithResourcePolicy (ResourcePolicyT &&value)

 

const OnDemandThroughput & GetOnDemandThroughput () const

 

bool OnDemandThroughputHasBeenSet () const

 

template<typename OnDemandThroughputT = OnDemandThroughput>

void SetOnDemandThroughput (OnDemandThroughputT &&value)

 

template<typename OnDemandThroughputT = OnDemandThroughput>

CreateTableRequest & WithOnDemandThroughput (OnDemandThroughputT &&value)

 

const Aws::String & GetGlobalTableSourceArn () const

 

bool GlobalTableSourceArnHasBeenSet () const

 

template<typename GlobalTableSourceArnT = Aws::String>

void SetGlobalTableSourceArn (GlobalTableSourceArnT &&value)

 

template<typename GlobalTableSourceArnT = Aws::String>

CreateTableRequest & WithGlobalTableSourceArn (GlobalTableSourceArnT &&value)

 

GlobalTableSettingsReplicationMode GetGlobalTableSettingsReplicationMode () const

 

bool GlobalTableSettingsReplicationModeHasBeenSet () const

 

void SetGlobalTableSettingsReplicationMode (GlobalTableSettingsReplicationMode value)

 

CreateTableRequest & WithGlobalTableSettingsReplicationMode (GlobalTableSettingsReplicationMode 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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::DynamoDB::DynamoDBRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Represents the input of a CreateTable operation.

See Also:

AWS API Reference

Definition at line 37 of file CreateTableRequest.h.

Constructor & Destructor Documentation

CreateTableRequest()

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

default

Member Function Documentation

AddAttributeDefinitions()

template<typename AttributeDefinitionsT = AttributeDefinition>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::AddAttributeDefinitions ( AttributeDefinitionsT &&  value)

inline

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

Definition at line 74 of file CreateTableRequest.h.

AddGlobalSecondaryIndexes()

template<typename GlobalSecondaryIndexesT = GlobalSecondaryIndex>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::AddGlobalSecondaryIndexes ( GlobalSecondaryIndexesT &&  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. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.

• 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

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

Definition at line 241 of file CreateTableRequest.h.

AddKeySchema()

template<typename KeySchemaT = KeySchemaElement>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::AddKeySchema ( KeySchemaT &&  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 140 of file CreateTableRequest.h.

AddLocalSecondaryIndexes()

template<typename LocalSecondaryIndexesT = LocalSecondaryIndex>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::AddLocalSecondaryIndexes ( LocalSecondaryIndexesT &&  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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Definition at line 190 of file CreateTableRequest.h.

AddTags()

template<typename TagsT = Tag>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::AddTags ( TagsT &&  value)

inline

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

Definition at line 367 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 62 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.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

• PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

Definition at line 264 of file CreateTableRequest.h.

DeletionProtectionEnabledHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::DeletionProtectionEnabledHasBeenSet ( ) const

inline

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Definition at line 397 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 61 of file CreateTableRequest.h.

GetBillingMode()

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.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

• PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

Definition at line 263 of file CreateTableRequest.h.

GetDeletionProtectionEnabled()

bool Aws::DynamoDB::Model::CreateTableRequest::GetDeletionProtectionEnabled ( ) const

inline

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Definition at line 396 of file CreateTableRequest.h.

GetEndpointContextParams()

AWS_DYNAMODB_API EndpointParameters Aws::DynamoDB::Model::CreateTableRequest::GetEndpointContextParams ( ) const

overridevirtual

Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.

Reimplemented from Aws::AmazonWebServiceRequest.

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. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.

• 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

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

Definition at line 228 of file CreateTableRequest.h.

GetGlobalTableSettingsReplicationMode()

GlobalTableSettingsReplicationMode Aws::DynamoDB::Model::CreateTableRequest::GetGlobalTableSettingsReplicationMode ( ) const

inline

Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED_WITH_OVERRIDES.

Definition at line 502 of file CreateTableRequest.h.

GetGlobalTableSourceArn()

const Aws::String & Aws::DynamoDB::Model::CreateTableRequest::GetGlobalTableSourceArn ( ) const

inline

The Amazon Resource Name (ARN) of the source table used for the creation of a multi-account global table.

Definition at line 481 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 127 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Definition at line 177 of file CreateTableRequest.h.

GetOnDemandThroughput()

const OnDemandThroughput & Aws::DynamoDB::Model::CreateTableRequest::GetOnDemandThroughput ( ) const

inline

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Definition at line 462 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 286 of file CreateTableRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

GetResourcePolicy()

const Aws::String & Aws::DynamoDB::Model::CreateTableRequest::GetResourcePolicy ( ) const

inline

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Definition at line 441 of file CreateTableRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 45 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 334 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 316 of file CreateTableRequest.h.

GetTableClass()

TableClass Aws::DynamoDB::Model::CreateTableRequest::GetTableClass ( ) const

inline

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Definition at line 379 of file CreateTableRequest.h.

GetTableName()

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

inline

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Definition at line 86 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 354 of file CreateTableRequest.h.

GetWarmThroughput()

const WarmThroughput & Aws::DynamoDB::Model::CreateTableRequest::GetWarmThroughput ( ) const

inline

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Definition at line 413 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. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.

• 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

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

Definition at line 229 of file CreateTableRequest.h.

GlobalTableSettingsReplicationModeHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::GlobalTableSettingsReplicationModeHasBeenSet ( ) const

inline

Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED_WITH_OVERRIDES.

Definition at line 503 of file CreateTableRequest.h.

GlobalTableSourceArnHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::GlobalTableSourceArnHasBeenSet ( ) const

inline

The Amazon Resource Name (ARN) of the source table used for the creation of a multi-account global table.

Definition at line 482 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 128 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Definition at line 178 of file CreateTableRequest.h.

OnDemandThroughputHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::OnDemandThroughputHasBeenSet ( ) const

inline

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Definition at line 463 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 287 of file CreateTableRequest.h.

ResourcePolicyHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::ResourcePolicyHasBeenSet ( ) const

inline

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Definition at line 442 of file CreateTableRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetAttributeDefinitions()

template<typename AttributeDefinitionsT = Aws::Vector<AttributeDefinition>>

void Aws::DynamoDB::Model::CreateTableRequest::SetAttributeDefinitions ( AttributeDefinitionsT &&  value)

inline

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

Definition at line 64 of file CreateTableRequest.h.

SetBillingMode()

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.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

• PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

Definition at line 265 of file CreateTableRequest.h.

SetDeletionProtectionEnabled()

void Aws::DynamoDB::Model::CreateTableRequest::SetDeletionProtectionEnabled ( bool  value)

inline

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Definition at line 398 of file CreateTableRequest.h.

SetGlobalSecondaryIndexes()

template<typename GlobalSecondaryIndexesT = Aws::Vector<GlobalSecondaryIndex>>

void Aws::DynamoDB::Model::CreateTableRequest::SetGlobalSecondaryIndexes ( GlobalSecondaryIndexesT &&  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. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.

• 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

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

Definition at line 231 of file CreateTableRequest.h.

SetGlobalTableSettingsReplicationMode()

void Aws::DynamoDB::Model::CreateTableRequest::SetGlobalTableSettingsReplicationMode ( GlobalTableSettingsReplicationMode  value)

inline

Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED_WITH_OVERRIDES.

Definition at line 504 of file CreateTableRequest.h.

SetGlobalTableSourceArn()

template<typename GlobalTableSourceArnT = Aws::String>

void Aws::DynamoDB::Model::CreateTableRequest::SetGlobalTableSourceArn ( GlobalTableSourceArnT &&  value)

inline

The Amazon Resource Name (ARN) of the source table used for the creation of a multi-account global table.

Definition at line 484 of file CreateTableRequest.h.

SetKeySchema()

template<typename KeySchemaT = Aws::Vector<KeySchemaElement>>

void Aws::DynamoDB::Model::CreateTableRequest::SetKeySchema ( KeySchemaT &&  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 130 of file CreateTableRequest.h.

SetLocalSecondaryIndexes()

template<typename LocalSecondaryIndexesT = Aws::Vector<LocalSecondaryIndex>>

void Aws::DynamoDB::Model::CreateTableRequest::SetLocalSecondaryIndexes ( LocalSecondaryIndexesT &&  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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Definition at line 180 of file CreateTableRequest.h.

SetOnDemandThroughput()

template<typename OnDemandThroughputT = OnDemandThroughput>

void Aws::DynamoDB::Model::CreateTableRequest::SetOnDemandThroughput ( OnDemandThroughputT &&  value)

inline

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Definition at line 465 of file CreateTableRequest.h.

SetProvisionedThroughput()

template<typename ProvisionedThroughputT = ProvisionedThroughput>

void Aws::DynamoDB::Model::CreateTableRequest::SetProvisionedThroughput ( ProvisionedThroughputT &&  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 289 of file CreateTableRequest.h.

SetResourcePolicy()

template<typename ResourcePolicyT = Aws::String>

void Aws::DynamoDB::Model::CreateTableRequest::SetResourcePolicy ( ResourcePolicyT &&  value)

inline

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Definition at line 444 of file CreateTableRequest.h.

SetSSESpecification()

template<typename SSESpecificationT = SSESpecification>

void Aws::DynamoDB::Model::CreateTableRequest::SetSSESpecification ( SSESpecificationT &&  value)

inline

Represents the settings used to enable server-side encryption.

Definition at line 337 of file CreateTableRequest.h.

SetStreamSpecification()

template<typename StreamSpecificationT = StreamSpecification>

void Aws::DynamoDB::Model::CreateTableRequest::SetStreamSpecification ( StreamSpecificationT &&  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 319 of file CreateTableRequest.h.

SetTableClass()

void Aws::DynamoDB::Model::CreateTableRequest::SetTableClass ( TableClass  value)

inline

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Definition at line 381 of file CreateTableRequest.h.

SetTableName()

template<typename TableNameT = Aws::String>

void Aws::DynamoDB::Model::CreateTableRequest::SetTableName ( TableNameT &&  value)

inline

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Definition at line 89 of file CreateTableRequest.h.

SetTags()

template<typename TagsT = Aws::Vector<Tag>>

void Aws::DynamoDB::Model::CreateTableRequest::SetTags ( TagsT &&  value)

inline

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

Definition at line 357 of file CreateTableRequest.h.

SetWarmThroughput()

template<typename WarmThroughputT = WarmThroughput>

void Aws::DynamoDB::Model::CreateTableRequest::SetWarmThroughput ( WarmThroughputT &&  value)

inline

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Definition at line 416 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 335 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 317 of file CreateTableRequest.h.

TableClassHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::TableClassHasBeenSet ( ) const

inline

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Definition at line 380 of file CreateTableRequest.h.

TableNameHasBeenSet()

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

inline

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Definition at line 87 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 355 of file CreateTableRequest.h.

WarmThroughputHasBeenSet()

bool Aws::DynamoDB::Model::CreateTableRequest::WarmThroughputHasBeenSet ( ) const

inline

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Definition at line 414 of file CreateTableRequest.h.

WithAttributeDefinitions()

template<typename AttributeDefinitionsT = Aws::Vector<AttributeDefinition>>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithAttributeDefinitions ( AttributeDefinitionsT &&  value)

inline

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

Definition at line 69 of file CreateTableRequest.h.

WithBillingMode()

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.

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

• PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

Definition at line 269 of file CreateTableRequest.h.

WithDeletionProtectionEnabled()

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithDeletionProtectionEnabled ( bool  value)

inline

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Definition at line 402 of file CreateTableRequest.h.

WithGlobalSecondaryIndexes()

template<typename GlobalSecondaryIndexesT = Aws::Vector<GlobalSecondaryIndex>>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithGlobalSecondaryIndexes ( GlobalSecondaryIndexesT &&  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. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.

• 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

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

Definition at line 236 of file CreateTableRequest.h.

WithGlobalTableSettingsReplicationMode()

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithGlobalTableSettingsReplicationMode ( GlobalTableSettingsReplicationMode  value)

inline

Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED_WITH_OVERRIDES.

Definition at line 508 of file CreateTableRequest.h.

WithGlobalTableSourceArn()

template<typename GlobalTableSourceArnT = Aws::String>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithGlobalTableSourceArn ( GlobalTableSourceArnT &&  value)

inline

The Amazon Resource Name (ARN) of the source table used for the creation of a multi-account global table.

Definition at line 489 of file CreateTableRequest.h.

WithKeySchema()

template<typename KeySchemaT = Aws::Vector<KeySchemaElement>>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithKeySchema ( KeySchemaT &&  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 135 of file CreateTableRequest.h.

WithLocalSecondaryIndexes()

template<typename LocalSecondaryIndexesT = Aws::Vector<LocalSecondaryIndex>>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithLocalSecondaryIndexes ( LocalSecondaryIndexesT &&  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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

Definition at line 185 of file CreateTableRequest.h.

WithOnDemandThroughput()

template<typename OnDemandThroughputT = OnDemandThroughput>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithOnDemandThroughput ( OnDemandThroughputT &&  value)

inline

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Definition at line 470 of file CreateTableRequest.h.

WithProvisionedThroughput()

template<typename ProvisionedThroughputT = ProvisionedThroughput>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithProvisionedThroughput ( ProvisionedThroughputT &&  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 294 of file CreateTableRequest.h.

WithResourcePolicy()

template<typename ResourcePolicyT = Aws::String>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithResourcePolicy ( ResourcePolicyT &&  value)

inline

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Definition at line 449 of file CreateTableRequest.h.

WithSSESpecification()

template<typename SSESpecificationT = SSESpecification>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithSSESpecification ( SSESpecificationT &&  value)

inline

Represents the settings used to enable server-side encryption.

Definition at line 342 of file CreateTableRequest.h.

WithStreamSpecification()

template<typename StreamSpecificationT = StreamSpecification>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithStreamSpecification ( StreamSpecificationT &&  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 324 of file CreateTableRequest.h.

WithTableClass()

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithTableClass ( TableClass  value)

inline

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

Definition at line 385 of file CreateTableRequest.h.

WithTableName()

template<typename TableNameT = Aws::String>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithTableName ( TableNameT &&  value)

inline

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Definition at line 94 of file CreateTableRequest.h.

WithTags()

template<typename TagsT = Aws::Vector<Tag>>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithTags ( TagsT &&  value)

inline

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

Definition at line 362 of file CreateTableRequest.h.

WithWarmThroughput()

template<typename WarmThroughputT = WarmThroughput>

CreateTableRequest & Aws::DynamoDB::Model::CreateTableRequest::WithWarmThroughput ( WarmThroughputT &&  value)

inline

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Definition at line 421 of file CreateTableRequest.h.

---

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

• generated/src/aws-cpp-sdk-dynamodb/include/aws/dynamodb/model/CreateTableRequest.h