AWS::DAX::ClusterCreates a DAX cluster. All nodes in the cluster run the same DAX caching software.
import { CfnCluster } from 'aws-cdk-lib/aws-dax';Or use the module namespace:
import * as dax from 'aws-cdk-lib/aws-dax';
// dax.CfnClusterConfiguration passed to the constructor as CfnClusterProps.
iamRoleArnRequiredstringA 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.
nodeTypeRequiredstringThe node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
replicationFactorRequirednumberThe 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.
availabilityZonesOptionalstring[]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.
clusterEndpointEncryptionTypeOptionalstringThe 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` .
clusterNameOptionalstringThe name of the DAX cluster.
descriptionOptionalstringThe description of the cluster.
networkTypeOptionalstringThe IP address type of the cluster. Values are:. - `ipv4` - IPv4 addresses only - `ipv6` - IPv6 addresses only - `dual_stack` - Both IPv4 and IPv6 addresses
notificationTopicArnOptionalstringThe 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.
parameterGroupNameOptionalstringThe parameter group to be associated with the DAX cluster.
preferredMaintenanceWindowOptionalstringA 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.
securityGroupIdsOptionalstring[]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.
sseSpecificationOptionalIResolvable | SSESpecificationPropertyRepresents the settings used to enable server-side encryption on the cluster.
subnetGroupNameOptionalstringThe 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.
tagsOptionalanyA set of tags to associate with the DAX cluster.
This L1 construct maps directly to the following CloudFormation resource type.
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-daxAWS::DAX::Cluster