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

#include <UpdateTableRequest.h>

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

Public Member Functions

 UpdateTableRequest ()
 
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)
 
UpdateTableRequestWithAttributeDefinitions (const Aws::Vector< AttributeDefinition > &value)
 
UpdateTableRequestWithAttributeDefinitions (Aws::Vector< AttributeDefinition > &&value)
 
UpdateTableRequestAddAttributeDefinitions (const AttributeDefinition &value)
 
UpdateTableRequestAddAttributeDefinitions (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)
 
UpdateTableRequestWithTableName (const Aws::String &value)
 
UpdateTableRequestWithTableName (Aws::String &&value)
 
UpdateTableRequestWithTableName (const char *value)
 
const BillingModeGetBillingMode () const
 
bool BillingModeHasBeenSet () const
 
void SetBillingMode (const BillingMode &value)
 
void SetBillingMode (BillingMode &&value)
 
UpdateTableRequestWithBillingMode (const BillingMode &value)
 
UpdateTableRequestWithBillingMode (BillingMode &&value)
 
const ProvisionedThroughputGetProvisionedThroughput () const
 
bool ProvisionedThroughputHasBeenSet () const
 
void SetProvisionedThroughput (const ProvisionedThroughput &value)
 
void SetProvisionedThroughput (ProvisionedThroughput &&value)
 
UpdateTableRequestWithProvisionedThroughput (const ProvisionedThroughput &value)
 
UpdateTableRequestWithProvisionedThroughput (ProvisionedThroughput &&value)
 
const Aws::Vector< GlobalSecondaryIndexUpdate > & GetGlobalSecondaryIndexUpdates () const
 
bool GlobalSecondaryIndexUpdatesHasBeenSet () const
 
void SetGlobalSecondaryIndexUpdates (const Aws::Vector< GlobalSecondaryIndexUpdate > &value)
 
void SetGlobalSecondaryIndexUpdates (Aws::Vector< GlobalSecondaryIndexUpdate > &&value)
 
UpdateTableRequestWithGlobalSecondaryIndexUpdates (const Aws::Vector< GlobalSecondaryIndexUpdate > &value)
 
UpdateTableRequestWithGlobalSecondaryIndexUpdates (Aws::Vector< GlobalSecondaryIndexUpdate > &&value)
 
UpdateTableRequestAddGlobalSecondaryIndexUpdates (const GlobalSecondaryIndexUpdate &value)
 
UpdateTableRequestAddGlobalSecondaryIndexUpdates (GlobalSecondaryIndexUpdate &&value)
 
const StreamSpecificationGetStreamSpecification () const
 
bool StreamSpecificationHasBeenSet () const
 
void SetStreamSpecification (const StreamSpecification &value)
 
void SetStreamSpecification (StreamSpecification &&value)
 
UpdateTableRequestWithStreamSpecification (const StreamSpecification &value)
 
UpdateTableRequestWithStreamSpecification (StreamSpecification &&value)
 
const SSESpecificationGetSSESpecification () const
 
bool SSESpecificationHasBeenSet () const
 
void SetSSESpecification (const SSESpecification &value)
 
void SetSSESpecification (SSESpecification &&value)
 
UpdateTableRequestWithSSESpecification (const SSESpecification &value)
 
UpdateTableRequestWithSSESpecification (SSESpecification &&value)
 
const Aws::Vector< ReplicationGroupUpdate > & GetReplicaUpdates () const
 
bool ReplicaUpdatesHasBeenSet () const
 
void SetReplicaUpdates (const Aws::Vector< ReplicationGroupUpdate > &value)
 
void SetReplicaUpdates (Aws::Vector< ReplicationGroupUpdate > &&value)
 
UpdateTableRequestWithReplicaUpdates (const Aws::Vector< ReplicationGroupUpdate > &value)
 
UpdateTableRequestWithReplicaUpdates (Aws::Vector< ReplicationGroupUpdate > &&value)
 
UpdateTableRequestAddReplicaUpdates (const ReplicationGroupUpdate &value)
 
