Skip to content

Resource: awsDaxCluster

Provides a DAX Cluster resource.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.daxCluster.DaxCluster(this, "bar", {
  clusterName: "cluster-example",
  iamRoleArn: "${data.aws_iam_role.example.arn}",
  nodeType: "dax.r4.large",
  replicationFactor: 1,
});

Argument Reference

The following arguments are supported:

  • clusterEndpointEncryptionType – (Optional) The type of encryption the cluster's endpoint should support. Valid values are: none and tls. Default value is none.

  • clusterName – (Required) Group identifier. DAX converts this name to lowercase

  • iamRoleArn - (Required) 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 – (Required) The compute and memory capacity of the nodes. See Nodes for supported node types

  • replicationFactor – (Required) The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas

  • availabilityZones - (Optional) List of Availability Zones in which the nodes will be created

  • description – (Optional) Description for the cluster

  • notificationTopicArn – (Optional) An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example: arn:aws:sns:usEast1:012345678999:mySnsTopic

  • parameterGroupName – (Optional) Name of the parameter group to associate with this DAX cluster

  • maintenanceWindow – (Optional) Specifies the weekly time range for when maintenance on the cluster is performed. The format is ddd:hh24:miDdd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:05:00Sun:09:00

  • securityGroupIds – (Optional) One or more VPC security groups associated with the cluster

  • serverSideEncryption - (Optional) Encrypt at rest options

  • subnetGroupName – (Optional) Name of the subnet group to be used for the cluster

  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The serverSideEncryption object supports the following:

  • enabled - (Optional) Whether to enable encryption at rest. Defaults to false.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - The ARN of the DAX cluster

  • nodes - List of node objects including id, address, port and availabilityZone. Referenceable e.g., as ${awsDaxClusterTestNodes0Address}

  • configurationEndpoint - The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number

  • clusterAddress - The DNS name of the DAX cluster without the port appended

  • port - The port used by the configuration endpoint

  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Timeouts

Configuration options:

  • create - (Default 45M)
  • update - (Default 45M)
  • delete - (Default 90M)

Import

DAX Clusters can be imported using the clusterName, e.g.,

$ terraform import aws_dax_cluster.my_cluster my_cluster