Class CreateClusterCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { DAXClient, CreateClusterCommand } from "@aws-sdk/client-dax"; // ES Modules import
// const { DAXClient, CreateClusterCommand } = require("@aws-sdk/client-dax"); // CommonJS import
const client = new DAXClient(config);
const input = { // CreateClusterRequest
  ClusterName: "STRING_VALUE", // required
  NodeType: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  ReplicationFactor: Number("int"), // required
  AvailabilityZones: [ // AvailabilityZoneList
    "STRING_VALUE",
  ],
  SubnetGroupName: "STRING_VALUE",
  SecurityGroupIds: [ // SecurityGroupIdentifierList
    "STRING_VALUE",
  ],
  PreferredMaintenanceWindow: "STRING_VALUE",
  NotificationTopicArn: "STRING_VALUE",
  IamRoleArn: "STRING_VALUE", // required
  ParameterGroupName: "STRING_VALUE",
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  SSESpecification: { // SSESpecification
    Enabled: true || false, // required
  },
  ClusterEndpointEncryptionType: "NONE" || "TLS",
};
const command = new CreateClusterCommand(input);
const response = await client.send(command);
// { // CreateClusterResponse
//   Cluster: { // Cluster
//     ClusterName: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     ClusterArn: "STRING_VALUE",
//     TotalNodes: Number("int"),
//     ActiveNodes: Number("int"),
//     NodeType: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     ClusterDiscoveryEndpoint: { // Endpoint
//       Address: "STRING_VALUE",
//       Port: Number("int"),
//       URL: "STRING_VALUE",
//     },
//     NodeIdsToRemove: [ // NodeIdentifierList
//       "STRING_VALUE",
//     ],
//     Nodes: [ // NodeList
//       { // Node
//         NodeId: "STRING_VALUE",
//         Endpoint: {
//           Address: "STRING_VALUE",
//           Port: Number("int"),
//           URL: "STRING_VALUE",
//         },
//         NodeCreateTime: new Date("TIMESTAMP"),
//         AvailabilityZone: "STRING_VALUE",
//         NodeStatus: "STRING_VALUE",
//         ParameterGroupStatus: "STRING_VALUE",
//       },
//     ],
//     PreferredMaintenanceWindow: "STRING_VALUE",
//     NotificationConfiguration: { // NotificationConfiguration
//       TopicArn: "STRING_VALUE",
//       TopicStatus: "STRING_VALUE",
//     },
//     SubnetGroup: "STRING_VALUE",
//     SecurityGroups: [ // SecurityGroupMembershipList
//       { // SecurityGroupMembership
//         SecurityGroupIdentifier: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     IamRoleArn: "STRING_VALUE",
//     ParameterGroup: { // ParameterGroupStatus
//       ParameterGroupName: "STRING_VALUE",
//       ParameterApplyStatus: "STRING_VALUE",
//       NodeIdsToReboot: [
//         "STRING_VALUE",
//       ],
//     },
//     SSEDescription: { // SSEDescription
//       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
//     },
//     ClusterEndpointEncryptionType: "NONE" || "TLS",
//   },
// };

Param

CreateClusterCommandInput

Returns

CreateClusterCommandOutput

See

• CreateClusterCommandInput for command's input shape.
• CreateClusterCommandOutput for command's response shape.
• config for DAXClient's config shape.

Throws

ClusterAlreadyExistsFault (client fault)

You already have a DAX cluster with the given identifier.

Throws

ClusterQuotaForCustomerExceededFault (client fault)

You have attempted to exceed the maximum number of DAX clusters for your AWS account.

Throws

InsufficientClusterCapacityFault (client fault)

There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

Throws

InvalidClusterStateFault (client fault)

The requested DAX cluster is not in the available state.

Throws

InvalidParameterCombinationException (client fault)

Two or more incompatible parameters were specified.

Throws

InvalidParameterGroupStateFault (client fault)

One or more parameters in a parameter group are in an invalid state.

Throws

InvalidParameterValueException (client fault)

The value for a parameter is invalid.

Throws

InvalidVPCNetworkStateFault (client fault)

The VPC network is in an invalid state.

Throws

NodeQuotaForClusterExceededFault (client fault)

You have attempted to exceed the maximum number of nodes for a DAX cluster.

Throws

NodeQuotaForCustomerExceededFault (client fault)

You have attempted to exceed the maximum number of nodes for your AWS account.

Throws

ParameterGroupNotFoundFault (client fault)

The specified parameter group does not exist.

Throws

ServiceLinkedRoleNotFoundFault (client fault)

The specified service linked role (SLR) was not found.

Throws

ServiceQuotaExceededException (client fault)

You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.

Throws

SubnetGroupNotFoundFault (client fault)

The requested subnet group name does not refer to an existing subnet group.

Throws

TagQuotaPerResourceExceeded (client fault)

You have exceeded the maximum number of tags for this DAX cluster.

Throws

DAXServiceException

Base exception class for all service exceptions from DAX service.