AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DAX::Cluster

CfnCluster

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

Import

import { CfnCluster } from 'aws-cdk-lib/aws-dax';

Or use the module namespace:

import * as dax from 'aws-cdk-lib/aws-dax';
// dax.CfnCluster

Properties

Configuration passed to the constructor as CfnClusterProps.

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

nodeTypeRequired
string

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

replicationFactorRequired
number

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.

availabilityZonesOptional
string[]

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.

clusterEndpointEncryptionTypeOptional
string

The encryption type of the cluster's endpoint. Available values are:. - `NONE` - The cluster's endpoint will be unencrypted. - `TLS` - The cluster's endpoint will be encrypted with Transport Layer Security, and will provide an x509 certificate for authentication. The default value is `NONE` .

clusterNameOptional
string

The name of the DAX cluster.

descriptionOptional
string

The description of the cluster.

networkTypeOptional
string

The IP address type of the cluster. Values are:. - `ipv4` - IPv4 addresses only - `ipv6` - IPv6 addresses only - `dual_stack` - Both IPv4 and IPv6 addresses

notificationTopicArnOptional
string

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.

parameterGroupNameOptional
string

The parameter group to be associated with the DAX cluster.

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

securityGroupIdsOptional
string[]

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.

sseSpecificationOptional
IResolvable | SSESpecificationProperty

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

subnetGroupNameOptional
string

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.

tagsOptional
any

A set of tags to associate with the DAX cluster.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-dax
CFN TypeAWS::DAX::Cluster
Properties15

Related Constructs

External Links