Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTable

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

Represents the properties of a global secondary index that can be set on a per-replica basis.

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.*;
 ReplicaGlobalSecondaryIndexSpecificationProperty replicaGlobalSecondaryIndexSpecificationProperty = ReplicaGlobalSecondaryIndexSpecificationProperty.builder()
         .indexName("indexName")
         // the properties below are optional
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .mode("mode")
                 .build())
         .readOnDemandThroughputSettings(ReadOnDemandThroughputSettingsProperty.builder()
                 .maxReadRequestUnits(123)
                 .build())
         .readProvisionedThroughputSettings(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty.Builder	builder()
default Object	getContributorInsightsSpecification()	Updates the status for contributor insights for a specific table or index.
String	getIndexName()	The name of the global secondary index.
default Object	getReadOnDemandThroughputSettings()	Sets the read request settings for a replica global secondary index.
default Object	getReadProvisionedThroughputSettings()	Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

The name of the global secondary index.

The name must be unique among all other indexes on this table.

See Also:

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

getContributorInsightsSpecification

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

Updates the status for contributor insights for a specific table or index.

CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.

Returns union: either IResolvable or CfnGlobalTable.ContributorInsightsSpecificationProperty

See Also:

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

getReadOnDemandThroughputSettings

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

Sets the read request settings for a replica global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Returns union: either IResolvable or CfnGlobalTable.ReadOnDemandThroughputSettingsProperty

See Also:

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

getReadProvisionedThroughputSettings

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

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

Returns union: either IResolvable or CfnGlobalTable.ReadProvisionedThroughputSettingsProperty

See Also:

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

builder

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

Returns:

a CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty.Builder of CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty