DAX / Client / create_cluster

create_cluster

DAX.Client.create_cluster(**kwargs)

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

See also: AWS API Documentation

Request Syntax

response = client.create_cluster(
    ClusterName='string',
    NodeType='string',
    Description='string',
    ReplicationFactor=123,
    AvailabilityZones=[
        'string',
    ],
    SubnetGroupName='string',
    SecurityGroupIds=[
        'string',
    ],
    PreferredMaintenanceWindow='string',
    NotificationTopicArn='string',
    IamRoleArn='string',
    ParameterGroupName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SSESpecification={
        'Enabled': True|False
    },
    ClusterEndpointEncryptionType='NONE'|'TLS'
)

Parameters:

• ClusterName (string) –

  [REQUIRED]

  The cluster identifier. This parameter is stored as a lowercase string.

  Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

• NodeType (string) –

  [REQUIRED]

  The compute and memory capacity of the nodes in the cluster.

• Description (string) – A description of the cluster.

• ReplicationFactor (integer) –

  [REQUIRED]

  The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

  Note

  AWS recommends that you have at least two read replicas per cluster.

• AvailabilityZones (list) –

  The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

  • (string) –

• SubnetGroupName (string) –

  The name of the subnet group to be used for the replication group.

  Warning

  DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

• SecurityGroupIds (list) –

  A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

  If this parameter is not specified, DAX assigns the default VPC security group to each node.

  • (string) –

• PreferredMaintenanceWindow (string) –

  Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

  Example: sun:05:00-sun:09:00

  Note

  If you don’t specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

• NotificationTopicArn (string) –

  The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

  Note

  The Amazon SNS topic owner must be same as the DAX cluster owner.

• IamRoleArn (string) –

  [REQUIRED]

  A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role’s permissions to access DynamoDB on your behalf.

• ParameterGroupName (string) – The parameter group to be associated with the DAX cluster.

• Tags (list) –

  A set of tags to associate with the DAX cluster.

  • (dict) –

    A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

    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:.

    You cannot backdate the application of a tag.

    • Key (string) –

      The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have 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) –

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

• SSESpecification (dict) –

  Represents the settings used to enable server-side encryption on the cluster.

  • Enabled (boolean) – [REQUIRED]

    Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

• ClusterEndpointEncryptionType (string) –

  The type of encryption the cluster’s endpoint should support. Values are:

  • NONE for no encryption

  • TLS for Transport Layer Security

Return type:

dict

Returns:

Response Syntax

{
    'Cluster': {
        'ClusterName': 'string',
        'Description': 'string',
        'ClusterArn': 'string',
        'TotalNodes': 123,
        'ActiveNodes': 123,
        'NodeType': 'string',
        'Status': 'string',
        'ClusterDiscoveryEndpoint': {
            'Address': 'string',
            'Port': 123,
            'URL': 'string'
        },
        'NodeIdsToRemove': [
            'string',
        ],
        'Nodes': [
            {
                'NodeId': 'string',
                'Endpoint': {
                    'Address': 'string',
                    'Port': 123,
                    'URL': 'string'
                },
                'NodeCreateTime': datetime(2015, 1, 1),
                'AvailabilityZone': 'string',
                'NodeStatus': 'string',
                'ParameterGroupStatus': 'string'
            },
        ],
        'PreferredMaintenanceWindow': 'string',
        'NotificationConfiguration': {
            'TopicArn': 'string',
            'TopicStatus': 'string'
        },
        'SubnetGroup': 'string',
        'SecurityGroups': [
            {
                'SecurityGroupIdentifier': 'string',
                'Status': 'string'
            },
        ],
        'IamRoleArn': 'string',
        'ParameterGroup': {
            'ParameterGroupName': 'string',
            'ParameterApplyStatus': 'string',
            'NodeIdsToReboot': [
                'string',
            ]
        },
        'SSEDescription': {
            'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
        },
        'ClusterEndpointEncryptionType': 'NONE'|'TLS'
    }
}

Response Structure

