CfnClusterProps

class aws_cdk.aws_dax.CfnClusterProps(*, iam_role_arn, node_type, replication_factor, availability_zones=None, cluster_endpoint_encryption_type=None, cluster_name=None, description=None, notification_topic_arn=None, parameter_group_name=None, preferred_maintenance_window=None, security_group_ids=None, sse_specification=None, subnet_group_name=None, tags=None)

Bases: object

Properties for defining a CfnCluster.

Parameters
  • iam_role_arn (str) – 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.

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

  • replication_factor (Union[int, float]) – 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 . .. epigraph:: AWS recommends that you have at least two read replicas per cluster.

  • availability_zones (Optional[Sequence[str]]) – 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.

  • cluster_endpoint_encryption_type (Optional[str]) – 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 .

  • cluster_name (Optional[str]) – The name of the DAX cluster.

  • description (Optional[str]) – The description of the cluster.

  • notification_topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. .. epigraph:: The Amazon SNS topic owner must be same as the DAX cluster owner.

  • parameter_group_name (Optional[str]) – The parameter group to be associated with the DAX cluster.

  • preferred_maintenance_window (Optional[str]) – 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.

  • security_group_ids (Optional[Sequence[str]]) – 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.

  • sse_specification (Union[SSESpecificationProperty, Dict[str, Any], IResolvable, None]) – Represents the settings used to enable server-side encryption on the cluster.

  • subnet_group_name (Optional[str]) – The name of the subnet group to be used for the replication group. .. epigraph:: 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 (Optional[Any]) – A set of tags to associate with the DAX cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_dax as dax

# tags: Any

cfn_cluster_props = dax.CfnClusterProps(
    iam_role_arn="iamRoleArn",
    node_type="nodeType",
    replication_factor=123,

    # the properties below are optional
    availability_zones=["availabilityZones"],
    cluster_endpoint_encryption_type="clusterEndpointEncryptionType",
    cluster_name="clusterName",
    description="description",
    notification_topic_arn="notificationTopicArn",
    parameter_group_name="parameterGroupName",
    preferred_maintenance_window="preferredMaintenanceWindow",
    security_group_ids=["securityGroupIds"],
    sse_specification=dax.CfnCluster.SSESpecificationProperty(
        sse_enabled=False
    ),
    subnet_group_name="subnetGroupName",
    tags=tags
)

Attributes

availability_zones

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-availabilityzones

Return type

Optional[List[str]]

cluster_endpoint_encryption_type

.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clusterendpointencryptiontype

Type

The encryption type of the cluster’s endpoint. Available values are

Return type

Optional[str]

cluster_name

The name of the DAX cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-clustername

Return type

Optional[str]

description

The description of the cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-description

Return type

Optional[str]

iam_role_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-iamrolearn

Return type

str

node_type

The node type for the nodes in the cluster.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-nodetype

Return type

str

notification_topic_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-notificationtopicarn

Return type

Optional[str]

parameter_group_name

The parameter group to be associated with the DAX cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-parametergroupname

Return type

Optional[str]

preferred_maintenance_window

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-preferredmaintenancewindow

Return type

Optional[str]

replication_factor

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

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-replicationfactor

Return type

Union[int, float]

security_group_ids

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-securitygroupids

Return type

Optional[List[str]]

sse_specification

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-ssespecification

Return type

Union[SSESpecificationProperty, IResolvable, None]

subnet_group_name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-subnetgroupname

Return type

Optional[str]

tags

A set of tags to associate with the DAX cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-cluster.html#cfn-dax-cluster-tags

Return type

Any