Package software.amazon.awscdk.services.cassandra

Class CfnTable

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.cassandra.CfnTable

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:54.253Z")
@Stability(Stable)
public class CfnTable
extends CfnResource
implements IInspectable, ITaggable

You can use the AWS::Cassandra::Table resource to create a new table in Amazon Keyspaces (for Apache Cassandra).

For more information, see Create a keyspace and a table in the Amazon Keyspaces Developer Guide .

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.cassandra.*;
 CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable")
         .keyspaceName("keyspaceName")
         .partitionKeyColumns(List.of(ColumnProperty.builder()
                 .columnName("columnName")
                 .columnType("columnType")
                 .build()))
         // the properties below are optional
         .autoScalingSpecifications(AutoScalingSpecificationProperty.builder()
                 .readCapacityAutoScaling(AutoScalingSettingProperty.builder()
                         .autoScalingDisabled(false)
                         .maximumUnits(123)
                         .minimumUnits(123)
                         .scalingPolicy(ScalingPolicyProperty.builder()
                                 .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                         .targetValue(123)
                                         // the properties below are optional
                                         .disableScaleIn(false)
                                         .scaleInCooldown(123)
                                         .scaleOutCooldown(123)
                                         .build())
                                 .build())
                         .build())
                 .writeCapacityAutoScaling(AutoScalingSettingProperty.builder()
                         .autoScalingDisabled(false)
                         .maximumUnits(123)
                         .minimumUnits(123)
                         .scalingPolicy(ScalingPolicyProperty.builder()
                                 .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                         .targetValue(123)
                                         // the properties below are optional
                                         .disableScaleIn(false)
                                         .scaleInCooldown(123)
                                         .scaleOutCooldown(123)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .billingMode(BillingModeProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .provisionedThroughput(ProvisionedThroughputProperty.builder()
                         .readCapacityUnits(123)
                         .writeCapacityUnits(123)
                         .build())
                 .build())
         .clientSideTimestampsEnabled(false)
         .clusteringKeyColumns(List.of(ClusteringKeyColumnProperty.builder()
                 .column(ColumnProperty.builder()
                         .columnName("columnName")
                         .columnType("columnType")
                         .build())
                 // the properties below are optional
                 .orderBy("orderBy")
                 .build()))
         .defaultTimeToLive(123)
         .encryptionSpecification(EncryptionSpecificationProperty.builder()
                 .encryptionType("encryptionType")
                 // the properties below are optional
                 .kmsKeyIdentifier("kmsKeyIdentifier")
                 .build())
         .pointInTimeRecoveryEnabled(false)
         .regularColumns(List.of(ColumnProperty.builder()
                 .columnName("columnName")
                 .columnType("columnType")
                 .build()))
         .replicaSpecifications(List.of(ReplicaSpecificationProperty.builder()
                 .region("region")
                 // the properties below are optional
                 .readCapacityAutoScaling(AutoScalingSettingProperty.builder()
                         .autoScalingDisabled(false)
                         .maximumUnits(123)
                         .minimumUnits(123)
                         .scalingPolicy(ScalingPolicyProperty.builder()
                                 .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                         .targetValue(123)
                                         // the properties below are optional
                                         .disableScaleIn(false)
                                         .scaleInCooldown(123)
                                         .scaleOutCooldown(123)
                                         .build())
                                 .build())
                         .build())
                 .readCapacityUnits(123)
                 .build()))
         .tableName("tableName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-table.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTable.AutoScalingSettingProperty	The optional auto scaling settings for a table with provisioned throughput capacity.
static interface	CfnTable.AutoScalingSpecificationProperty	The optional auto scaling capacity settings for a table in provisioned capacity mode.
static interface	CfnTable.BillingModeProperty	Determines the billing mode for the table - on-demand or provisioned.
static final class	CfnTable.Builder	A fluent builder for CfnTable.
static interface	CfnTable.ClusteringKeyColumnProperty	Defines an individual column within the clustering key.
static interface	CfnTable.ColumnProperty	The name and data type of an individual column in a table.
static interface	CfnTable.EncryptionSpecificationProperty	Specifies the encryption at rest option selected for the table.
static interface	CfnTable.ProvisionedThroughputProperty	The provisioned throughput for the table, which consists of ReadCapacityUnits and WriteCapacityUnits .
static interface	CfnTable.ReplicaSpecificationProperty	The AWS Region specific settings of a multi-Region table.
static interface	CfnTable.ScalingPolicyProperty	Amazon Keyspaces supports the target tracking auto scaling policy.
static interface	CfnTable.TargetTrackingScalingPolicyConfigurationProperty	Amazon Keyspaces supports the target tracking auto scaling policy for a provisioned table.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTable(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTable(software.constructs.Construct scope, String id, CfnTableProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAutoScalingSpecifications()	The optional auto scaling capacity settings for a table in provisioned capacity mode.
Object	getBillingMode()	The billing mode for the table, which determines how you'll be charged for reads and writes:.
protected Map<String,Object>	getCfnProperties()
Object	getClientSideTimestampsEnabled()	Enables client-side timestamps for the table.
Object	getClusteringKeyColumns()	One or more columns that determine how the table data is sorted.
Number	getDefaultTimeToLive()	The default Time To Live (TTL) value for all rows in a table in seconds.
Object	getEncryptionSpecification()	The encryption at rest options for the table.
String	getKeyspaceName()	The name of the keyspace to create the table in.
Object	getPartitionKeyColumns()	One or more columns that uniquely identify every row in the table.
Object	getPointInTimeRecoveryEnabled()	Specifies if point-in-time recovery is enabled or disabled for the table.
Object	getRegularColumns()	One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
Object	getReplicaSpecifications()	The AWS Region specific settings of a multi-Region table.
String	getTableName()	The name of the table to be created.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoScalingSpecifications(IResolvable value)	The optional auto scaling capacity settings for a table in provisioned capacity mode.
void	setAutoScalingSpecifications(CfnTable.AutoScalingSpecificationProperty value)	The optional auto scaling capacity settings for a table in provisioned capacity mode.
void	setBillingMode(IResolvable value)	The billing mode for the table, which determines how you'll be charged for reads and writes:.
void	setBillingMode(CfnTable.BillingModeProperty value)	The billing mode for the table, which determines how you'll be charged for reads and writes:.
void	setClientSideTimestampsEnabled(Boolean value)	Enables client-side timestamps for the table.
void	setClientSideTimestampsEnabled(IResolvable value)	Enables client-side timestamps for the table.
void	setClusteringKeyColumns(List<Object> value)	One or more columns that determine how the table data is sorted.
void	setClusteringKeyColumns(IResolvable value)	One or more columns that determine how the table data is sorted.
void	setDefaultTimeToLive(Number value)	The default Time To Live (TTL) value for all rows in a table in seconds.
void	setEncryptionSpecification(IResolvable value)	The encryption at rest options for the table.
void	setEncryptionSpecification(CfnTable.EncryptionSpecificationProperty value)	The encryption at rest options for the table.
void	setKeyspaceName(String value)	The name of the keyspace to create the table in.
void	setPartitionKeyColumns(List<Object> value)	One or more columns that uniquely identify every row in the table.
void	setPartitionKeyColumns(IResolvable value)	One or more columns that uniquely identify every row in the table.
void	setPointInTimeRecoveryEnabled(Boolean value)	Specifies if point-in-time recovery is enabled or disabled for the table.
void	setPointInTimeRecoveryEnabled(IResolvable value)	Specifies if point-in-time recovery is enabled or disabled for the table.
void	setRegularColumns(List<Object> value)	One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
void	setRegularColumns(IResolvable value)	One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.
void	setReplicaSpecifications(List<Object> value)	The AWS Region specific settings of a multi-Region table.
void	setReplicaSpecifications(IResolvable value)	The AWS Region specific settings of a multi-Region table.
void	setTableName(String value)	The name of the table to be created.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTable

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

CfnTable

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

CfnTable

@Stability(Stable)
public CfnTable(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTableProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getKeyspaceName

@Stability(Stable)
@NotNull
public String getKeyspaceName()

The name of the keyspace to create the table in.

setKeyspaceName

@Stability(Stable)
public void setKeyspaceName(@NotNull
 String value)

The name of the keyspace to create the table in.

getPartitionKeyColumns

@Stability(Stable)
@NotNull
public Object getPartitionKeyColumns()

One or more columns that uniquely identify every row in the table.

setPartitionKeyColumns

@Stability(Stable)
public void setPartitionKeyColumns(@NotNull
 IResolvable value)

One or more columns that uniquely identify every row in the table.

setPartitionKeyColumns

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

One or more columns that uniquely identify every row in the table.

getAutoScalingSpecifications

@Stability(Stable)
@Nullable
public Object getAutoScalingSpecifications()

The optional auto scaling capacity settings for a table in provisioned capacity mode.

setAutoScalingSpecifications

@Stability(Stable)
public void setAutoScalingSpecifications(@Nullable
 IResolvable value)

The optional auto scaling capacity settings for a table in provisioned capacity mode.

setAutoScalingSpecifications

@Stability(Stable)
public void setAutoScalingSpecifications(@Nullable
 CfnTable.AutoScalingSpecificationProperty value)

The optional auto scaling capacity settings for a table in provisioned capacity mode.

getBillingMode

@Stability(Stable)
@Nullable
public Object getBillingMode()

The billing mode for the table, which determines how you'll be charged for reads and writes:.

setBillingMode

@Stability(Stable)
public void setBillingMode(@Nullable
 IResolvable value)

The billing mode for the table, which determines how you'll be charged for reads and writes:.

setBillingMode

@Stability(Stable)
public void setBillingMode(@Nullable
 CfnTable.BillingModeProperty value)

The billing mode for the table, which determines how you'll be charged for reads and writes:.

getClientSideTimestampsEnabled

@Stability(Stable)
@Nullable
public Object getClientSideTimestampsEnabled()

Enables client-side timestamps for the table.

setClientSideTimestampsEnabled

@Stability(Stable)
public void setClientSideTimestampsEnabled(@Nullable
 Boolean value)

Enables client-side timestamps for the table.

setClientSideTimestampsEnabled

@Stability(Stable)
public void setClientSideTimestampsEnabled(@Nullable
 IResolvable value)

Enables client-side timestamps for the table.

getClusteringKeyColumns

@Stability(Stable)
@Nullable
public Object getClusteringKeyColumns()

One or more columns that determine how the table data is sorted.

setClusteringKeyColumns

@Stability(Stable)
public void setClusteringKeyColumns(@Nullable
 IResolvable value)

One or more columns that determine how the table data is sorted.

setClusteringKeyColumns

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

One or more columns that determine how the table data is sorted.

getDefaultTimeToLive

@Stability(Stable)
@Nullable
public Number getDefaultTimeToLive()

The default Time To Live (TTL) value for all rows in a table in seconds.

setDefaultTimeToLive

@Stability(Stable)
public void setDefaultTimeToLive(@Nullable
 Number value)

The default Time To Live (TTL) value for all rows in a table in seconds.

getEncryptionSpecification

@Stability(Stable)
@Nullable
public Object getEncryptionSpecification()

The encryption at rest options for the table.

setEncryptionSpecification

@Stability(Stable)
public void setEncryptionSpecification(@Nullable
 IResolvable value)

The encryption at rest options for the table.

setEncryptionSpecification

@Stability(Stable)
public void setEncryptionSpecification(@Nullable
 CfnTable.EncryptionSpecificationProperty value)

The encryption at rest options for the table.

getPointInTimeRecoveryEnabled

@Stability(Stable)
@Nullable
public Object getPointInTimeRecoveryEnabled()

Specifies if point-in-time recovery is enabled or disabled for the table.

setPointInTimeRecoveryEnabled

@Stability(Stable)
public void setPointInTimeRecoveryEnabled(@Nullable
 Boolean value)

Specifies if point-in-time recovery is enabled or disabled for the table.

setPointInTimeRecoveryEnabled

@Stability(Stable)
public void setPointInTimeRecoveryEnabled(@Nullable
 IResolvable value)

Specifies if point-in-time recovery is enabled or disabled for the table.

getRegularColumns

@Stability(Stable)
@Nullable
public Object getRegularColumns()

One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.

setRegularColumns

@Stability(Stable)
public void setRegularColumns(@Nullable
 IResolvable value)

One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.

setRegularColumns

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

One or more columns that are not part of the primary key - that is, columns that are not defined as partition key columns or clustering key columns.

getReplicaSpecifications

@Stability(Stable)
@Nullable
public Object getReplicaSpecifications()

The AWS Region specific settings of a multi-Region table.

setReplicaSpecifications

@Stability(Stable)
public void setReplicaSpecifications(@Nullable
 IResolvable value)

The AWS Region specific settings of a multi-Region table.

setReplicaSpecifications

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

The AWS Region specific settings of a multi-Region table.

getTableName

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

The name of the table to be created.

setTableName

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

The name of the table to be created.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

An array of key-value pairs to apply to this resource.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.