• (dict) –

  • Cluster (dict) –

    A description of the DAX cluster that you have created.

    • ClusterName (string) –

      The name of the DAX cluster.

    • Description (string) –

      The description of the cluster.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    • TotalNodes (integer) –

      The total number of nodes in the cluster.

    • ActiveNodes (integer) –

      The number of nodes in the cluster that are active (i.e., capable of serving requests).

    • NodeType (string) –

      The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

    • Status (string) –

      The current status of the cluster.

    • ClusterDiscoveryEndpoint (dict) –

      The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

      • Address (string) –

        The DNS hostname of the endpoint.

      • Port (integer) –

        The port number that applications should use to connect to the endpoint.

      • URL (string) –

        The URL that applications should use to connect to the endpoint. The default ports are 8111 for the “dax” protocol and 9111 for the “daxs” protocol.

    • NodeIdsToRemove (list) –

      A list of nodes to be removed from the cluster.

      • (string) –

    • Nodes (list) –

      A list of nodes that are currently in the cluster.

      • (dict) –

        Represents an individual node within a DAX cluster.

        • NodeId (string) –

          A system-generated identifier for the node.

        • Endpoint (dict) –

          The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address (string) –

            The DNS hostname of the endpoint.

          • Port (integer) –

            The port number that applications should use to connect to the endpoint.

          • URL (string) –

            The URL that applications should use to connect to the endpoint. The default ports are 8111 for the “dax” protocol and 9111 for the “daxs” protocol.

        • NodeCreateTime (datetime) –

          The date and time (in UNIX epoch format) when the node was launched.

        • AvailabilityZone (string) –

          The Availability Zone (AZ) in which the node has been deployed.

        • NodeStatus (string) –

          The current status of the node. For example: available.

        • ParameterGroupStatus (string) –

          The status of the parameter group associated with this node. For example, in-sync.

    • PreferredMaintenanceWindow (string) –

      A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

    • NotificationConfiguration (dict) –

      Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

      • TopicArn (string) –

        The Amazon Resource Name (ARN) that identifies the topic.

      • TopicStatus (string) –

        The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

    • SubnetGroup (string) –

      The subnet group where the DAX cluster is running.

    • SecurityGroups (list) –

      A list of security groups, and the status of each, for the nodes in the cluster.

      • (dict) –

        An individual VPC security group and its status.

        • SecurityGroupIdentifier (string) –

          The unique ID for this security group.

        • Status (string) –

          The status of this security group.

    • IamRoleArn (string) –

      A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role’s permissions to access DynamoDB on your behalf.

    • ParameterGroup (dict) –

      The parameter group being used by nodes in the cluster.

      • ParameterGroupName (string) –

        The name of the parameter group.

      • ParameterApplyStatus (string) –

        The status of parameter updates.

      • NodeIdsToReboot (list) –

        The node IDs of one or more nodes to be rebooted.

        • (string) –

    • SSEDescription (dict) –

      The description of the server-side encryption status on the specified DAX cluster.

      • Status (string) –

        The current state of server-side encryption:

        • ENABLING - Server-side encryption is being enabled.

        • ENABLED - Server-side encryption is enabled.

        • DISABLING - Server-side encryption is being disabled.

        • DISABLED - Server-side encryption is disabled.

    • ClusterEndpointEncryptionType (string) –

      The type of encryption supported by the cluster’s endpoint. Values are:

      • NONE for no encryption TLS for Transport Layer Security

Exceptions

• DAX.Client.exceptions.ClusterAlreadyExistsFault

• DAX.Client.exceptions.InvalidClusterStateFault

• DAX.Client.exceptions.InsufficientClusterCapacityFault

• DAX.Client.exceptions.SubnetGroupNotFoundFault

• DAX.Client.exceptions.InvalidParameterGroupStateFault

• DAX.Client.exceptions.ParameterGroupNotFoundFault

• DAX.Client.exceptions.ClusterQuotaForCustomerExceededFault

• DAX.Client.exceptions.NodeQuotaForClusterExceededFault

• DAX.Client.exceptions.NodeQuotaForCustomerExceededFault

• DAX.Client.exceptions.InvalidVPCNetworkStateFault

• DAX.Client.exceptions.TagQuotaPerResourceExceeded

• DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault

• DAX.Client.exceptions.InvalidParameterValueException

• DAX.Client.exceptions.InvalidParameterCombinationException

• DAX.Client.exceptions.ServiceQuotaExceededException