On this page
aws_dax_cluster
Provides a DAX Cluster resource.
Example Usage
resource "aws_dax_cluster" "bar" {
cluster_id = "cluster-example"
iam_role_arn = "${data.aws_iam_role.example.arn}"
node_type = "dax.r3.large"
replication_factor = 1
}
Argument Reference
The following arguments are supported:
cluster_name
– (Required) Group identifier. DAX converts this name to lowercaseiam_role_arn
- (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 behalfnode_type
– (Required) The compute and memory capacity of the nodes. See Nodes for supported node typesreplication_factor
– (Required) The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicasavailability_zones
- (Optional) List of Availability Zones in which the nodes will be createddescription
– (Optional) Description for the clusternotification_topic_arn
– (Optional) An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example:arn:aws:sns:us-east-1:012345678999:my_sns_topic
parameter_group_name
– (Optional) Name of the parameter group to associate with this DAX clustermaintenance_window
– (Optional) Specifies the weekly time range for when maintenance on the cluster is performed. The format isddd:hh24:mi-ddd:hh24:mi
(24H Clock UTC). The minimum maintenance window is a 60 minute period. Example:sun:05:00-sun:09:00
security_group_ids
– (Optional) One or more VPC security groups associated with the clustersubnet_group_name
– (Optional) Name of the subnet group to be used for the clustertags
- (Optional) A mapping of tags to assign to the resource
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- The ARN of the DAX clusternodes
- List of node objects includingid
,address
,port
andavailability_zone
. Referenceable e.g. as${aws_dax_cluster.test.nodes.0.address}
configuration_endpoint
- The configuration endpoint for this DAX cluster, consisting of a DNS name and a port numbercluster_address
- The DNS name of the DAX cluster without the port appendedport
- The port used by the configuration endpoint
Timeouts
aws_dax_cluster
provides the following Timeouts configuration options:
create
- (Default45 minutes
) Used for creating a DAX clusterupdate
- (Default45 minutes
) Used for cluster modificationsdelete
- (Default90 minutes
) Used for destroying a DAX cluster
Import
DAX Clusters can be imported using the cluster_id
, e.g.
$ terraform import aws_dax_cluster.my_cluster my_cluster
© 2018 HashiCorp
Licensed under the MPL 2.0 License.
https://www.terraform.io/docs/providers/aws/r/dax_cluster.html