Package software.amazon.awscdk.cfnpropertymixins.services.cassandra

Class CfnTablePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cassandra.CfnTablePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTablePropsMixin>

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static final class CfnTablePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTablePropsMixin>

A fluent builder for CfnTablePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTablePropsMixin.Builder	autoScalingSpecifications(CfnTablePropsMixin.AutoScalingSpecificationProperty autoScalingSpecifications)	The optional auto scaling capacity settings for a table in provisioned capacity mode.
CfnTablePropsMixin.Builder	autoScalingSpecifications(IResolvable autoScalingSpecifications)	The optional auto scaling capacity settings for a table in provisioned capacity mode.
CfnTablePropsMixin.Builder	billingMode(CfnTablePropsMixin.BillingModeProperty billingMode)	The billing mode for the table, which determines how you'll be charged for reads and writes:.
CfnTablePropsMixin.Builder	billingMode(IResolvable billingMode)	The billing mode for the table, which determines how you'll be charged for reads and writes:.
CfnTablePropsMixin	build()
CfnTablePropsMixin.Builder	cdcSpecification(CfnTablePropsMixin.CdcSpecificationProperty cdcSpecification)	The settings for the CDC stream of a table.
CfnTablePropsMixin.Builder	cdcSpecification(IResolvable cdcSpecification)	The settings for the CDC stream of a table.
CfnTablePropsMixin.Builder	clientSideTimestampsEnabled(Boolean clientSideTimestampsEnabled)	Enables client-side timestamps for the table.
CfnTablePropsMixin.Builder	clientSideTimestampsEnabled(IResolvable clientSideTimestampsEnabled)	Enables client-side timestamps for the table.
CfnTablePropsMixin.Builder	clusteringKeyColumns(List<? extends Object> clusteringKeyColumns)	One or more columns that determine how the table data is sorted.
CfnTablePropsMixin.Builder	clusteringKeyColumns(IResolvable clusteringKeyColumns)	One or more columns that determine how the table data is sorted.
static CfnTablePropsMixin.Builder	create()
static CfnTablePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTablePropsMixin.Builder	defaultTimeToLive(Number defaultTimeToLive)	The default Time To Live (TTL) value for all rows in a table in seconds.
CfnTablePropsMixin.Builder	encryptionSpecification(CfnTablePropsMixin.EncryptionSpecificationProperty encryptionSpecification)	The encryption at rest options for the table.
CfnTablePropsMixin.Builder	encryptionSpecification(IResolvable encryptionSpecification)	The encryption at rest options for the table.
CfnTablePropsMixin.Builder	keyspaceName(String keyspaceName)	The name of the keyspace to create the table in.
CfnTablePropsMixin.Builder	partitionKeyColumns(List<? extends Object> partitionKeyColumns)	One or more columns that uniquely identify every row in the table.
CfnTablePropsMixin.Builder	partitionKeyColumns(IResolvable partitionKeyColumns)	One or more columns that uniquely identify every row in the table.
CfnTablePropsMixin.Builder	pointInTimeRecoveryEnabled(Boolean pointInTimeRecoveryEnabled)	Specifies if point-in-time recovery is enabled or disabled for the table.
CfnTablePropsMixin.Builder	pointInTimeRecoveryEnabled(IResolvable pointInTimeRecoveryEnabled)	Specifies if point-in-time recovery is enabled or disabled for the table.
CfnTablePropsMixin.Builder	regularColumns(List<? extends Object> regularColumns)	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.
CfnTablePropsMixin.Builder	regularColumns(IResolvable regularColumns)	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.
CfnTablePropsMixin.Builder	replicaSpecifications(List<? extends Object> replicaSpecifications)	The AWS Region specific settings of a multi-Region table.
CfnTablePropsMixin.Builder	replicaSpecifications(IResolvable replicaSpecifications)	The AWS Region specific settings of a multi-Region table.
CfnTablePropsMixin.Builder	tableName(String tableName)	The name of the table to be created.
CfnTablePropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnTablePropsMixin.Builder	warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)	Warm throughput configuration for the table.
CfnTablePropsMixin.Builder	warmThroughput(IResolvable warmThroughput)	Warm throughput configuration for the table.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTablePropsMixin.Builder.

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create()

Returns:

a new instance of CfnTablePropsMixin.Builder.

autoScalingSpecifications

@Stability(Stable)
public CfnTablePropsMixin.Builder autoScalingSpecifications(IResolvable autoScalingSpecifications)

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

Parameters:

autoScalingSpecifications - The optional auto scaling capacity settings for a table in provisioned capacity mode. This parameter is required.

Returns:

this

See Also:

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

autoScalingSpecifications

@Stability(Stable)
public CfnTablePropsMixin.Builder autoScalingSpecifications(CfnTablePropsMixin.AutoScalingSpecificationProperty autoScalingSpecifications)

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

Parameters:

autoScalingSpecifications - The optional auto scaling capacity settings for a table in provisioned capacity mode. This parameter is required.

Returns:

this

See Also:

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

billingMode

@Stability(Stable)
public CfnTablePropsMixin.Builder billingMode(IResolvable billingMode)

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.

Parameters:

billingMode - The billing mode for the table, which determines how you'll be charged for reads and writes:. This parameter is required.

Returns:

this

See Also:

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

billingMode

@Stability(Stable)
public CfnTablePropsMixin.Builder billingMode(CfnTablePropsMixin.BillingModeProperty billingMode)

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.

Parameters:

billingMode - The billing mode for the table, which determines how you'll be charged for reads and writes:. This parameter is required.

