AWSDynamoDBCreateTableInput

Objective-C

@interface AWSDynamoDBCreateTableInput

Swift

class AWSDynamoDBCreateTableInput

Represents the input of a CreateTable operation.

Required parameters: [AttributeDefinitions, TableName, KeySchema]

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

    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. This setting can be changed later.

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

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

    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 }

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

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

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

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

      • ProjectionType - One of the following:

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

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

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

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

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBGlobalSecondaryIndex *> *_Nullable globalSecondaryIndexes;

    Swift

    var globalSecondaryIndexes: [AWSDynamoDBGlobalSecondaryIndex]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBKeySchemaElement *> *_Nullable keySchema;

    Swift

    var keySchema: [AWSDynamoDBKeySchemaElement]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBLocalSecondaryIndex *> *_Nullable localSecondaryIndexes;

    Swift

    var localSecondaryIndexes: [AWSDynamoDBLocalSecondaryIndex]? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var provisionedThroughput: AWSDynamoDBProvisionedThroughput? { get set }

  • 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 creation 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. You can’t request an increase for this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

    Declaration

    Objective-C

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

    Swift

    var resourcePolicy: String? { get set }

  • Represents the settings used to enable server-side encryption.

    Declaration

    Objective-C

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

    Swift

    var sseSpecification: AWSDynamoDBSSESpecification? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var streamSpecification: AWSDynamoDBStreamSpecification? { get set }

  • The table class of the new table. 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 create. 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 }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSDynamoDBTag *> *_Nullable tags;

    Swift

    var tags: [AWSDynamoDBTag]? { get set }