This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::Cassandra::Keyspace You can use the `AWS::Cassandra::Keyspace` resource to create a new keyspace in Amazon Keyspaces (for Apache Cassandra). For more information, see [Create a keyspace](https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.keyspaces.html) in the *Amazon Keyspaces Developer Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Cassandra::Keyspace", "Properties" : { "[ClientSideTimestampsEnabled](#cfn-cassandra-keyspace-clientsidetimestampsenabled)" : Boolean, "[KeyspaceName](#cfn-cassandra-keyspace-keyspacename)" : String, "[ReplicationSpecification](#cfn-cassandra-keyspace-replicationspecification)" : ReplicationSpecification, "[Tags](#cfn-cassandra-keyspace-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Cassandra::Keyspace Properties: [ClientSideTimestampsEnabled](#cfn-cassandra-keyspace-clientsidetimestampsenabled): Boolean [KeyspaceName](#cfn-cassandra-keyspace-keyspacename): String [ReplicationSpecification](#cfn-cassandra-keyspace-replicationspecification): ReplicationSpecification [Tags](#cfn-cassandra-keyspace-tags): - Tag ``` ## Properties `ClientSideTimestampsEnabled` 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. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KeyspaceName` 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). *Length constraints:* Minimum length of 1. Maximum length of 48. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ReplicationSpecification` 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. *Required*: No *Type*: [ReplicationSpecification](aws-properties-cassandra-keyspace-replicationspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). *Required*: No *Type*: Array of [Tag](aws-properties-cassandra-keyspace-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the keyspace. For example: `{ "Ref": "MyNewKeyspace" }` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ## Examples This section includes code examples that demonstrate how to create a keyspace using the different options. **Topics** + [Create a new keyspace with tags](#aws-resource-cassandra-keyspace--examples--Create_a_new_keyspace_with_tags) + [Create a new multi-Region keyspace](#aws-resource-cassandra-keyspace--examples--Create_a_new_multi-Region_keyspace) + [Add a new AWS Region to a single-Region keyspace](#aws-resource-cassandra-keyspace--examples--Add_a_new_Region_to_a_single-Region_keyspace) + [Add a new AWS Region to a multi-Region keyspace](#aws-resource-cassandra-keyspace--examples--Add_a_new_Region_to_a_multi-Region_keyspace) ### Create a new keyspace with tags The following example creates a new keyspace named `MyNewKeyspace` with the following tags: `{'key1':'val1', 'key2':'val2'}`. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "MyNewKeyspace": { "Type": "AWS::Cassandra::Keyspace", "Properties": { "KeyspaceName": "MyNewKeyspace", "Tags": [{"Key":"tag1","Value":"val1"}, {"Key":"tag2","Value":"val2"}] } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Resources: MyNewKeyspace: Type: AWS::Cassandra::Keyspace Properties: KeyspaceName: MyNewKeyspace Tags: - Key: tag1 Value: val1 - Key: tag2 Value: val2 ``` ### Create a new multi-Region keyspace The following example creates a new multi-Region keyspace named `MultiRegionKeyspace` that is replicated across three AWS Regions. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "MultiRegionKeyspace": { "Type": "AWS::Cassandra::Keyspace", "Properties": { "KeyspaceName": "MultiRegionKeyspace", "ReplicationSpecification": { "ReplicationStrategy": "MULTI_REGION", "RegionList": ["us-east-1", "us-west-2", "eu-west-1"] } } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Resources: MultiRegionKeyspace: Type: AWS::Cassandra::Keyspace Properties: KeyspaceName: MultiRegionKeyspace ReplicationSpecification: ReplicationStrategy: MULTI_REGION RegionList: - us-east-1 - us-west-2 - eu-west-1 ``` ### Add a new AWS Region to a single-Region keyspace The following example shows how to add the Region `eu-west-1` to a single-Region keyspace named `MyNewKeyspace` that is currently available in `us-east-1`. #### JSON ``` { "AWSTemplateFormatVersion":"2010-09-09", "Resources":{ "MultiRegionKeyspace":{ "Type":"AWS::Cassandra::Keyspace", "Properties":{ "KeyspaceName":"MyNewKeyspace", "ReplicationSpecification":{ "ReplicationStrategy":"MULTI_REGION", "RegionList":[ "us-east-1", "eu-west-1" ] }, "ClientSideTimestampsEnabled":true } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Resources: MultiRegionKeyspace: Type: AWS::Cassandra::Keyspace Properties: KeyspaceName: MyNewKeyspace ReplicationSpecification: ReplicationStrategy: MULTI_REGION RegionList: - us-east-1 - eu-west-1 ClientSideTimestampsEnabled: true ``` ### Add a new AWS Region to a multi-Region keyspace The following example shows how to add the new Region `us-west-2` to the existing multi-Region keyspace named `MultiRegionKeyspace` that is already replicated across `us-east-1` and `eu-west-1`. #### JSON ``` { "AWSTemplateFormatVersion":"2010-09-09", "Resources":{ "MultiRegionKeyspace":{ "Type":"AWS::Cassandra::Keyspace", "Properties":{ "KeyspaceName":"MultiRegionKeyspace", "ReplicationSpecification":{ "ReplicationStrategy":"MULTI_REGION", "RegionList":[ "us-east-1", "eu-west-1", "us-west-2" ] } } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Resources: MultiRegionKeyspace: Type: AWS::Cassandra::Keyspace Properties: KeyspaceName: MultiRegionKeyspace ReplicationSpecification: ReplicationStrategy: MULTI_REGION RegionList: - us-east-1 - us-west-1 - us-west-2 ``` # AWS::Cassandra::Keyspace ReplicationSpecification You can use `ReplicationSpecification` to configure the `ReplicationStrategy` of a keyspace in Amazon Keyspaces. The `ReplicationSpecification` property 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](https://docs.aws.amazon.com/keyspaces/latest/devguide/howitworks_replication_permissions_addReplica.html) in the *Amazon Keyspaces Developer Guide*. For more information about multi-Region replication, see [Multi-Region replication](https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication.html) in the *Amazon Keyspaces Developer Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RegionList](#cfn-cassandra-keyspace-replicationspecification-regionlist)" : [ String, ... ], "[ReplicationStrategy](#cfn-cassandra-keyspace-replicationspecification-replicationstrategy)" : String } ``` ### YAML ``` [RegionList](#cfn-cassandra-keyspace-replicationspecification-regionlist): - String [ReplicationStrategy](#cfn-cassandra-keyspace-replicationspecification-replicationstrategy): String ``` ## Properties `RegionList` 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](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable), you must first enable the Region. For more information, see [Multi-Region replication in AWS Regions disabled by default](https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication_how-it-works.html#howitworks_mrr_opt_in) in the *Amazon Keyspaces Developer Guide*. *Required*: No *Type*: Array of String *Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ca-central-1 | eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-central-1 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` *Minimum*: `2` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ReplicationStrategy` The options are: + `SINGLE_REGION` (optional) + `MULTI_REGION` If no value is specified, the default is `SINGLE_REGION`. If `MULTI_REGION` is specified, `RegionList` is required. *Required*: No *Type*: String *Allowed values*: `SINGLE_REGION | MULTI_REGION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Cassandra::Keyspace Tag Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. AWS-assigned tag names and values are automatically assigned the `aws:` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix `user:` in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see [Adding tags and labels to Amazon Keyspaces resources](https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) in the *Amazon Keyspaces Developer Guide*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-cassandra-keyspace-tag-key)" : String, "[Value](#cfn-cassandra-keyspace-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-cassandra-keyspace-tag-key): String [Value](#cfn-cassandra-keyspace-tag-value): String ``` ## Properties `Key` The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. Tag values are case-sensitive and can be null. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)