software.amazon.awscdk.services.dynamodb

Class CfnGlobalTable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dynamodb.CfnGlobalTable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.841Z")
 @Stability(value=Stable)
public class CfnGlobalTable
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnGlobalTable cfnGlobalTable = CfnGlobalTable.Builder.create(this, "MyCfnGlobalTable")
         .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	Class and Description
static interface	CfnGlobalTable.AttributeDefinitionProperty Example:
static class	CfnGlobalTable.Builder A fluent builder for CfnGlobalTable.
static interface	CfnGlobalTable.CapacityAutoScalingSettingsProperty Example:
static interface	CfnGlobalTable.ContributorInsightsSpecificationProperty Example:
static interface	CfnGlobalTable.GlobalSecondaryIndexProperty Example:
static interface	CfnGlobalTable.KeySchemaProperty Example:
static interface	CfnGlobalTable.LocalSecondaryIndexProperty Example:
static interface	CfnGlobalTable.PointInTimeRecoverySpecificationProperty Example:
static interface	CfnGlobalTable.ProjectionProperty Example:
static interface	CfnGlobalTable.ReadProvisionedThroughputSettingsProperty Example:
static interface	CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty Example:
static interface	CfnGlobalTable.ReplicaSpecificationProperty Example:
static interface	CfnGlobalTable.ReplicaSSESpecificationProperty Example:
static interface	CfnGlobalTable.SSESpecificationProperty Example:
static interface	CfnGlobalTable.StreamSpecificationProperty Example:
static interface	CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty Example:
static interface	CfnGlobalTable.TimeToLiveSpecificationProperty Example:
static interface	CfnGlobalTable.WriteProvisionedThroughputSettingsProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGlobalTable(software.constructs.Construct scope, String id, CfnGlobalTableProps props) Create a new `AWS::DynamoDB::GlobalTable`.
protected	CfnGlobalTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGlobalTable(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
Object	getAttributeDefinitions() `AWS::DynamoDB::GlobalTable.AttributeDefinitions`.
String	getAttrStreamArn()
String	getAttrTableId()
String	getBillingMode() `AWS::DynamoDB::GlobalTable.BillingMode`.
protected Map<String,Object>	getCfnProperties()
Object	getGlobalSecondaryIndexes() `AWS::DynamoDB::GlobalTable.GlobalSecondaryIndexes`.
Object	getKeySchema() `AWS::DynamoDB::GlobalTable.KeySchema`.
Object	getLocalSecondaryIndexes() `AWS::DynamoDB::GlobalTable.LocalSecondaryIndexes`.
Object	getReplicas() `AWS::DynamoDB::GlobalTable.Replicas`.
Object	getSseSpecification() `AWS::DynamoDB::GlobalTable.SSESpecification`.
Object	getStreamSpecification() `AWS::DynamoDB::GlobalTable.StreamSpecification`.
String	getTableName() `AWS::DynamoDB::GlobalTable.TableName`.
Object	getTimeToLiveSpecification() `AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`.
Object	getWriteProvisionedThroughputSettings() `AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributeDefinitions(IResolvable value) `AWS::DynamoDB::GlobalTable.AttributeDefinitions`.
void	setAttributeDefinitions(List<Object> value) `AWS::DynamoDB::GlobalTable.AttributeDefinitions`.
void	setBillingMode(String value) `AWS::DynamoDB::GlobalTable.BillingMode`.
void	setGlobalSecondaryIndexes(IResolvable value) `AWS::DynamoDB::GlobalTable.GlobalSecondaryIndexes`.
void	setGlobalSecondaryIndexes(List<Object> value) `AWS::DynamoDB::GlobalTable.GlobalSecondaryIndexes`.
void	setKeySchema(IResolvable value) `AWS::DynamoDB::GlobalTable.KeySchema`.
void	setKeySchema(List<Object> value) `AWS::DynamoDB::GlobalTable.KeySchema`.
void	setLocalSecondaryIndexes(IResolvable value) `AWS::DynamoDB::GlobalTable.LocalSecondaryIndexes`.
void	setLocalSecondaryIndexes(List<Object> value) `AWS::DynamoDB::GlobalTable.LocalSecondaryIndexes`.
void	setReplicas(IResolvable value) `AWS::DynamoDB::GlobalTable.Replicas`.
void	setReplicas(List<Object> value) `AWS::DynamoDB::GlobalTable.Replicas`.
void	setSseSpecification(CfnGlobalTable.SSESpecificationProperty value) `AWS::DynamoDB::GlobalTable.SSESpecification`.
void	setSseSpecification(IResolvable value) `AWS::DynamoDB::GlobalTable.SSESpecification`.
void	setStreamSpecification(CfnGlobalTable.StreamSpecificationProperty value) `AWS::DynamoDB::GlobalTable.StreamSpecification`.
void	setStreamSpecification(IResolvable value) `AWS::DynamoDB::GlobalTable.StreamSpecification`.
void	setTableName(String value) `AWS::DynamoDB::GlobalTable.TableName`.
void	setTimeToLiveSpecification(CfnGlobalTable.TimeToLiveSpecificationProperty value) `AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`.
void	setTimeToLiveSpecification(IResolvable value) `AWS::DynamoDB::GlobalTable.TimeToLiveSpecification`.
void	setWriteProvisionedThroughputSettings(CfnGlobalTable.WriteProvisionedThroughputSettingsProperty value) `AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`.
void	setWriteProvisionedThroughputSettings(IResolvable value) `AWS::DynamoDB::GlobalTable.WriteProvisionedThroughputSettings`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGlobalTable

protected CfnGlobalTable(software.amazon.jsii.JsiiObjectRef objRef)

CfnGlobalTable

protected CfnGlobalTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGlobalTable

@Stability(value=Stable)
public CfnGlobalTable(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnGlobalTableProps props)

Create a new `AWS::DynamoDB::GlobalTable`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttributeDefinitions

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

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

setAttributeDefinitions

@Stability(value=Stable)
public void setAttributeDefinitions(@NotNull
                                                             IResolvable value)

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

setAttributeDefinitions

@Stability(value=Stable)
public void setAttributeDefinitions(@NotNull
                                                             List<Object> value)

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

getAttrStreamArn

@Stability(value=Stable)
 @NotNull
public String getAttrStreamArn()

getAttrTableId

@Stability(value=Stable)
 @NotNull
public String getAttrTableId()

getBillingMode

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

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

setBillingMode

@Stability(value=Stable)
public void setBillingMode(@Nullable
                                                    String value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getGlobalSecondaryIndexes

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

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

setGlobalSecondaryIndexes

@Stability(value=Stable)
public void setGlobalSecondaryIndexes(@Nullable
                                                               IResolvable value)

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

setGlobalSecondaryIndexes

@Stability(value=Stable)
public void setGlobalSecondaryIndexes(@Nullable
                                                               List<Object> value)

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

getKeySchema

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

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

setKeySchema

@Stability(value=Stable)
public void setKeySchema(@NotNull
                                                  IResolvable value)

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

setKeySchema

@Stability(value=Stable)
public void setKeySchema(@NotNull
                                                  List<Object> value)

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

getLocalSecondaryIndexes

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

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

setLocalSecondaryIndexes

@Stability(value=Stable)
public void setLocalSecondaryIndexes(@Nullable
                                                              IResolvable value)

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

setLocalSecondaryIndexes

@Stability(value=Stable)
public void setLocalSecondaryIndexes(@Nullable
                                                              List<Object> value)

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

getReplicas

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

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

setReplicas

@Stability(value=Stable)
public void setReplicas(@NotNull
                                                 IResolvable value)

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

setReplicas

@Stability(value=Stable)
public void setReplicas(@NotNull
                                                 List<Object> value)

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

getSseSpecification

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

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

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         CfnGlobalTable.SSESpecificationProperty value)

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

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         IResolvable value)

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

getStreamSpecification

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

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

setStreamSpecification

@Stability(value=Stable)
public void setStreamSpecification(@Nullable
                                                            CfnGlobalTable.StreamSpecificationProperty value)

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

setStreamSpecification

@Stability(value=Stable)
public void setStreamSpecification(@Nullable
                                                            IResolvable value)

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

getTableName

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

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

setTableName

@Stability(value=Stable)
public void setTableName(@Nullable
                                                  String value)

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

getTimeToLiveSpecification

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

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

setTimeToLiveSpecification

@Stability(value=Stable)
public void setTimeToLiveSpecification(@Nullable
                                                                CfnGlobalTable.TimeToLiveSpecificationProperty value)

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

setTimeToLiveSpecification

@Stability(value=Stable)
public void setTimeToLiveSpecification(@Nullable
                                                                IResolvable value)

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

getWriteProvisionedThroughputSettings

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

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

setWriteProvisionedThroughputSettings

@Stability(value=Stable)
public void setWriteProvisionedThroughputSettings(@Nullable
                                                                           CfnGlobalTable.WriteProvisionedThroughputSettingsProperty value)

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

setWriteProvisionedThroughputSettings

@Stability(value=Stable)
public void setWriteProvisionedThroughputSettings(@Nullable
                                                                           IResolvable value)

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