CfnKeyspacePropsMixin
- class aws_cdk.mixins_preview.aws_cassandra.mixins.CfnKeyspacePropsMixin(props, *, strategy=None)
Bases:
MixinYou can use the
AWS::Cassandra::Keyspaceresource to create a new keyspace in Amazon Keyspaces (for Apache Cassandra).For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-keyspace.html
- CloudformationResource:
AWS::Cassandra::Keyspace
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_cassandra import mixins as cassandra_mixins cfn_keyspace_props_mixin = cassandra_mixins.CfnKeyspacePropsMixin(cassandra_mixins.CfnKeyspaceMixinProps( client_side_timestamps_enabled=False, keyspace_name="keyspaceName", replication_specification=cassandra_mixins.CfnKeyspacePropsMixin.ReplicationSpecificationProperty( region_list=["regionList"], replication_strategy="replicationStrategy" ), tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Cassandra::Keyspace.- Parameters:
props (
Union[CfnKeyspaceMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['clientSideTimestampsEnabled', 'keyspaceName', 'replicationSpecification', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ReplicationSpecificationProperty
- class CfnKeyspacePropsMixin.ReplicationSpecificationProperty(*, region_list=None, replication_strategy=None)
Bases:
objectYou can use
ReplicationSpecificationto configure theReplicationStrategyof a keyspace in Amazon Keyspaces .The
ReplicationSpecificationproperty applies automatically to all tables in the keyspace.To review the permissions that are required to add a new Region to a single-Region keyspace, see Configure the IAM permissions required to add an AWS Region to a keyspace in the Amazon Keyspaces Developer Guide .
For more information about multi-Region replication, see Multi-Region replication in the Amazon Keyspaces Developer Guide .
- Parameters:
region_list (
Optional[Sequence[str]]) – Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two Regions, including the Region that the keyspace is being created in. To specify a Region that’s disabled by default , you must first enable the Region. For more information, see Multi-Region replication in AWS Regions disabled by default in the Amazon Keyspaces Developer Guide .replication_strategy (
Optional[str]) – The options are:. -SINGLE_REGION(optional) -MULTI_REGIONIf no value is specified, the default isSINGLE_REGION. IfMULTI_REGIONis specified,RegionListis required.
- See:
- 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.mixins_preview.aws_cassandra import mixins as cassandra_mixins replication_specification_property = cassandra_mixins.CfnKeyspacePropsMixin.ReplicationSpecificationProperty( region_list=["regionList"], replication_strategy="replicationStrategy" )
Attributes
- region_list
Specifies the AWS Regions that the keyspace is replicated in.
You must specify at least two Regions, including the Region that the keyspace is being created in.
To specify a Region that’s disabled by default , you must first enable the Region. For more information, see Multi-Region replication in AWS Regions disabled by default in the Amazon Keyspaces Developer Guide .
- replication_strategy
.
SINGLE_REGION(optional)MULTI_REGION
If no value is specified, the default is
SINGLE_REGION. IfMULTI_REGIONis specified,RegionListis required.