Returns:

this

See Also:

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

cdcSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder cdcSpecification(IResolvable cdcSpecification)

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 .

Parameters:

cdcSpecification - The settings for the CDC stream of a table. This parameter is required.

Returns:

this

See Also:

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

cdcSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder cdcSpecification(CfnTablePropsMixin.CdcSpecificationProperty cdcSpecification)

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 .

Parameters:

cdcSpecification - The settings for the CDC stream of a table. This parameter is required.

Returns:

this

See Also:

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

clientSideTimestampsEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder clientSideTimestampsEnabled(Boolean clientSideTimestampsEnabled)

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.

Parameters:

clientSideTimestampsEnabled - Enables client-side timestamps for the table. This parameter is required.

Returns:

this

See Also:

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

clientSideTimestampsEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder clientSideTimestampsEnabled(IResolvable clientSideTimestampsEnabled)

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.

Parameters:

clientSideTimestampsEnabled - Enables client-side timestamps for the table. This parameter is required.

Returns:

this

See Also:

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

clusteringKeyColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder clusteringKeyColumns(IResolvable clusteringKeyColumns)

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

Parameters:

clusteringKeyColumns - One or more columns that determine how the table data is sorted. This parameter is required.

Returns:

this

See Also:

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

clusteringKeyColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder clusteringKeyColumns(List<? extends Object> clusteringKeyColumns)

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

Parameters:

clusteringKeyColumns - One or more columns that determine how the table data is sorted. This parameter is required.

Returns:

this

See Also:

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

defaultTimeToLive

@Stability(Stable)
public CfnTablePropsMixin.Builder defaultTimeToLive(Number defaultTimeToLive)

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 .

Parameters:

defaultTimeToLive - The default Time To Live (TTL) value for all rows in a table in seconds. This parameter is required.

Returns:

this

See Also:

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

encryptionSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder encryptionSpecification(IResolvable encryptionSpecification)

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 .

Parameters:

encryptionSpecification - The encryption at rest options for the table. This parameter is required.

Returns:

this

See Also:

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

encryptionSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder encryptionSpecification(CfnTablePropsMixin.EncryptionSpecificationProperty encryptionSpecification)

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 .

Parameters:

encryptionSpecification - The encryption at rest options for the table. This parameter is required.

Returns:

this

See Also:

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

keyspaceName

@Stability(Stable)
public CfnTablePropsMixin.Builder keyspaceName(String keyspaceName)

The name of the keyspace to create the table in.

The keyspace must already exist.

Parameters:

keyspaceName - The name of the keyspace to create the table in. This parameter is required.

Returns:

this

See Also:

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

partitionKeyColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder partitionKeyColumns(IResolvable partitionKeyColumns)

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

Every table must have a partition key.

Parameters:

partitionKeyColumns - One or more columns that uniquely identify every row in the table. This parameter is required.

Returns:

this

See Also:

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

partitionKeyColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder partitionKeyColumns(List<? extends Object> partitionKeyColumns)

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

Every table must have a partition key.

Parameters:

partitionKeyColumns - One or more columns that uniquely identify every row in the table. This parameter is required.

Returns:

this

See Also:

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

pointInTimeRecoveryEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder pointInTimeRecoveryEnabled(Boolean pointInTimeRecoveryEnabled)

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

The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .

Parameters:

pointInTimeRecoveryEnabled - Specifies if point-in-time recovery is enabled or disabled for the table. This parameter is required.

Returns:

this

See Also:

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

pointInTimeRecoveryEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder pointInTimeRecoveryEnabled(IResolvable pointInTimeRecoveryEnabled)

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

The options are PointInTimeRecoveryEnabled=true and PointInTimeRecoveryEnabled=false . If not specified, the default is PointInTimeRecoveryEnabled=false .

Parameters:

pointInTimeRecoveryEnabled - Specifies if point-in-time recovery is enabled or disabled for the table. This parameter is required.

Returns:

this

See Also:

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

regularColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder regularColumns(IResolvable regularColumns)

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.

Parameters:

regularColumns - 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. This parameter is required.

Returns:

this

See Also:

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

regularColumns

@Stability(Stable)
public CfnTablePropsMixin.Builder regularColumns(List<? extends Object> regularColumns)

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.

Parameters:

regularColumns - 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. This parameter is required.

Returns:

this

See Also:

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

replicaSpecifications

@Stability(Stable)
public CfnTablePropsMixin.Builder replicaSpecifications(IResolvable replicaSpecifications)

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)

Parameters:

replicaSpecifications - The AWS Region specific settings of a multi-Region table. This parameter is required.

Returns:

this

See Also:

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

replicaSpecifications

@Stability(Stable)
public CfnTablePropsMixin.Builder replicaSpecifications(List<? extends Object> replicaSpecifications)

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)

Parameters:

replicaSpecifications - The AWS Region specific settings of a multi-Region table. This parameter is required.

Returns:

this

See Also:

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

tableName

@Stability(Stable)
public CfnTablePropsMixin.Builder tableName(String tableName)

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}$

Parameters:

tableName - The name of the table to be created. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTablePropsMixin.Builder tags(List<? extends CfnTag> tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder warmThroughput(IResolvable warmThroughput)

Warm throughput configuration for the table.

Parameters:

warmThroughput - Warm throughput configuration for the table. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)

Warm throughput configuration for the table.

Parameters:

warmThroughput - Warm throughput configuration for the table. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTablePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTablePropsMixin>

Returns:

a newly built instance of CfnTablePropsMixin.