Interface CfnTableProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTableProps.Jsii$Proxy
CfnTable.
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.*;
CfnTableProps cfnTableProps = CfnTableProps.builder()
.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())
.cdcSpecification(CdcSpecificationProperty.builder()
.status("status")
// the properties below are optional
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.viewType("viewType")
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTablePropsstatic final classAn implementation forCfnTableProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnTableProps.Builderbuilder()default ObjectThe optional auto scaling capacity settings for a table in provisioned capacity mode.default ObjectThe billing mode for the table, which determines how you'll be charged for reads and writes:.default ObjectThe settings for the CDC stream of a table.default ObjectEnables client-side timestamps for the table.default ObjectOne or more columns that determine how the table data is sorted.default NumberThe default Time To Live (TTL) value for all rows in a table in seconds.default ObjectThe encryption at rest options for the table.The name of the keyspace to create the table in.One or more columns that uniquely identify every row in the table.default ObjectSpecifies if point-in-time recovery is enabled or disabled for the table.default ObjectOne 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.default ObjectThe AWS Region specific settings of a multi-Region table.default StringThe name of the table to be created.getTags()An array of key-value pairs to apply to this resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getKeyspaceName
The name of the keyspace to create the table in.The keyspace must already exist.
- See Also:
-
getPartitionKeyColumns
One or more columns that uniquely identify every row in the table.Every table must have a partition key.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTable.ColumnProperty>- See Also:
-
getAutoScalingSpecifications
The optional auto scaling capacity settings for a table in provisioned capacity mode.Returns union: either
IResolvableorCfnTable.AutoScalingSpecificationProperty- See Also:
-
getBillingMode
The billing mode for the table, which determines how you'll be charged for reads and writes:.- On-demand mode (default) - You pay based on the actual reads and writes your application performs.
- Provisioned mode - Lets you specify the number of reads and writes per second that you need for your application.
If you don't specify a value for this property, then the table will use on-demand mode.
Returns union: either
IResolvableorCfnTable.BillingModeProperty- See Also:
-
getCdcSpecification
The settings for the CDC stream of a table.For more information about CDC streams, see Working with change data capture (CDC) streams in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .
Returns union: either
IResolvableorCfnTable.CdcSpecificationProperty- See Also:
-
getClientSideTimestampsEnabled
Enables client-side timestamps for the table.By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: "enabled"
After client-side timestamps are enabled for a table, you can't disable this setting.
Returns union: either
BooleanorIResolvable- See Also:
-
getClusteringKeyColumns
One or more columns that determine how the table data is sorted.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTable.ClusteringKeyColumnProperty>- See Also:
-
getDefaultTimeToLive
The default Time To Live (TTL) value for all rows in a table in seconds.The maximum configurable value is 630,720,000 seconds, which is the equivalent of 20 years. By default, the TTL value for a table is 0, which means data does not expire.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide .
- See Also:
-
getEncryptionSpecification
The encryption at rest options for the table.- AWS owned key (default) - The key is owned by Amazon Keyspaces .
- Customer managed key - The key is stored in your account and is created, owned, and managed by you.
If you choose encryption with a customer managed key, you must specify a valid customer managed KMS key with permissions granted to Amazon Keyspaces.
For more information, see Encryption at rest in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .
Returns union: either
IResolvableorCfnTable.EncryptionSpecificationProperty- See Also:
-
getPointInTimeRecoveryEnabled
Specifies if point-in-time recovery is enabled or disabled for the table.The options are
PointInTimeRecoveryEnabled=trueandPointInTimeRecoveryEnabled=false. If not specified, the default isPointInTimeRecoveryEnabled=false.Returns union: either
BooleanorIResolvable- See Also:
-
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.You can add regular columns to existing tables by adding them to the template.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTable.ColumnProperty>- See Also:
-
getReplicaSpecifications
The AWS Region specific settings of a multi-Region table.For a multi-Region table, you can configure the table's read capacity differently per AWS Region. You can do this by configuring the following parameters.
region: The Region where these settings are applied. (Required)readCapacityUnits: The provisioned read capacity units. (Optional)readCapacityAutoScaling: The read capacity auto scaling settings for the table. (Optional)
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTable.ReplicaSpecificationProperty>- See Also:
-
getTableName
The name of the table to be created.The table name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the table name. For more information, see Name type .
If you specify a name, you can't perform updates that require replacing this resource. You can perform updates that require no interruption or some interruption. If you must replace the resource, specify a new name.
Length constraints: Minimum length of 3. Maximum length of 255.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$- See Also:
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
builder
- Returns:
- a
CfnTableProps.BuilderofCfnTableProps
-