Keyspaces / Client / create_keyspace

create_keyspace#

Keyspaces.Client.create_keyspace(**kwargs)#

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_keyspace(
    keyspaceName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    replicationSpecification={
        'replicationStrategy': 'SINGLE_REGION'|'MULTI_REGION',
        'regionList': [
            'string',
        ]
    }
)
Parameters:

  • keyspaceName (string) –

    [REQUIRED]

    The name of the keyspace to be created.

  • tags (list) –

    A list of key-value pair tags to be attached to the keyspace.

    For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

    • (dict) –

      Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.

      Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-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 in the Amazon Keyspaces Developer Guide.

      • key (string) – [REQUIRED]

        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.

      • value (string) – [REQUIRED]

        The value of the tag. Tag values are case-sensitive and can be null.

  • replicationSpecification (dict) –

    The replication specification of the keyspace includes:

    • replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.

    • regionList - if the replicationStrategy is MULTI_REGION, the regionList requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current Region is six.

    • replicationStrategy (string) – [REQUIRED]

      The replicationStrategy of a keyspace, the required value is SINGLE_REGION or MULTI_REGION.

    • regionList (list) –

      The regionList can contain up to six Amazon Web Services Regions where the keyspace is replicated in.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'resourceArn': 'string'
}

Response Structure

  • (dict) –

    • resourceArn (string) –

      The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).

Exceptions