Skip to content

Create Cluster

dax_create_cluster R Documentation

Creates a DAX cluster

Description

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

Usage

dax_create_cluster(ClusterName, NodeType, Description,
  ReplicationFactor, AvailabilityZones, SubnetGroupName, SecurityGroupIds,
  PreferredMaintenanceWindow, NotificationTopicArn, IamRoleArn,
  ParameterGroupName, Tags, SSESpecification,
  ClusterEndpointEncryptionType)

Arguments

ClusterName

[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

[required] The compute and memory capacity of the nodes in the cluster.

Description

A description of the cluster.

ReplicationFactor

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

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

AvailabilityZones

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.

SubnetGroupName

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

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

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.

PreferredMaintenanceWindow

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

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

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

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

IamRoleArn

[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

The parameter group to be associated with the DAX cluster.

Tags

A set of tags to associate with the DAX cluster.

SSESpecification

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

ClusterEndpointEncryptionType

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

  • NONE for no encryption

  • TLS for Transport Layer Security

Value

A list with the following syntax: 

list(
  Cluster = list(
    ClusterName = "string",
    Description = "string",
    ClusterArn = "string",
    TotalNodes = 123,
    ActiveNodes = 123,
    NodeType = "string",
    Status = "string",
    ClusterDiscoveryEndpoint = list(
      Address = "string",
      Port = 123,
      URL = "string"
    ),
    NodeIdsToRemove = list(
      "string"
    ),
    Nodes = list(
      list(
        NodeId = "string",
        Endpoint = list(
          Address = "string",
          Port = 123,
          URL = "string"
        ),
        NodeCreateTime = as.POSIXct(
          "2015-01-01"
        ),
        AvailabilityZone = "string",
        NodeStatus = "string",
        ParameterGroupStatus = "string"
      )
    ),
    PreferredMaintenanceWindow = "string",
    NotificationConfiguration = list(
      TopicArn = "string",
      TopicStatus = "string"
    ),
    SubnetGroup = "string",
    SecurityGroups = list(
      list(
        SecurityGroupIdentifier = "string",
        Status = "string"
      )
    ),
    IamRoleArn = "string",
    ParameterGroup = list(
      ParameterGroupName = "string",
      ParameterApplyStatus = "string",
      NodeIdsToReboot = list(
        "string"
      )
    ),
    SSEDescription = list(
      Status = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"
    ),
    ClusterEndpointEncryptionType = "NONE"|"TLS"
  )
)

Request syntax

svc$create_cluster(
  ClusterName = "string",
  NodeType = "string",
  Description = "string",
  ReplicationFactor = 123,
  AvailabilityZones = list(
    "string"
  ),
  SubnetGroupName = "string",
  SecurityGroupIds = list(
    "string"
  ),
  PreferredMaintenanceWindow = "string",
  NotificationTopicArn = "string",
  IamRoleArn = "string",
  ParameterGroupName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  SSESpecification = list(
    Enabled = TRUE|FALSE
  ),
  ClusterEndpointEncryptionType = "NONE"|"TLS"
)