Package software.amazon.awssdk.services.keyspaces.model

Interface CreateTableRequest.Builder

    • 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.

      • 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.

      • 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.

      • pointInTimeRecovery

        CreateTableRequest.Builder pointInTimeRecovery​(PointInTimeRecovery pointInTimeRecovery)

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

        • status=ENABLED

        • status=DISABLED

        If it's not specified, the default is status=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:

        • status=ENABLED

        • status=DISABLED

        If it's not specified, the default is status=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.

      • 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.

      • clientSideTimestamps

        CreateTableRequest.Builder clientSideTimestamps​(ClientSideTimestamps clientSideTimestamps)

        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"

        Once client-side timestamps are enabled for a table, this setting cannot be disabled.

        Parameters:
        clientSideTimestamps - 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"

        Once client-side timestamps are enabled for a table, this setting cannot be disabled.

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

      • autoScalingSpecification

        CreateTableRequest.Builder autoScalingSpecification​(AutoScalingSpecification autoScalingSpecification)

        The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.

        Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

        By default, auto scaling is disabled for a table.

        Parameters:
        autoScalingSpecification - The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.

        Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

        By default, auto scaling is disabled for a table.

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

      • replicaSpecifications

        CreateTableRequest.Builder replicaSpecifications​(Collection<ReplicaSpecification> replicaSpecifications)

        The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

        For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so 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 optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

        For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so 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:
        Returns a reference to this object so that method calls can be chained together.

      • replicaSpecifications

        CreateTableRequest.Builder replicaSpecifications​(ReplicaSpecification... replicaSpecifications)

        The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

        For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so 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 optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

        For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so 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:
        Returns a reference to this object so that method calls can be chained together.

      • replicaSpecifications

        CreateTableRequest.Builder replicaSpecifications​(Consumer<ReplicaSpecification.Builder>... replicaSpecifications)

        The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region.

        For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so 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)

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

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

        Parameters:
        replicaSpecifications - a consumer that will call methods on ReplicaSpecification.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #replicaSpecifications(java.util.Collection)