interface CfnClusterProps

Language	Type name
.NET	`Amazon.CDK.AWS.DAX.CfnClusterProps`
Java	`software.amazon.awscdk.services.dax.CfnClusterProps`
Python	`aws_cdk.aws_dax.CfnClusterProps`
TypeScript	`@aws-cdk/aws-dax` » `CfnClusterProps`

Properties for defining a CfnCluster.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as dax from '@aws-cdk/aws-dax';

declare const tags: any;
const cfnClusterProps: dax.CfnClusterProps = {
  iamRoleArn: 'iamRoleArn',
  nodeType: 'nodeType',
  replicationFactor: 123,

  // the properties below are optional
  availabilityZones: ['availabilityZones'],
  clusterEndpointEncryptionType: 'clusterEndpointEncryptionType',
  clusterName: 'clusterName',
  description: 'description',
  notificationTopicArn: 'notificationTopicArn',
  parameterGroupName: 'parameterGroupName',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  securityGroupIds: ['securityGroupIds'],
  sseSpecification: {
    sseEnabled: false,
  },
  subnetGroupName: 'subnetGroupName',
  tags: tags,
};

Properties

Name	Type	Description
iamRoleArn	`string`	A valid Amazon Resource Name (ARN) that identifies an IAM role.
nodeType	`string`	The node type for the nodes in the cluster.
replicationFactor	`number`	The number of nodes in the DAX cluster.
availabilityZones?	`string[]`	The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
clusterEndpointEncryptionType?	`string`	The encryption type of the cluster's endpoint. Available values are:.
clusterName?	`string`	The name of the DAX cluster.
description?	`string`	The description of the cluster.
notificationTopicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
parameterGroupName?	`string`	The parameter group to be associated with the DAX cluster.
preferredMaintenanceWindow?	`string`	A range of time when maintenance of DAX cluster software will be performed.
securityGroupIds?	`string[]`	A list of security group IDs to be assigned to each node in the DAX cluster.
sseSpecification?	`SSESpecificationProperty` `\|` `IResolvable`	Represents the settings used to enable server-side encryption on the cluster.
subnetGroupName?	`string`	The name of the subnet group to be used for the replication group.
tags?	`any`	A set of tags to associate with the DAX cluster.

iamRoleArn

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

nodeType

Type: string

The node type for the nodes in the cluster.

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

replicationFactor

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

availabilityZones?

Type: string[] (optional)

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.

clusterEndpointEncryptionType?

Type: string (optional)

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 .

clusterName?

Type: string (optional)

The name of the DAX cluster.

description?

Type: string (optional)

The description of the cluster.

notificationTopicArn?

Type: string (optional)

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.

parameterGroupName?

Type: string (optional)

The parameter group to be associated with the DAX cluster.

preferredMaintenanceWindow?

Type: string (optional)

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.

securityGroupIds?

Type: string[] (optional)

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.

sseSpecification?

Type: SSESpecificationProperty | IResolvable (optional)

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

subnetGroupName?

Type: string (optional)

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.

tags?

Type: any (optional)

A set of tags to associate with the DAX cluster.