Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.CapacityAutoScalingSettingsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnGlobalTable.CapacityAutoScalingSettingsProperty.Jsii$Proxy
Enclosing class:
CfnGlobalTable
@Stability(Stable) public static interface CfnGlobalTable.CapacityAutoScalingSettingsProperty extends software.amazon.jsii.JsiiSerializable
Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.

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.*;
 CapacityAutoScalingSettingsProperty capacityAutoScalingSettingsProperty = CapacityAutoScalingSettingsProperty.builder()
         .maxCapacity(123)
         .minCapacity(123)
         .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                 .targetValue(123)
                 // the properties below are optional
                 .disableScaleIn(false)
                 .scaleInCooldown(123)
                 .scaleOutCooldown(123)
                 .build())
         // the properties below are optional
         .seedCapacity(123)
         .build();

  • Method Details

    • getMaxCapacity

      @Stability(Stable) @NotNull Number getMaxCapacity()
      The maximum provisioned capacity units for the global table.

    • getMinCapacity

      @Stability(Stable) @NotNull Number getMinCapacity()
      The minimum provisioned capacity units for the global table.

    • getTargetTrackingScalingPolicyConfiguration

      @Stability(Stable) @NotNull Object getTargetTrackingScalingPolicyConfiguration()
      Defines a target tracking scaling policy.

    • getSeedCapacity

      @Stability(Stable) @Nullable default Number getSeedCapacity()
      When switching billing mode from PAY_PER_REQUEST to PROVISIONED , DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index.

      These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.

      If you want to switch a table's billing mode from PAY_PER_REQUEST to PROVISIONED , you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either the SeedCapacity or ReadCapacityUnits properties. For example, if your global secondary index myGSI has a SeedCapacity of 10 in us-east-1 and a fixed ReadCapacityUnits of 20 in eu-west-1, CloudFormation will initially set the read capacity for myGSI to 20. Note that if you disable ScaleIn for myGSI in us-east-1, its read capacity units might not be set back to 10.

      You must also specify a value for SeedCapacity when you plan to switch a table's billing mode from PROVISIONED to PAY_PER_REQUEST , because CloudFormation might need to roll back the operation (reverting the billing mode to PROVISIONED ) and this cannot succeed without specifying a value for SeedCapacity .

    • builder

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