operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 20 alphanumeric characters or hyphens.

The first character must be a letter.

A name cannot end with a hyphen or contain two consecutive hyphens.

NodeType (string) --

[REQUIRED]

The compute and memory capacity of the nodes in the cluster.

Description (string) -- A description of the cluster.

ReplicationFactor (integer) --

[REQUIRED]

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 2 or more.

Note

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

AvailabilityZones (list) --

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

(string) --

SubnetGroupName (string) --

The name of the subnet group to be used for the replication group.

Warning

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.

SecurityGroupIds (list) --

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.

(string) --

PreferredMaintenanceWindow (string) --

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

sun

mon

tue

wed

thu

fri

sat

Example: sun:05:00-sun:09:00

Note

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

NotificationTopicArn (string) --

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

Note

The Amazon SNS topic owner must be same as the DAX cluster owner.

IamRoleArn (string) --

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

ParameterGroupName (string) -- The parameter group to be associated with the DAX cluster.

Tags (list) --

A set of tags to associate with the DAX cluster.

(dict) --

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .

You cannot backdate the application of a tag.

Key(string) --

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

A description of the DAX cluster, after you have decreased its replication factor.

ClusterName(string) --

The name of the DAX cluster.

Description(string) --

The description of the cluster.

ClusterArn(string) --

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

TotalNodes(integer) --

The total number of nodes in the cluster.

ActiveNodes(integer) --

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available , the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

The descriptions of your DAX clusters, in response to a DescribeClusters request.

(dict) --

Contains all of the attributes of a specific DAX cluster.

ClusterName(string) --

The name of the DAX cluster.

Description(string) --

The description of the cluster.

ClusterArn(string) --

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

TotalNodes(integer) --

The total number of nodes in the cluster.

ActiveNodes(integer) --

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

SourceName (string) -- The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

SourceType (string) -- The event source to retrieve events for. If no value is specified, all events are returned.

StartTime (datetime) -- The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

EndTime (datetime) -- The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Duration (integer) -- The number of minutes' worth of events to retrieve.

MaxResults (integer) --

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

Source (string) -- How the parameter is defined. For example, system denotes a system-defined parameter.

MaxResults (integer) --

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable.

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

NextToken (string) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.

Return type

dict

Returns

Response Syntax

{'Tags':[{'Key':'string','Value':'string'},],'NextToken':'string'}

Response Structure

(dict) --

Tags(list) --

A list of tags currently associated with the DAX cluster.

(dict) --

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .

You cannot backdate the application of a tag.

Key(string) --

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

Value(string) --

The value of the tag. Tag values are case-sensitive and can be null.

NextToken(string) --

If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .

You cannot backdate the application of a tag.

Key(string) --

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

Value(string) --

The value of the tag. Tag values are case-sensitive and can be null.

Return type

dict

Returns

Response Syntax

{'Tags':[{'Key':'string','Value':'string'},]}

Response Structure

(dict) --

Tags(list) --

The list of tags that are associated with the DAX resource.

(dict) --

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .

You cannot backdate the application of a tag.

Key(string) --

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

(string) --

Return type

dict

Returns

Response Syntax

{'Tags':[{'Key':'string','Value':'string'},]}

Response Structure

(dict) --

Tags(list) --

The tag keys that have been removed from the cluster.

(dict) --

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .

You cannot backdate the application of a tag.

Key(string) --

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

Description (string) -- A description of the changes being made to the cluster.

PreferredMaintenanceWindow (string) -- 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.

NotificationTopicArn (string) -- The Amazon Resource Name (ARN) that identifies the topic.

NotificationTopicStatus (string) -- The current state of the topic.

ParameterGroupName (string) -- The name of a parameter group for this cluster.

SecurityGroupIds (list) --

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.

The number of nodes in the cluster that are active (i.e., capable of serving requests).

NodeType(string) --

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

Status(string) --

The current status of the cluster.

ClusterDiscoveryEndpoint(dict) --

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

Address(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeIdsToRemove(list) --

A list of nodes to be removed from the cluster.

(string) --

Nodes(list) --

A list of nodes that are currently in the cluster.

(dict) --

Represents an individual node within a DAX cluster.

NodeId(string) --

A system-generated identifier for the node.

Endpoint(dict) --

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(string) --

The DNS hostname of the endpoint.

Port(integer) --

The port number that applications should use to connect to the endpoint.

NodeCreateTime(datetime) --

The date and time (in UNIX epoch format) when the node was launched.

AvailabilityZone(string) --

The Availability Zone (AZ) in which the node has been deployed.

NodeStatus(string) --

The current status of the node. For example: available .

ParameterGroupStatus(string) --

The status of the parameter group associated with this node. For example, in-sync .

PreferredMaintenanceWindow(string) --

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.

NotificationConfiguration(dict) --

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

TopicArn(string) --

The Amazon Resource Name (ARN) that identifies the topic.

TopicStatus(string) --

The current state of the topic.

SubnetGroup(string) --

The subnet group where the DAX cluster is running.

SecurityGroups(list) --

A list of security groups, and the status of each, for the nodes in the cluster.

(dict) --

An individual VPC security group and its status.

SecurityGroupIdentifier(string) --

The unique ID for this security group.

Status(string) --

The status of this security group.

IamRoleArn(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.