software.amazon.awssdk.services.keyspaces.model

Interface CreateTableRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>, KeyspacesRequest.Builder, SdkBuilder<CreateTableRequest.Builder,CreateTableRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateTableRequest

public static interface CreateTableRequest.Builder
extends KeyspacesRequest.Builder, SdkPojo, CopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>

Method Summary

Modifier and Type	Method and Description
CreateTableRequest.Builder	capacitySpecification(CapacitySpecification capacitySpecification) Specifies the read/write throughput capacity mode for the table.
default CreateTableRequest.Builder	capacitySpecification(Consumer<CapacitySpecification.Builder> capacitySpecification) Specifies the read/write throughput capacity mode for the table.
CreateTableRequest.Builder	comment(Comment comment) This parameter allows to enter a description of the table.
default CreateTableRequest.Builder	comment(Consumer<Comment.Builder> comment) This parameter allows to enter a description of the table.
CreateTableRequest.Builder	defaultTimeToLive(Integer defaultTimeToLive) The default Time to Live setting in seconds for the table.
default CreateTableRequest.Builder	encryptionSpecification(Consumer<EncryptionSpecification.Builder> encryptionSpecification) Specifies how the encryption key for encryption at rest is managed for the table.
CreateTableRequest.Builder	encryptionSpecification(EncryptionSpecification encryptionSpecification) Specifies how the encryption key for encryption at rest is managed for the table.
CreateTableRequest.Builder	keyspaceName(String keyspaceName) The name of the keyspace that the table is going to be created in.
CreateTableRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTableRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateTableRequest.Builder	pointInTimeRecovery(Consumer<PointInTimeRecovery.Builder> pointInTimeRecovery) Specifies if pointInTimeRecovery is enabled or disabled for the table.
CreateTableRequest.Builder	pointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery) Specifies if pointInTimeRecovery is enabled or disabled for the table.
default CreateTableRequest.Builder	schemaDefinition(Consumer<SchemaDefinition.Builder> schemaDefinition) The schemaDefinition consists of the following parameters.
CreateTableRequest.Builder	schemaDefinition(SchemaDefinition schemaDefinition) The schemaDefinition consists of the following parameters.
CreateTableRequest.Builder	tableName(String tableName) The name of the table.
CreateTableRequest.Builder	tags(Collection<Tag> tags) A list of key-value pair tags to be attached to the resource.
CreateTableRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of key-value pair tags to be attached to the resource.
CreateTableRequest.Builder	tags(Tag... tags) A list of key-value pair tags to be attached to the resource.
default CreateTableRequest.Builder	ttl(Consumer<TimeToLive.Builder> ttl) Enables Time to Live custom settings for the table.
CreateTableRequest.Builder	ttl(TimeToLive ttl) Enables Time to Live custom settings for the table.

Methods inherited from interface software.amazon.awssdk.services.keyspaces.model.KeyspacesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

keyspaceName

CreateTableRequest.Builder keyspaceName(String keyspaceName)

The name of the keyspace that the table is going to be created in.

Parameters:

keyspaceName - The name of the keyspace that the table is going to be created in.

Returns:

Returns a reference to this object so that method calls can be chained together.

tableName

CreateTableRequest.Builder tableName(String tableName)

The name of the table.

Parameters:

tableName - The name of the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaDefinition

CreateTableRequest.Builder schemaDefinition(SchemaDefinition schemaDefinition)

The schemaDefinition consists of the following parameters.

For each column to be created:

• name - The name of the column.

• type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

The primary key of the table consists of the following columns:

• partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

• name - The name of each partition key column.

• clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

• name - The name of the clustering column.

• orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

• name - The name of the column.

• type - An Amazon Keyspaces data type.

Parameters:

schemaDefinition - The schemaDefinition consists of the following parameters.

For each column to be created:

• name - The name of the column.

• type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

The primary key of the table consists of the following columns:

• partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

• name - The name of each partition key column.

• clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

• name - The name of the clustering column.

• orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

• name - The name of the column.

• type - An Amazon Keyspaces data type.

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaDefinition

default CreateTableRequest.Builder schemaDefinition(Consumer<SchemaDefinition.Builder> schemaDefinition)

The schemaDefinition consists of the following parameters.

For each column to be created:

• name - The name of the column.

• type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

The primary key of the table consists of the following columns:

• partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

• name - The name of each partition key column.

• clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

• name - The name of the clustering column.

• orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

• name - The name of the column.

• type - An Amazon Keyspaces data type.

This is a convenience method that creates an instance of the SchemaDefinition.Builder avoiding the need to create one manually via SchemaDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schemaDefinition(SchemaDefinition).

