AWSDynamoDBUpdateTableInput

Objective-C

@interface AWSDynamoDBUpdateTableInput

Swift

class AWSDynamoDBUpdateTableInput

Represents the input of an UpdateTable operation.

Required parameters: [TableName]

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBAttributeDefinition *> *_Nullable attributeDefinitions;

    Swift

    var attributeDefinitions: [AWSDynamoDBAttributeDefinition]? { get set }

  • 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 capacity mode.

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

    Declaration

    Objective-C

    @property (nonatomic) AWSDynamoDBBillingMode billingMode;

    Swift

    var billingMode: AWSDynamoDBBillingMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable deletionProtectionEnabled;

    Swift

    var deletionProtectionEnabled: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBGlobalSecondaryIndexUpdate *> *_Nullable globalSecondaryIndexUpdates;

    Swift

    var globalSecondaryIndexUpdates: [AWSDynamoDBGlobalSecondaryIndexUpdate]? { get set }

  • Updates 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBOnDemandThroughput *_Nullable onDemandThroughput;

    Swift

    var onDemandThroughput: AWSDynamoDBOnDemandThroughput? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBProvisionedThroughput *_Nullable provisionedThroughput;

    Swift

    var provisionedThroughput: AWSDynamoDBProvisionedThroughput? { get set }

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

    For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBReplicationGroupUpdate *> *_Nullable replicaUpdates;

    Swift

    var replicaUpdates: [AWSDynamoDBReplicationGroupUpdate]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBSSESpecification *_Nullable SSESpecification;

    Swift

    var sseSpecification: AWSDynamoDBSSESpecification? { get set }

  • Represents the DynamoDB Streams configuration for the table.

    You receive a ValidationException 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSDynamoDBStreamSpecification *_Nullable streamSpecification;

    Swift

    var streamSpecification: AWSDynamoDBStreamSpecification? { get set }

  • The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

    Declaration

    Objective-C

    @property (nonatomic) AWSDynamoDBTableClass tableClass;

    Swift

    var tableClass: AWSDynamoDBTableClass { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable tableName;

    Swift

    var tableName: String? { get set }