String clusterName
The name of the DAX cluster.
String description
The description of the cluster.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Integer totalNodes
The total number of nodes in the cluster.
Integer activeNodes
The number of nodes in the cluster that are active (i.e., capable of serving requests).
String nodeType
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
String status
The current status of the cluster.
Endpoint clusterDiscoveryEndpoint
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.
List<E> nodeIdsToRemove
A list of nodes to be removed from the cluster.
List<E> nodes
A list of nodes that are currently in the cluster.
String preferredMaintenanceWindow
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 notificationConfiguration
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
String subnetGroup
The subnet group where the DAX cluster is running.
List<E> securityGroups
A list of security groups, and the status of each, for the nodes in the cluster.
String iamRoleArn
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.
ParameterGroupStatus parameterGroup
The parameter group being used by nodes in the cluster.
SSEDescription sSEDescription
The description of the server-side encryption status on the specified DAX cluster.
String clusterEndpointEncryptionType
The type of encryption supported by the cluster's endpoint. Values are:
NONE for no encryption
TLS for Transport Layer Security
String clusterName
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.
String nodeType
The compute and memory capacity of the nodes in the cluster.
String description
A description of the cluster.
Integer replicationFactor
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.
AWS recommends that you have at least two read replicas per cluster.
List<E> availabilityZones
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.
String subnetGroupName
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.
List<E> securityGroupIds
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
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
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.
String notificationTopicArn
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.
String iamRoleArn
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.
String parameterGroupName
The parameter group to be associated with the DAX cluster.
List<E> tags
A set of tags to associate with the DAX cluster.
SSESpecification sSESpecification
Represents the settings used to enable server-side encryption on the cluster.
String clusterEndpointEncryptionType
The type of encryption the cluster's endpoint should support. Values are:
NONE for no encryption
TLS for Transport Layer Security
Cluster cluster
A description of the DAX cluster that you have created.
ParameterGroup parameterGroup
Represents the output of a CreateParameterGroup action.
SubnetGroup subnetGroup
Represents the output of a CreateSubnetGroup operation.
String clusterName
The name of the DAX cluster from which you want to remove nodes.
Integer newReplicationFactor
The new number of nodes for the DAX cluster.
List<E> availabilityZones
The Availability Zone(s) from which to remove nodes.
List<E> nodeIdsToRemove
The unique identifiers of the nodes to be removed from the cluster.
Cluster cluster
A description of the DAX cluster, after you have decreased its replication factor.
String clusterName
The name of the cluster to be deleted.
Cluster cluster
A description of the DAX cluster that is being deleted.
String parameterGroupName
The name of the parameter group to delete.
String deletionMessage
A user-specified message for this action (i.e., a reason for deleting the parameter group).
String subnetGroupName
The name of the subnet group to delete.
String deletionMessage
A user-specified message for this action (i.e., a reason for deleting the subnet group).
List<E> clusterNames
The names of the DAX clusters being described.
Integer 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.
String nextToken
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.
Integer 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.
String nextToken
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.
String sourceName
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Integer duration
The number of minutes' worth of events to retrieve.
Integer 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.
String nextToken
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.
List<E> parameterGroupNames
The names of the parameter groups.
Integer 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.
String nextToken
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.
String parameterGroupName
The name of the parameter group.
String source
How the parameter is defined. For example, system denotes a system-defined parameter.
Integer 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.
String nextToken
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.
List<E> subnetGroupNames
The name of the subnet group.
Integer 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.
String nextToken
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.
String address
The DNS hostname of the endpoint.
Integer port
The port number that applications should use to connect to the endpoint.
String uRL
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.
String sourceName
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
String sourceType
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
String message
A user-defined message associated with the event.
Date date
The date and time when the event occurred.
String clusterName
The name of the DAX cluster that will receive additional nodes.
Integer newReplicationFactor
The new number of nodes for the DAX cluster.
List<E> availabilityZones
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.
Cluster cluster
A description of the DAX cluster. with its new replication factor.
String resourceName
The name of the DAX resource to which the tags belong.
String nextToken
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.
String nodeId
A system-generated identifier for the node.
Endpoint endpoint
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.
Date nodeCreateTime
The date and time (in UNIX epoch format) when the node was launched.
String availabilityZone
The Availability Zone (AZ) in which the node has been deployed.
String nodeStatus
The current status of the node. For example: available.
String parameterGroupStatus
The status of the parameter group associated with this node. For example, in-sync.
String parameterName
The name of the parameter.
String parameterType
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
String parameterValue
The value for the parameter.
List<E> nodeTypeSpecificValues
A list of node types, and specific parameter values for each node.
String description
A description of the parameter
String source
How the parameter is defined. For example, system denotes a system-defined parameter.
String dataType
The data type of the parameter. For example, integer:
String allowedValues
A range of values within which the parameter can be set.
String isModifiable
Whether the customer is allowed to modify the parameter.
String changeType
The conditions under which changes to this parameter can be applied. For example, requires-reboot
indicates that a new value for this parameter will only take effect if a node is rebooted.
Cluster cluster
A description of the DAX cluster after a node has been rebooted.
String status
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.
Boolean enabled
Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
String subnetGroupName
The name of the subnet group.
String description
The description of the subnet group.
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
List<E> subnets
A list of subnets associated with the subnet group.
String key
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.
String value
The value of the tag. Tag values are case-sensitive and can be null.
String clusterName
The name of the DAX cluster to be modified.
String description
A description of the changes being made to the cluster.
String preferredMaintenanceWindow
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.
String notificationTopicArn
The Amazon Resource Name (ARN) that identifies the topic.
String notificationTopicStatus
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.
String parameterGroupName
The name of a parameter group for this cluster.
List<E> securityGroupIds
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.
Cluster cluster
A description of the DAX cluster, after it has been modified.
String parameterGroupName
The name of the parameter group.
List<E> parameterNameValues
An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.
record-ttl-millis and query-ttl-millis are the only supported parameter names. For more
details, see Configuring TTL Settings.
ParameterGroup parameterGroup
The parameter group that has been modified.
SubnetGroup subnetGroup
The subnet group that has been modified.
Copyright © 2023. All rights reserved.