UpdateTableRequestAddReplicaUpdates (ReplicationGroupUpdate &&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 an UpdateTable operation.

See Also:

AWS API Reference

Definition at line 33 of file UpdateTableRequest.h.

Constructor & Destructor Documentation

◆ UpdateTableRequest()

Aws::DynamoDB::Model::UpdateTableRequest::UpdateTableRequest ( )

Member Function Documentation

◆ AddAttributeDefinitions() [1/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 103 of file UpdateTableRequest.h.

◆ AddAttributeDefinitions() [2/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 111 of file UpdateTableRequest.h.

◆ AddGlobalSecondaryIndexUpdates() [1/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::AddGlobalSecondaryIndexUpdates ( const GlobalSecondaryIndexUpdate value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 385 of file UpdateTableRequest.h.

◆ AddGlobalSecondaryIndexUpdates() [2/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::AddGlobalSecondaryIndexUpdates ( GlobalSecondaryIndexUpdate &&  value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 399 of file UpdateTableRequest.h.

◆ AddReplicaUpdates() [1/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::AddReplicaUpdates ( const ReplicationGroupUpdate value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 536 of file UpdateTableRequest.h.

◆ AddReplicaUpdates() [2/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::AddReplicaUpdates ( ReplicationGroupUpdate &&  value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 544 of file UpdateTableRequest.h.

◆ AttributeDefinitionsHasBeenSet()

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 63 of file UpdateTableRequest.h.

◆ BillingModeHasBeenSet()

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 187 of file UpdateTableRequest.h.

◆ GetAttributeDefinitions()

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 55 of file UpdateTableRequest.h.

◆ GetBillingMode()

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 170 of file UpdateTableRequest.h.

◆ GetGlobalSecondaryIndexUpdates()

const Aws::Vector<GlobalSecondaryIndexUpdate>& Aws::DynamoDB::Model::UpdateTableRequest::GetGlobalSecondaryIndexUpdates ( ) const
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 301 of file UpdateTableRequest.h.

◆ GetProvisionedThroughput()

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

The new provisioned throughput settings for the specified table or index.

Definition at line 261 of file UpdateTableRequest.h.

◆ GetReplicaUpdates()

const Aws::Vector<ReplicationGroupUpdate>& Aws::DynamoDB::Model::UpdateTableRequest::GetReplicaUpdates ( ) const
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 488 of file UpdateTableRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file UpdateTableRequest.h.

◆ GetSSESpecification()

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

The new server-side encryption settings for the specified table.

Definition at line 454 of file UpdateTableRequest.h.

◆ GetStreamSpecification()

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 408 of file UpdateTableRequest.h.

◆ GetTableName()

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

The name of the table to be updated.

Definition at line 117 of file UpdateTableRequest.h.

◆ GlobalSecondaryIndexUpdatesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateTableRequest::GlobalSecondaryIndexUpdatesHasBeenSet ( ) const
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 315 of file UpdateTableRequest.h.

◆ ProvisionedThroughputHasBeenSet()

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

The new provisioned throughput settings for the specified table or index.

Definition at line 266 of file UpdateTableRequest.h.

◆ ReplicaUpdatesHasBeenSet()

bool Aws::DynamoDB::Model::UpdateTableRequest::ReplicaUpdatesHasBeenSet ( ) const
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 496 of file UpdateTableRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeDefinitions() [1/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 71 of file UpdateTableRequest.h.

◆ SetAttributeDefinitions() [2/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 79 of file UpdateTableRequest.h.

◆ SetBillingMode() [1/2]

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 204 of file UpdateTableRequest.h.

◆ SetBillingMode() [2/2]

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 221 of file UpdateTableRequest.h.

◆ SetGlobalSecondaryIndexUpdates() [1/2]

void Aws::DynamoDB::Model::UpdateTableRequest::SetGlobalSecondaryIndexUpdates ( const Aws::Vector< GlobalSecondaryIndexUpdate > &  value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 329 of file UpdateTableRequest.h.

◆ SetGlobalSecondaryIndexUpdates() [2/2]

void Aws::DynamoDB::Model::UpdateTableRequest::SetGlobalSecondaryIndexUpdates ( Aws::Vector< GlobalSecondaryIndexUpdate > &&  value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 343 of file UpdateTableRequest.h.

◆ SetProvisionedThroughput() [1/2]

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

The new provisioned throughput settings for the specified table or index.

Definition at line 271 of file UpdateTableRequest.h.

◆ SetProvisionedThroughput() [2/2]

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

The new provisioned throughput settings for the specified table or index.

Definition at line 276 of file UpdateTableRequest.h.

◆ SetReplicaUpdates() [1/2]

void Aws::DynamoDB::Model::UpdateTableRequest::SetReplicaUpdates ( const Aws::Vector< ReplicationGroupUpdate > &  value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 504 of file UpdateTableRequest.h.

◆ SetReplicaUpdates() [2/2]

void Aws::DynamoDB::Model::UpdateTableRequest::SetReplicaUpdates ( Aws::Vector< ReplicationGroupUpdate > &&  value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 512 of file UpdateTableRequest.h.

◆ SetSSESpecification() [1/2]

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

The new server-side encryption settings for the specified table.

Definition at line 464 of file UpdateTableRequest.h.

◆ SetSSESpecification() [2/2]

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

The new server-side encryption settings for the specified table.

Definition at line 469 of file UpdateTableRequest.h.

◆ SetStreamSpecification() [1/2]

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 424 of file UpdateTableRequest.h.

◆ SetStreamSpecification() [2/2]

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 432 of file UpdateTableRequest.h.

◆ SetTableName() [1/3]

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

The name of the table to be updated.

Definition at line 127 of file UpdateTableRequest.h.

◆ SetTableName() [2/3]

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

The name of the table to be updated.

Definition at line 132 of file UpdateTableRequest.h.

◆ SetTableName() [3/3]

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

The name of the table to be updated.

Definition at line 137 of file UpdateTableRequest.h.

◆ SSESpecificationHasBeenSet()

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

The new server-side encryption settings for the specified table.

Definition at line 459 of file UpdateTableRequest.h.

◆ StreamSpecificationHasBeenSet()

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 416 of file UpdateTableRequest.h.

◆ TableNameHasBeenSet()

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

The name of the table to be updated.

Definition at line 122 of file UpdateTableRequest.h.

◆ WithAttributeDefinitions() [1/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 87 of file UpdateTableRequest.h.

◆ WithAttributeDefinitions() [2/2]

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

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Definition at line 95 of file UpdateTableRequest.h.

◆ WithBillingMode() [1/2]

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 238 of file UpdateTableRequest.h.

◆ WithBillingMode() [2/2]

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

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • 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 255 of file UpdateTableRequest.h.

◆ WithGlobalSecondaryIndexUpdates() [1/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::WithGlobalSecondaryIndexUpdates ( const Aws::Vector< GlobalSecondaryIndexUpdate > &  value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 357 of file UpdateTableRequest.h.

◆ WithGlobalSecondaryIndexUpdates() [2/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::WithGlobalSecondaryIndexUpdates ( Aws::Vector< GlobalSecondaryIndexUpdate > &&  value)
inline

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

Definition at line 371 of file UpdateTableRequest.h.

◆ WithProvisionedThroughput() [1/2]

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

The new provisioned throughput settings for the specified table or index.

Definition at line 281 of file UpdateTableRequest.h.

◆ WithProvisionedThroughput() [2/2]

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

The new provisioned throughput settings for the specified table or index.

Definition at line 286 of file UpdateTableRequest.h.

◆ WithReplicaUpdates() [1/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::WithReplicaUpdates ( const Aws::Vector< ReplicationGroupUpdate > &  value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 520 of file UpdateTableRequest.h.

◆ WithReplicaUpdates() [2/2]

UpdateTableRequest& Aws::DynamoDB::Model::UpdateTableRequest::WithReplicaUpdates ( Aws::Vector< ReplicationGroupUpdate > &&  value)
inline

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 of global tables.

Definition at line 528 of file UpdateTableRequest.h.

◆ WithSSESpecification() [1/2]

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

The new server-side encryption settings for the specified table.

Definition at line 474 of file UpdateTableRequest.h.

◆ WithSSESpecification() [2/2]

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

The new server-side encryption settings for the specified table.

Definition at line 479 of file UpdateTableRequest.h.

◆ WithStreamSpecification() [1/2]

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 440 of file UpdateTableRequest.h.

◆ WithStreamSpecification() [2/2]

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

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

Definition at line 448 of file UpdateTableRequest.h.

◆ WithTableName() [1/3]

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

The name of the table to be updated.

Definition at line 142 of file UpdateTableRequest.h.

◆ WithTableName() [2/3]

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

The name of the table to be updated.

Definition at line 147 of file UpdateTableRequest.h.

◆ WithTableName() [3/3]

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

The name of the table to be updated.

Definition at line 152 of file UpdateTableRequest.h.


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