This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_dax_cluster

account_id

Type: STRING

active_nodes

Type: INT32
Provider name: ActiveNodes
Description: The number of nodes in the cluster that are active (i.e., capable of serving requests).

cluster_arn

Type: STRING
Provider name: ClusterArn
Description: The Amazon Resource Name (ARN) that uniquely identifies the cluster.

cluster_discovery_endpoint

Type: STRUCT
Provider name: ClusterDiscoveryEndpoint
Description: The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

  • address
    Type: STRING
    Provider name: Address
    Description: The DNS hostname of the endpoint.
  • port
    Type: INT32
    Provider name: Port
    Description: The port number that applications should use to connect to the endpoint.
  • url
    Type: STRING
    Provider name: URL
    Description: The URL that applications should use to connect to the endpoint. The default ports are 8111 for the “dax” protocol and 9111 for the “daxs” protocol.

cluster_endpoint_encryption_type

Type: STRING
Provider name: ClusterEndpointEncryptionType
Description: The type of encryption supported by the cluster’s endpoint. Values are:

  • NONE for no encryption TLS for Transport Layer Security

cluster_name

Type: STRING
Provider name: ClusterName
Description: The name of the DAX cluster.

description

Type: STRING
Provider name: Description
Description: The description of the cluster.

iam_role_arn

Type: STRING
Provider name: IamRoleArn
Description: 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_ids_to_remove

Type: UNORDERED_LIST_STRING
Provider name: NodeIdsToRemove
Description: A list of nodes to be removed from the cluster.

node_type

Type: STRING
Provider name: NodeType
Description: The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

nodes

Type: UNORDERED_LIST_STRUCT
Provider name: Nodes
Description: A list of nodes that are currently in the cluster.

  • availability_zone
    Type: STRING
    Provider name: AvailabilityZone
    Description: The Availability Zone (AZ) in which the node has been deployed.
  • endpoint
    Type: STRUCT
    Provider name: Endpoint
    Description: The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
    • address
      Type: STRING
      Provider name: Address
      Description: The DNS hostname of the endpoint.
    • port
      Type: INT32
      Provider name: Port
      Description: The port number that applications should use to connect to the endpoint.
    • url
      Type: STRING
      Provider name: URL
      Description: The URL that applications should use to connect to the endpoint. The default ports are 8111 for the “dax” protocol and 9111 for the “daxs” protocol.
  • node_create_time
    Type: TIMESTAMP
    Provider name: NodeCreateTime
    Description: The date and time (in UNIX epoch format) when the node was launched.
  • node_id
    Type: STRING
    Provider name: NodeId
    Description: A system-generated identifier for the node.
  • node_status
    Type: STRING
    Provider name: NodeStatus
    Description: The current status of the node. For example: available.
  • parameter_group_status
    Type: STRING
    Provider name: ParameterGroupStatus
    Description: The status of the parameter group associated with this node. For example, in-sync.

notification_configuration

Type: STRUCT
Provider name: NotificationConfiguration
Description: Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

  • topic_arn
    Type: STRING
    Provider name: TopicArn
    Description: The Amazon Resource Name (ARN) that identifies the topic.
  • topic_status
    Type: STRING
    Provider name: TopicStatus
    Description: The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

parameter_group

Type: STRUCT
Provider name: ParameterGroup
Description: The parameter group being used by nodes in the cluster.

  • node_ids_to_reboot
    Type: UNORDERED_LIST_STRING
    Provider name: NodeIdsToReboot
    Description: The node IDs of one or more nodes to be rebooted.
  • parameter_apply_status
    Type: STRING
    Provider name: ParameterApplyStatus
    Description: The status of parameter updates.
  • parameter_group_name
    Type: STRING
    Provider name: ParameterGroupName
    Description: The name of the parameter group.

preferred_maintenance_window

Type: STRING
Provider name: PreferredMaintenanceWindow
Description: 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_groups

Type: UNORDERED_LIST_STRUCT
Provider name: SecurityGroups
Description: A list of security groups, and the status of each, for the nodes in the cluster.

  • security_group_identifier
    Type: STRING
    Provider name: SecurityGroupIdentifier
    Description: The unique ID for this security group.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of this security group.

sse_description

Type: STRUCT
Provider name: SSEDescription
Description: The description of the server-side encryption status on the specified DAX cluster.

  • status
    Type: STRING
    Provider name: Status
    Description: The current state of server-side encryption:
    • ENABLING - Server-side encryption is being enabled.
    • ENABLED - Server-side encryption is enabled.
    • DISABLING - Server-side encryption is being disabled.
    • DISABLED - Server-side encryption is disabled.

status

Type: STRING
Provider name: Status
Description: The current status of the cluster.

subnet_group

Type: STRING
Provider name: SubnetGroup
Description: The subnet group where the DAX cluster is running.

tags

Type: UNORDERED_LIST_STRING

total_nodes

Type: INT32
Provider name: TotalNodes
Description: The total number of nodes in the cluster.