Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Class CfnGlobalTableMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • attributeDefinitions

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder attributeDefinitions(IResolvable attributeDefinitions)
      Sets the value of CfnGlobalTableMixinProps.getAttributeDefinitions()
      Parameters:
      attributeDefinitions - A list of attributes that describe the key schema for the global table and indexes.
      Returns:
      this

    • attributeDefinitions

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder attributeDefinitions(List<? extends Object> attributeDefinitions)
      Sets the value of CfnGlobalTableMixinProps.getAttributeDefinitions()
      Parameters:
      attributeDefinitions - A list of attributes that describe the key schema for the global table and indexes.
      Returns:
      this

    • billingMode

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder billingMode(String billingMode)
      Sets the value of CfnGlobalTableMixinProps.getBillingMode()
      Parameters:
      billingMode - Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.
      • PAY_PER_REQUEST
      • PROVISIONED

      All replicas in your global table will have the same billing mode. If you use PROVISIONED billing mode, you must provide an auto scaling configuration via the WriteProvisionedThroughputSettings property. The default value of this property is PROVISIONED .

      Returns:
      this

    • globalSecondaryIndexes

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder globalSecondaryIndexes(IResolvable globalSecondaryIndexes)
      Sets the value of CfnGlobalTableMixinProps.getGlobalSecondaryIndexes()
      Parameters:
      globalSecondaryIndexes - Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.

      Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.

      Returns:
      this

    • globalSecondaryIndexes

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)
      Sets the value of CfnGlobalTableMixinProps.getGlobalSecondaryIndexes()
      Parameters:
      globalSecondaryIndexes - Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.

      Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.

      Returns:
      this

    • globalTableSourceArn

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder globalTableSourceArn(String globalTableSourceArn)
      Sets the value of CfnGlobalTableMixinProps.getGlobalTableSourceArn()
      Parameters:
      globalTableSourceArn - the value to be set.
      Returns:
      this

    • globalTableWitnesses

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder globalTableWitnesses(IResolvable globalTableWitnesses)
      Sets the value of CfnGlobalTableMixinProps.getGlobalTableWitnesses()
      Parameters:
      globalTableWitnesses - The list of witnesses of the MRSC global table. Only one witness Region can be configured per MRSC global table.
      Returns:
      this

    • globalTableWitnesses

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder globalTableWitnesses(List<? extends Object> globalTableWitnesses)
      Sets the value of CfnGlobalTableMixinProps.getGlobalTableWitnesses()
      Parameters:
      globalTableWitnesses - The list of witnesses of the MRSC global table. Only one witness Region can be configured per MRSC global table.
      Returns:
      this

    • keySchema

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder keySchema(IResolvable keySchema)
      Sets the value of CfnGlobalTableMixinProps.getKeySchema()
      Parameters:
      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.
      Returns:
      this

    • keySchema

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder keySchema(List<? extends Object> keySchema)
      Sets the value of CfnGlobalTableMixinProps.getKeySchema()
      Parameters:
      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.
      Returns:
      this

    • localSecondaryIndexes

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder localSecondaryIndexes(IResolvable localSecondaryIndexes)
      Sets the value of CfnGlobalTableMixinProps.getLocalSecondaryIndexes()
      Parameters:
      localSecondaryIndexes - Local secondary indexes to be created on the table. You can create up to five 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. Each replica in your global table will have the same local secondary index settings.
      Returns:
      this

    • localSecondaryIndexes

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)
      Sets the value of CfnGlobalTableMixinProps.getLocalSecondaryIndexes()
      Parameters:
      localSecondaryIndexes - Local secondary indexes to be created on the table. You can create up to five 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. Each replica in your global table will have the same local secondary index settings.
      Returns:
      this

    • multiRegionConsistency

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder multiRegionConsistency(String multiRegionConsistency)
      Sets the value of CfnGlobalTableMixinProps.getMultiRegionConsistency()
      Parameters:
      multiRegionConsistency - Specifies the consistency mode for a new global table. You can specify one of the following consistency modes:

      • EVENTUAL : Configures a new global table for multi-Region eventual consistency (MREC).
      • STRONG : Configures a new global table for multi-Region strong consistency (MRSC).

      If you don't specify this field, the global table consistency mode defaults to EVENTUAL . For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

      Returns:
      this

    • readOnDemandThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder readOnDemandThroughputSettings(IResolvable readOnDemandThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getReadOnDemandThroughputSettings()
      Parameters:
      readOnDemandThroughputSettings - the value to be set.
      Returns:
      this

    • readOnDemandThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder readOnDemandThroughputSettings(CfnGlobalTablePropsMixin.ReadOnDemandThroughputSettingsProperty readOnDemandThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getReadOnDemandThroughputSettings()
      Parameters:
      readOnDemandThroughputSettings - the value to be set.
      Returns:
      this

    • readProvisionedThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder readProvisionedThroughputSettings(IResolvable readProvisionedThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getReadProvisionedThroughputSettings()
      Parameters:
      readProvisionedThroughputSettings - the value to be set.
      Returns:
      this

    • readProvisionedThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder readProvisionedThroughputSettings(CfnGlobalTablePropsMixin.GlobalReadProvisionedThroughputSettingsProperty readProvisionedThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getReadProvisionedThroughputSettings()
      Parameters:
      readProvisionedThroughputSettings - the value to be set.
      Returns:
      this

    • replicas

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder replicas(IResolvable replicas)
      Sets the value of CfnGlobalTableMixinProps.getReplicas()
      Parameters:
      replicas - Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in Replicas with the region us-east-1. You cannot remove the replica in the stack region.

      Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.

      If you add or delete a replica 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 replica, you might need to manually delete the replica.

      You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update. For Multi-Region Strong Consistency (MRSC), you can add or remove up to 3 replicas, or 2 replicas plus a witness Region.

      Returns:
      this

    • replicas

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder replicas(List<? extends Object> replicas)
      Sets the value of CfnGlobalTableMixinProps.getReplicas()
      Parameters:
      replicas - Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in Replicas with the region us-east-1. You cannot remove the replica in the stack region.

      Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.

      If you add or delete a replica 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 replica, you might need to manually delete the replica.

      You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update. For Multi-Region Strong Consistency (MRSC), you can add or remove up to 3 replicas, or 2 replicas plus a witness Region.

      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder sseSpecification(IResolvable sseSpecification)
      Sets the value of CfnGlobalTableMixinProps.getSseSpecification()
      Parameters:
      sseSpecification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the ReplicaSpecification.ReplicaSSESpecification property.
      Returns:
      this

    • sseSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder sseSpecification(CfnGlobalTablePropsMixin.SSESpecificationProperty sseSpecification)
      Sets the value of CfnGlobalTableMixinProps.getSseSpecification()
      Parameters:
      sseSpecification - Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the ReplicaSpecification.ReplicaSSESpecification property.
      Returns:
      this

    • streamSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder streamSpecification(IResolvable streamSpecification)
      Sets the value of CfnGlobalTableMixinProps.getStreamSpecification()
      Parameters:
      streamSpecification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica. For Multi-Region Strong Consistency (MRSC), you do not need to provide a value for this property and can change the settings at any time.
      Returns:
      this

    • streamSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder streamSpecification(CfnGlobalTablePropsMixin.StreamSpecificationProperty streamSpecification)
      Sets the value of CfnGlobalTableMixinProps.getStreamSpecification()
      Parameters:
      streamSpecification - Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica. For Multi-Region Strong Consistency (MRSC), you do not need to provide a value for this property and can change the settings at any time.
      Returns:
      this

    • tableName

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder tableName(String tableName)
      Sets the value of CfnGlobalTableMixinProps.getTableName()
      Parameters:
      tableName - A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as 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.

      Returns:
      this

    • timeToLiveSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder timeToLiveSpecification(IResolvable timeToLiveSpecification)
      Sets the value of CfnGlobalTableMixinProps.getTimeToLiveSpecification()
      Parameters:
      timeToLiveSpecification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
      Returns:
      this

    • timeToLiveSpecification

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder timeToLiveSpecification(CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty timeToLiveSpecification)
      Sets the value of CfnGlobalTableMixinProps.getTimeToLiveSpecification()
      Parameters:
      timeToLiveSpecification - Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.
      Returns:
      this

    • warmThroughput

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder warmThroughput(IResolvable warmThroughput)
      Sets the value of CfnGlobalTableMixinProps.getWarmThroughput()
      Parameters:
      warmThroughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.
      Returns:
      this

    • warmThroughput

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder warmThroughput(CfnGlobalTablePropsMixin.WarmThroughputProperty warmThroughput)
      Sets the value of CfnGlobalTableMixinProps.getWarmThroughput()
      Parameters:
      warmThroughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.
      Returns:
      this

    • writeOnDemandThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder writeOnDemandThroughputSettings(IResolvable writeOnDemandThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getWriteOnDemandThroughputSettings()
      Parameters:
      writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .
      Returns:
      this

    • writeOnDemandThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder writeOnDemandThroughputSettings(CfnGlobalTablePropsMixin.WriteOnDemandThroughputSettingsProperty writeOnDemandThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getWriteOnDemandThroughputSettings()
      Parameters:
      writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .
      Returns:
      this

    • writeProvisionedThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder writeProvisionedThroughputSettings(IResolvable writeProvisionedThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getWriteProvisionedThroughputSettings()
      Parameters:
      writeProvisionedThroughputSettings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .
      Returns:
      this

    • writeProvisionedThroughputSettings

      @Stability(Stable) public CfnGlobalTableMixinProps.Builder writeProvisionedThroughputSettings(CfnGlobalTablePropsMixin.WriteProvisionedThroughputSettingsProperty writeProvisionedThroughputSettings)
      Sets the value of CfnGlobalTableMixinProps.getWriteProvisionedThroughputSettings()
      Parameters:
      writeProvisionedThroughputSettings - Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .
      Returns:
      this

    • build

      @Stability(Stable) public CfnGlobalTableMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGlobalTableMixinProps>
      Returns:
      a new instance of CfnGlobalTableMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided