Package software.amazon.awscdk.services.dynamodb

Class CfnTable.Builder

java.lang.Object
software.amazon.awscdk.services.dynamodb.CfnTable.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTable>
Enclosing class:
CfnTable
@Stability(Stable) public static final class CfnTable.Builder extends Object implements software.amazon.jsii.Builder<CfnTable>
A fluent builder for CfnTable.

  • Method Details

    • create

      @Stability(Stable) public static CfnTable.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnTable.Builder.

    • keySchema

      @Stability(Stable) public CfnTable.Builder keySchema(IResolvable keySchema)
      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.

      Parameters:
      keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.
      Returns:
      this

    • keySchema

      @Stability(Stable) public CfnTable.Builder keySchema(List<? extends Object> keySchema)
      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.

      Parameters:
      keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.
      Returns:
      this

    • attributeDefinitions

      @Stability(Stable) public CfnTable.Builder attributeDefinitions(IResolvable attributeDefinitions)
      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.

      Parameters:
      attributeDefinitions - A list of attributes that describe the key schema for the table and indexes. This parameter is required.
      Returns:
      this

    • attributeDefinitions

      @Stability(Stable) public CfnTable.Builder attributeDefinitions(List<? extends Object> attributeDefinitions)
      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.

      Parameters:
      attributeDefinitions - A list of attributes that describe the key schema for the table and indexes. This parameter is required.
      Returns:
      this

    • billingMode

      @Stability(Stable) public CfnTable.Builder billingMode(String billingMode)
      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 .

      Parameters:
      billingMode - Specify how you are charged for read and write throughput and how you manage capacity. This parameter is required.
      Returns:
      this

    • contributorInsightsSpecification

      @Stability(Stable) public CfnTable.Builder contributorInsightsSpecification(IResolvable contributorInsightsSpecification)
      The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

      Parameters:
      contributorInsightsSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. This parameter is required.
      Returns:
      this

    • contributorInsightsSpecification

      @Stability(Stable) public CfnTable.Builder contributorInsightsSpecification(CfnTable.ContributorInsightsSpecificationProperty contributorInsightsSpecification)
      The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

      Parameters:
      contributorInsightsSpecification - The settings used to enable or disable CloudWatch Contributor Insights for the specified table. This parameter is required.
      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnTable.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
      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 .

      Parameters:
      deletionProtectionEnabled - Determines if a table is protected from deletion. This parameter is required.
      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnTable.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)
      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 .

      Parameters:
      deletionProtectionEnabled - Determines if a table is protected from deletion. This parameter is required.
      Returns:
      this

    • globalSecondaryIndexes

      @Stability(Stable) public CfnTable.Builder globalSecondaryIndexes(IResolvable globalSecondaryIndexes)
      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.

      Parameters:
      globalSecondaryIndexes - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. This parameter is required.
      Returns:
      this

    • globalSecondaryIndexes

      @Stability(Stable) public CfnTable.Builder globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)
      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.

      Parameters:
      globalSecondaryIndexes - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. This parameter is required.
      Returns:
      this

    • importSourceSpecification

      @Stability(Stable) public CfnTable.Builder importSourceSpecification(IResolvable importSourceSpecification)
      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.

      Parameters:
      importSourceSpecification - Specifies the properties of data being imported from the S3 bucket source to the table. This parameter is required.
      Returns:
      this

    • importSourceSpecification

      @Stability(Stable) public CfnTable.Builder importSourceSpecification(CfnTable.ImportSourceSpecificationProperty importSourceSpecification)
      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.

      Parameters:
      importSourceSpecification - Specifies the properties of data being imported from the S3 bucket source to the table. This parameter is required.
      Returns:
      this

    • kinesisStreamSpecification

      @Stability(Stable) public CfnTable.Builder kinesisStreamSpecification(IResolvable kinesisStreamSpecification)
      The Kinesis Data Streams configuration for the specified table.

      Parameters:
      kinesisStreamSpecification - The Kinesis Data Streams configuration for the specified table. This parameter is required.
      Returns:
      this

    • kinesisStreamSpecification

      @Stability(Stable) public CfnTable.Builder kinesisStreamSpecification(CfnTable.KinesisStreamSpecificationProperty kinesisStreamSpecification)
      The Kinesis Data Streams configuration for the specified table.

      Parameters:
      kinesisStreamSpecification - The Kinesis Data Streams configuration for the specified table. This parameter is required.
      Returns:
      this

    • localSecondaryIndexes

      @Stability(Stable) public CfnTable.Builder localSecondaryIndexes(IResolvable localSecondaryIndexes)
      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.

      Parameters:
      localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.
      Returns:
      this

    • localSecondaryIndexes

      @Stability(Stable) public CfnTable.Builder localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)
      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.

      Parameters:
      localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.
      Returns:
      this

    • pointInTimeRecoverySpecification

      @Stability(Stable) public CfnTable.Builder pointInTimeRecoverySpecification(IResolvable pointInTimeRecoverySpecification)
      The settings used to enable point in time recovery.

      Parameters:
      pointInTimeRecoverySpecification - The settings used to enable point in time recovery. This parameter is required.
      Returns:
      this

    • pointInTimeRecoverySpecification

      @Stability(Stable) public CfnTable.Builder pointInTimeRecoverySpecification(CfnTable.PointInTimeRecoverySpecificationProperty pointInTimeRecoverySpecification)
      The settings used to enable point in time recovery.

      Parameters:
      pointInTimeRecoverySpecification - The settings used to enable point in time recovery. This parameter is required.
      Returns:
      this

    • provisionedThroughput

      @Stability(Stable) public CfnTable.Builder provisionedThroughput(IResolvable provisionedThroughput)
      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.

      Parameters:
      provisionedThroughput - Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . This parameter is required.
      Returns:
      this

    • provisionedThroughput

      @Stability(Stable) public CfnTable.Builder provisionedThroughput(CfnTable.ProvisionedThroughputProperty provisionedThroughput)
      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.

      Parameters:
      provisionedThroughput - Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . This parameter is required.
      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnTable.Builder sseSpecification(IResolvable sseSpecification)
      Specifies the settings to enable server-side encryption.

      Parameters:
      sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.
      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnTable.Builder sseSpecification(CfnTable.SSESpecificationProperty sseSpecification)
      Specifies the settings to enable server-side encryption.

      Parameters:
      sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.
      Returns:
      this

    • streamSpecification

      @Stability(Stable) public CfnTable.Builder streamSpecification(IResolvable streamSpecification)
      The settings for the DynamoDB table stream, which capture changes to items stored in the table.

      Parameters:
      streamSpecification - The settings for the DynamoDB table stream, which capture changes to items stored in the table. This parameter is required.
      Returns:
      this

    • streamSpecification

      @Stability(Stable) public CfnTable.Builder streamSpecification(CfnTable.StreamSpecificationProperty streamSpecification)
      The settings for the DynamoDB table stream, which capture changes to items stored in the table.

      Parameters:
      streamSpecification - The settings for the DynamoDB table stream, which capture changes to items stored in the table. This parameter is required.
      Returns:
      this

    • tableClass

      @Stability(Stable) public CfnTable.Builder tableClass(String tableClass)
      The table class of the new table.

      Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

      Parameters:
      tableClass - The table class of the new table. This parameter is required.
      Returns:
      this

    • tableName

      @Stability(Stable) public CfnTable.Builder tableName(String tableName)
      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.

      Parameters:
      tableName - A name for the table. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnTable.Builder tags(List<? extends CfnTag> tags)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

      Parameters:
      tags - An array of key-value pairs to apply to this resource. This parameter is required.
      Returns:
      this

    • timeToLiveSpecification

      @Stability(Stable) public CfnTable.Builder timeToLiveSpecification(IResolvable timeToLiveSpecification)
      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.

      Parameters:
      timeToLiveSpecification - Specifies the Time to Live (TTL) settings for the table. This parameter is required.
      Returns:
      this

    • timeToLiveSpecification

      @Stability(Stable) public CfnTable.Builder timeToLiveSpecification(CfnTable.TimeToLiveSpecificationProperty timeToLiveSpecification)
      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.

      Parameters:
      timeToLiveSpecification - Specifies the Time to Live (TTL) settings for the table. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTable build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTable>
      Returns:
      a newly built instance of CfnTable.