Parameters:

schemaDefinition - a consumer that will call methods on SchemaDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schemaDefinition(SchemaDefinition)

comment

CreateTableRequest.Builder comment(Comment comment)

This parameter allows to enter a description of the table.

Parameters:

comment - This parameter allows to enter a description of the table.

Returns:

Returns a reference to this object so that method calls can be chained together.

comment

default CreateTableRequest.Builder comment(Consumer<Comment.Builder> comment)

This parameter allows to enter a description of the table.

This is a convenience method that creates an instance of the Comment.Builder avoiding the need to create one manually via Comment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to comment(Comment).

Parameters:

comment - a consumer that will call methods on Comment.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

comment(Comment)

capacitySpecification

CreateTableRequest.Builder capacitySpecification(CapacitySpecification capacitySpecification)

Specifies the read/write throughput capacity mode for the table. The options are:

• throughputMode:PAY_PER_REQUEST and

• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

Parameters:

capacitySpecification - Specifies the read/write throughput capacity mode for the table. The options are:

• throughputMode:PAY_PER_REQUEST and

• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacitySpecification

default CreateTableRequest.Builder capacitySpecification(Consumer<CapacitySpecification.Builder> capacitySpecification)

Specifies the read/write throughput capacity mode for the table. The options are:

• throughputMode:PAY_PER_REQUEST and

• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

This is a convenience method that creates an instance of the CapacitySpecification.Builder avoiding the need to create one manually via CapacitySpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacitySpecification(CapacitySpecification).

Parameters:

capacitySpecification - a consumer that will call methods on CapacitySpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

capacitySpecification(CapacitySpecification)

encryptionSpecification

CreateTableRequest.Builder encryptionSpecification(EncryptionSpecification encryptionSpecification)

Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

Parameters:

encryptionSpecification - Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionSpecification

default CreateTableRequest.Builder encryptionSpecification(Consumer<EncryptionSpecification.Builder> encryptionSpecification)

Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

This is a convenience method that creates an instance of the EncryptionSpecification.Builder avoiding the need to create one manually via EncryptionSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionSpecification(EncryptionSpecification).

Parameters:

encryptionSpecification - a consumer that will call methods on EncryptionSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryptionSpecification(EncryptionSpecification)

pointInTimeRecovery

CreateTableRequest.Builder pointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)

Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:

• ENABLED

• DISABLED

If it's not specified, the default is DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

Parameters:

pointInTimeRecovery - Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:

• ENABLED

• DISABLED

If it's not specified, the default is DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

pointInTimeRecovery

default CreateTableRequest.Builder pointInTimeRecovery(Consumer<PointInTimeRecovery.Builder> pointInTimeRecovery)

Specifies if pointInTimeRecovery is enabled or disabled for the table. The options are:

• ENABLED

• DISABLED

If it's not specified, the default is DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

This is a convenience method that creates an instance of the PointInTimeRecovery.Builder avoiding the need to create one manually via PointInTimeRecovery.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pointInTimeRecovery(PointInTimeRecovery).

Parameters:

pointInTimeRecovery - a consumer that will call methods on PointInTimeRecovery.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

pointInTimeRecovery(PointInTimeRecovery)

ttl

CreateTableRequest.Builder ttl(TimeToLive ttl)

Enables Time to Live custom settings for the table. The options are:

• status:enabled

• status:disabled

The default is status:disabled. After ttl is enabled, you can't disable it for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

Parameters:

ttl - Enables Time to Live custom settings for the table. The options are:

• status:enabled

• status:disabled

The default is status:disabled. After ttl is enabled, you can't disable it for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

ttl

default CreateTableRequest.Builder ttl(Consumer<TimeToLive.Builder> ttl)

Enables Time to Live custom settings for the table. The options are:

• status:enabled

• status:disabled

The default is status:disabled. After ttl is enabled, you can't disable it for the table.

For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

This is a convenience method that creates an instance of the TimeToLive.Builder avoiding the need to create one manually via TimeToLive.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ttl(TimeToLive).

Parameters:

ttl - a consumer that will call methods on TimeToLive.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ttl(TimeToLive)

defaultTimeToLive

CreateTableRequest.Builder defaultTimeToLive(Integer defaultTimeToLive)

The default Time to Live setting in seconds for the table.

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 setting in seconds for the table.

For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateTableRequest.Builder tags(Collection<Tag> tags)

A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Parameters:

tags - A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateTableRequest.Builder tags(Tag... tags)

A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Parameters:

tags - A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateTableRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateTableRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateTableRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder