Package software.amazon.awscdk.services.cassandra

Interface CfnKeyspaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKeyspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-05T22:42:00.253Z")
@Stability(Stable)
public interface CfnKeyspaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnKeyspace.

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.*;
 CfnKeyspaceProps cfnKeyspaceProps = CfnKeyspaceProps.builder()
         .clientSideTimestampsEnabled(false)
         .keyspaceName("keyspaceName")
         .replicationSpecification(ReplicationSpecificationProperty.builder()
                 .regionList(List.of("regionList"))
                 .replicationStrategy("replicationStrategy")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKeyspaceProps.Builder	A builder for CfnKeyspaceProps
static final class	CfnKeyspaceProps.Jsii$Proxy	An implementation for CfnKeyspaceProps

Method Summary

Modifier and Type	Method	Description
static CfnKeyspaceProps.Builder	builder()
default Object	getClientSideTimestampsEnabled()	Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace.
default String	getKeyspaceName()	The name of the keyspace to be created.
default Object	getReplicationSpecification()	Specifies the ReplicationStrategy of a keyspace.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientSideTimestampsEnabled

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

Indicates whether client-side timestamps are enabled (true) or disabled (false) for all tables in the keyspace.

To add a Region to a single-Region keyspace with at least one table, the value must be set to true. After you've enabled client-side timestamps for a table, you can’t disable it again.

See Also:

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

getKeyspaceName

@Stability(Stable)
@Nullable
default String getKeyspaceName()

The name of the keyspace to be created.

The keyspace name is case sensitive. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the keyspace name. For more information, see Name type .

Length constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$

See Also:

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

getReplicationSpecification

@Stability(Stable)
@Nullable
default Object getReplicationSpecification()

Specifies the ReplicationStrategy of a keyspace. The options are:.

• SINGLE_REGION for a single Region keyspace (optional) or
• MULTI_REGION for a multi-Region keyspace

If no ReplicationStrategy is provided, the default is SINGLE_REGION . If you choose MULTI_REGION , you must also provide a RegionList with the AWS Regions that the keyspace is replicated in.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnKeyspaceProps.Builder builder()

Returns:

a CfnKeyspaceProps.Builder of CfnKeyspaceProps