software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.845Z")
 @Stability(value=Stable)
public interface CfnGlobalTableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::DynamoDB::GlobalTable`.

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.*;
 CfnGlobalTableProps cfnGlobalTableProps = CfnGlobalTableProps.builder()
         .attributeDefinitions(List.of(AttributeDefinitionProperty.builder()
                 .attributeName("attributeName")
                 .attributeType("attributeType")
                 .build()))
         .keySchema(List.of(KeySchemaProperty.builder()
                 .attributeName("attributeName")
                 .keyType("keyType")
                 .build()))
         .replicas(List.of(ReplicaSpecificationProperty.builder()
                 .region("region")
                 // the properties below are optional
                 .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                         .enabled(false)
                         .build())
                 .globalSecondaryIndexes(List.of(ReplicaGlobalSecondaryIndexSpecificationProperty.builder()
                         .indexName("indexName")
                         // the properties below are optional
                         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                                 .enabled(false)
                                 .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()))
                 .pointInTimeRecoverySpecification(PointInTimeRecoverySpecificationProperty.builder()
                         .pointInTimeRecoveryEnabled(false)
                         .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())
                 .sseSpecification(ReplicaSSESpecificationProperty.builder()
                         .kmsMasterKeyId("kmsMasterKeyId")
                         .build())
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         // the properties below are optional
         .billingMode("billingMode")
         .globalSecondaryIndexes(List.of(GlobalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 // the properties below are optional
                 .writeProvisionedThroughputSettings(WriteProvisionedThroughputSettingsProperty.builder()
                         .writeCapacityAutoScalingSettings(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())
                         .build())
                 .build()))
         .localSecondaryIndexes(List.of(LocalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 .build()))
         .sseSpecification(SSESpecificationProperty.builder()
                 .sseEnabled(false)
                 // the properties below are optional
                 .sseType("sseType")
                 .build())
         .streamSpecification(StreamSpecificationProperty.builder()
                 .streamViewType("streamViewType")
                 .build())
         .tableName("tableName")
         .timeToLiveSpecification(TimeToLiveSpecificationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .attributeName("attributeName")
                 .build())
         .writeProvisionedThroughputSettings(WriteProvisionedThroughputSettingsProperty.builder()
                 .writeCapacityAutoScalingSettings(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())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGlobalTableProps.Builder	builder()
Object	getAttributeDefinitions() `AWS::DynamoDB::GlobalTable.AttributeDefinitions`.
default String	getBillingMode() `AWS::DynamoDB::GlobalTable.BillingMode`.
default Object	getGlobalSecondaryIndexes() `AWS::DynamoDB::GlobalTable.GlobalSecondaryIndexes`.
Object	getKeySchema() `AWS::DynamoDB::GlobalTable.KeySchema`.
default Object	getLocalSecondaryIndexes() `AWS::DynamoDB::GlobalTable.LocalSecondaryIndexes`.
Object	getReplicas() `AWS::DynamoDB::GlobalTable.Replicas`.
default Object	getSseSpecification() `AWS::DynamoDB::GlobalTable.SSESpecification`.
default Object	getStreamSpecification() `AWS::DynamoDB::GlobalTable.StreamSpecification`.
default String	getTableName() `AWS::DynamoDB::GlobalTable.TableName`.
default Object	getTimeToLiveSpecification() `AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`.
default Object	getWriteProvisionedThroughputSettings() `AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttributeDefinitions

@Stability(value=Stable)
 @NotNull
Object getAttributeDefinitions()

`AWS::DynamoDB::GlobalTable.AttributeDefinitions`.

getBillingMode

@Stability(value=Stable)
 @Nullable
default String getBillingMode()

`AWS::DynamoDB::GlobalTable.BillingMode`.

getGlobalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
default Object getGlobalSecondaryIndexes()

`AWS::DynamoDB::GlobalTable.GlobalSecondaryIndexes`.

getKeySchema

@Stability(value=Stable)
 @NotNull
Object getKeySchema()

`AWS::DynamoDB::GlobalTable.KeySchema`.

getLocalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
default Object getLocalSecondaryIndexes()

`AWS::DynamoDB::GlobalTable.LocalSecondaryIndexes`.

getReplicas

@Stability(value=Stable)
 @NotNull
Object getReplicas()

`AWS::DynamoDB::GlobalTable.Replicas`.

getSseSpecification

@Stability(value=Stable)
 @Nullable
default Object getSseSpecification()

`AWS::DynamoDB::GlobalTable.SSESpecification`.

getStreamSpecification

@Stability(value=Stable)
 @Nullable
default Object getStreamSpecification()

`AWS::DynamoDB::GlobalTable.StreamSpecification`.

getTableName

@Stability(value=Stable)
 @Nullable
default String getTableName()

`AWS::DynamoDB::GlobalTable.TableName`.

getTimeToLiveSpecification

@Stability(value=Stable)
 @Nullable
default Object getTimeToLiveSpecification()

`AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`.

getWriteProvisionedThroughputSettings

@Stability(value=Stable)
 @Nullable
default Object getWriteProvisionedThroughputSettings()

`AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`.

builder

@Stability(value=Stable)
static CfnGlobalTableProps.Builder builder()

Returns:

a CfnGlobalTableProps.Builder of CfnGlobalTableProps