Package software.amazon.awscdk.services.dynamodb

Interface CfnTableProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTableProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.261Z") @Stability(Stable) public interface CfnTableProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnTable.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 CfnTableProps cfnTableProps = CfnTableProps.builder()
         .keySchema(List.of(KeySchemaProperty.builder()
                 .attributeName("attributeName")
                 .keyType("keyType")
                 .build()))
         // the properties below are optional
         .attributeDefinitions(List.of(AttributeDefinitionProperty.builder()
                 .attributeName("attributeName")
                 .attributeType("attributeType")
                 .build()))
         .billingMode("billingMode")
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 .build())
         .deletionProtectionEnabled(false)
         .globalSecondaryIndexes(List.of(GlobalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 // the properties below are optional
                 .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                         .enabled(false)
                         .build())
                 .provisionedThroughput(ProvisionedThroughputProperty.builder()
                         .readCapacityUnits(123)
                         .writeCapacityUnits(123)
                         .build())
                 .build()))
         .importSourceSpecification(ImportSourceSpecificationProperty.builder()
                 .inputFormat("inputFormat")
                 .s3BucketSource(S3BucketSourceProperty.builder()
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .s3BucketOwner("s3BucketOwner")
                         .s3KeyPrefix("s3KeyPrefix")
                         .build())
                 // the properties below are optional
                 .inputCompressionType("inputCompressionType")
                 .inputFormatOptions(InputFormatOptionsProperty.builder()
                         .csv(CsvProperty.builder()
                                 .delimiter("delimiter")
                                 .headerList(List.of("headerList"))
                                 .build())
                         .build())
                 .build())
         .kinesisStreamSpecification(KinesisStreamSpecificationProperty.builder()
                 .streamArn("streamArn")
                 .build())
         .localSecondaryIndexes(List.of(LocalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 .build()))
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecificationProperty.builder()
                 .pointInTimeRecoveryEnabled(false)
                 .build())
         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                 .readCapacityUnits(123)
                 .writeCapacityUnits(123)
                 .build())
         .sseSpecification(SSESpecificationProperty.builder()
                 .sseEnabled(false)
                 // the properties below are optional
                 .kmsMasterKeyId("kmsMasterKeyId")
                 .sseType("sseType")
                 .build())
         .streamSpecification(StreamSpecificationProperty.builder()
                 .streamViewType("streamViewType")
                 .build())
         .tableClass("tableClass")
         .tableName("tableName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeToLiveSpecification(TimeToLiveSpecificationProperty.builder()
                 .attributeName("attributeName")
                 .enabled(false)
                 .build())
         .build();

  • Method Details

    • getKeySchema

      @Stability(Stable) @NotNull Object getKeySchema()
      Specifies the attributes that make up the primary key for the table.

      The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

    • getAttributeDefinitions

      @Stability(Stable) @Nullable default Object getAttributeDefinitions()
      A list of attributes that describe the key schema for the table and indexes.

      This property is required to create a DynamoDB table.

      Update requires: Some interruptions . Replacement if you edit an existing AttributeDefinition.

    • getBillingMode

      @Stability(Stable) @Nullable default String getBillingMode()
      Specify how you are charged for read and write throughput and how you manage capacity.

      Valid values include:

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

      If not specified, the default is PROVISIONED .

    • getContributorInsightsSpecification

      @Stability(Stable) @Nullable default Object getContributorInsightsSpecification()
      The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

    • getDeletionProtectionEnabled

      @Stability(Stable) @Nullable default Object getDeletionProtectionEnabled()
      Determines if a table is protected from deletion.

      When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .

    • getGlobalSecondaryIndexes

      @Stability(Stable) @Nullable default Object getGlobalSecondaryIndexes()
      Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.

      If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE . You can track its status by using the DynamoDB DescribeTable command.

      If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.

      Updates are not supported. The following are exceptions:

      • If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
      • You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

    • getImportSourceSpecification

      @Stability(Stable) @Nullable default Object getImportSourceSpecification()
      Specifies the properties of data being imported from the S3 bucket source to the table.

      If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification , the TableClass property, or the DeletionProtectionEnabled property, the IAM entity creating/updating stack must have UpdateTable permission.

    • getKinesisStreamSpecification

      @Stability(Stable) @Nullable default Object getKinesisStreamSpecification()
      The Kinesis Data Streams configuration for the specified table.

    • getLocalSecondaryIndexes

      @Stability(Stable) @Nullable default Object getLocalSecondaryIndexes()
      Local secondary indexes to be created on the table.

      You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

    • getPointInTimeRecoverySpecification

      @Stability(Stable) @Nullable default Object getPointInTimeRecoverySpecification()
      The settings used to enable point in time recovery.

    • getProvisionedThroughput

      @Stability(Stable) @Nullable default Object getProvisionedThroughput()
      Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

      For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput .

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

    • getSseSpecification

      @Stability(Stable) @Nullable default Object getSseSpecification()
      Specifies the settings to enable server-side encryption.

    • getStreamSpecification

      @Stability(Stable) @Nullable default Object getStreamSpecification()
      The settings for the DynamoDB table stream, which capture changes to items stored in the table.

    • getTableClass

      @Stability(Stable) @Nullable default String getTableClass()
      The table class of the new table.

      Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

    • getTableName

      @Stability(Stable) @Nullable default String getTableName()
      A name for the table.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see Name Type .

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getTimeToLiveSpecification

      @Stability(Stable) @Nullable default Object getTimeToLiveSpecification()
      Specifies the Time to Live (TTL) settings for the table.

      For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

    • builder

      @Stability(Stable) static CfnTableProps.Builder builder()
      Returns:
      a CfnTableProps.Builder of CfnTableProps