CfnKeyspaceProps
- class aws_cdk.aws_cassandra.CfnKeyspaceProps(*, client_side_timestamps_enabled=None, keyspace_name=None, replication_specification=None, tags=None)
Bases:
object
Properties for defining a
CfnKeyspace
.- Parameters:
client_side_timestamps_enabled (
Union
[bool
,IResolvable
,None
]) – 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.keyspace_name (
Optional
[str
]) – 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}$
replication_specification (
Union
[IResolvable
,ReplicationSpecificationProperty
,Dict
[str
,Any
],None
]) – Specifies theReplicationStrategy
of a keyspace. The options are:. -SINGLE_REGION
for a single Region keyspace (optional) or -MULTI_REGION
for a multi-Region keyspace If noReplicationStrategy
is provided, the default isSINGLE_REGION
. If you chooseMULTI_REGION
, you must also provide aRegionList
with the AWS Regions that the keyspace is replicated in.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cassandra as cassandra cfn_keyspace_props = cassandra.CfnKeyspaceProps( client_side_timestamps_enabled=False, keyspace_name="keyspaceName", replication_specification=cassandra.CfnKeyspace.ReplicationSpecificationProperty( region_list=["regionList"], replication_strategy="replicationStrategy" ), tags=[CfnTag( key="key", value="value" )] )
Attributes
- client_side_timestamps_enabled
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.
- keyspace_name
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}$
- replication_specification
.
SINGLE_REGION
for a single Region keyspace (optional) orMULTI_REGION
for a multi-Region keyspace
If no
ReplicationStrategy
is provided, the default isSINGLE_REGION
. If you chooseMULTI_REGION
, you must also provide aRegionList
with the AWS Regions that the keyspace is replicated in.- See:
- Type:
Specifies the
ReplicationStrategy
of a keyspace. The options are