Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.ReadProvisionedThroughputSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTable

@Stability(Stable)
public static interface CfnGlobalTable.ReadProvisionedThroughputSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the BillingMode is set to PROVISIONED .

You must specify a value for either ReadCapacityUnits or ReadCapacityAutoScalingSettings , but not both. You can switch between fixed capacity and auto scaling.

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.*;
 ReadProvisionedThroughputSettingsProperty readProvisionedThroughputSettingsProperty = ReadProvisionedThroughputSettingsProperty.builder()
         .readCapacityAutoScalingSettings(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())
         .readCapacityUnits(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Builder	A builder for CfnGlobalTable.ReadProvisionedThroughputSettingsProperty
static final class	CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Jsii$Proxy	An implementation for CfnGlobalTable.ReadProvisionedThroughputSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Builder	builder()
default Object	getReadCapacityAutoScalingSettings()	Specifies auto scaling settings for the replica table or global secondary index.
default Number	getReadCapacityUnits()	Specifies a fixed read capacity for the replica table or global secondary index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getReadCapacityAutoScalingSettings

@Stability(Stable)
@Nullable
default Object getReadCapacityAutoScalingSettings()

Specifies auto scaling settings for the replica table or global secondary index.

Returns union: either IResolvable or CfnGlobalTable.CapacityAutoScalingSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings

getReadCapacityUnits

@Stability(Stable)
@Nullable
default Number getReadCapacityUnits()

Specifies a fixed read capacity for the replica table or global secondary index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits

builder

@Stability(Stable)
static CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Builder builder()

Returns:

a CfnGlobalTable.ReadProvisionedThroughputSettingsProperty.Builder of CfnGlobalTable.ReadProvisionedThroughputSettingsProperty