Smaws_Client_DAX.Types
type nonrec subnet = {
subnet_availability_zone : string_ option;
The Availability Zone (AZ) for the subnet.
*)subnet_identifier : string_ option;
The system-assigned identifier for the subnet.
*)}
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
type nonrec subnet_list = subnet list
type nonrec subnet_group = {
subnets : subnet_list option;
A list of subnets associated with the subnet group.
*)vpc_id : string_ option;
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
*)description : string_ option;
The description of the subnet group.
*)subnet_group_name : string_ option;
The name of the subnet group.
*)}
Represents the output of one of the following actions:
type nonrec update_subnet_group_response = {
subnet_group : subnet_group option;
The subnet group that has been modified.
*)}
type nonrec subnet_identifier_list = string_ list
type nonrec update_subnet_group_request = {
subnet_ids : subnet_identifier_list option;
A list of subnet IDs in the subnet group.
*)description : string_ option;
A description of the subnet group.
*)subnet_group_name : string_;
The name of the subnet group.
*)}
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
The requested subnet is being used by another subnet group.
The requested subnet group name does not refer to an existing subnet group.
The specified service linked role (SLR) was not found.
An invalid subnet identifier was specified.
type nonrec parameter_group = {
description : string_ option;
A description of the parameter group.
*)parameter_group_name : string_ option;
The name of the parameter group.
*)}
A named set of parameters that are applied to all of the nodes in a DAX cluster.
type nonrec update_parameter_group_response = {
parameter_group : parameter_group option;
The parameter group that has been modified.
*)}
type nonrec parameter_name_value = {
parameter_value : string_ option;
The value of the parameter.
*)parameter_name : string_ option;
The name of the parameter.
*)}
An individual DAX parameter.
type nonrec parameter_name_value_list = parameter_name_value list
type nonrec update_parameter_group_request = {
parameter_name_values : parameter_name_value_list;
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.
parameter_group_name : string_;
The name of the parameter group.
*)}
The specified parameter group does not exist.
The value for a parameter is invalid.
One or more parameters in a parameter group are in an invalid state.
Two or more incompatible parameters were specified.
type nonrec endpoint = {
ur_l : string_ option;
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.
*)port : integer option;
The port number that applications should use to connect to the endpoint.
*)address : string_ option;
The DNS hostname of the endpoint.
*)}
Represents the information required for client programs to connect to the endpoint for a DAX cluster.
type nonrec node_identifier_list = string_ list
type nonrec node = {
parameter_group_status : string_ option;
The status of the parameter group associated with this node. For example, in-sync
.
node_status : string_ option;
The current status of the node. For example: available
.
availability_zone : string_ option;
The Availability Zone (AZ) in which the node has been deployed.
*)node_create_time : t_stamp option;
The date and time (in UNIX epoch format) when the node was launched.
*)endpoint : endpoint option;
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.
*)node_id : string_ option;
A system-generated identifier for the node.
*)}
Represents an individual node within a DAX cluster.
type nonrec node_list = node list
type nonrec notification_configuration = {
topic_status : string_ option;
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.
*)topic_arn : string_ option;
The Amazon Resource Name (ARN) that identifies the topic.
*)}
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
type nonrec security_group_membership = {
status : string_ option;
The status of this security group.
*)security_group_identifier : string_ option;
The unique ID for this security group.
*)}
An individual VPC security group and its status.
type nonrec security_group_membership_list = security_group_membership list
type nonrec parameter_group_status = {
node_ids_to_reboot : node_identifier_list option;
The node IDs of one or more nodes to be rebooted.
*)parameter_apply_status : string_ option;
The status of parameter updates.
*)parameter_group_name : string_ option;
The name of the parameter group.
*)}
The status of a parameter group.
type nonrec sse_description = {
status : sse_status option;
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.}
The description of the server-side encryption status on the specified DAX cluster.
type nonrec cluster = {
cluster_endpoint_encryption_type : cluster_endpoint_encryption_type option;
The type of encryption supported by the cluster's endpoint. Values are:
NONE
for no encryption
TLS
for Transport Layer Security
sse_description : sse_description option;
The description of the server-side encryption status on the specified DAX cluster.
*)parameter_group : parameter_group_status option;
The parameter group being used by nodes in the cluster.
*)iam_role_arn : string_ option;
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.
*)security_groups : security_group_membership_list option;
A list of security groups, and the status of each, for the nodes in the cluster.
*)subnet_group : string_ option;
The subnet group where the DAX cluster is running.
*)notification_configuration : notification_configuration option;
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
*)preferred_maintenance_window : string_ option;
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.
nodes : node_list option;
A list of nodes that are currently in the cluster.
*)node_ids_to_remove : node_identifier_list option;
A list of nodes to be removed from the cluster.
*)cluster_discovery_endpoint : endpoint option;
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.
*)status : string_ option;
The current status of the cluster.
*)node_type : string_ option;
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
*)active_nodes : integer_optional option;
The number of nodes in the cluster that are active (i.e., capable of serving requests).
*)total_nodes : integer_optional option;
The total number of nodes in the cluster.
*)cluster_arn : string_ option;
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*)description : string_ option;
The description of the cluster.
*)cluster_name : string_ option;
The name of the DAX cluster.
*)}
Contains all of the attributes of a specific DAX cluster.
type nonrec update_cluster_response = {
cluster : cluster option;
A description of the DAX cluster, after it has been modified.
*)}
type nonrec security_group_identifier_list = string_ list
type nonrec update_cluster_request = {
security_group_ids : security_group_identifier_list option;
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.
*)parameter_group_name : string_ option;
The name of a parameter group for this cluster.
*)notification_topic_status : string_ option;
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.
*)notification_topic_arn : string_ option;
The Amazon Resource Name (ARN) that identifies the topic.
*)preferred_maintenance_window : string_ option;
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.
description : string_ option;
A description of the changes being made to the cluster.
*)cluster_name : string_;
The name of the DAX cluster to be modified.
*)}
The requested DAX cluster is not in the available state.
The requested cluster ID does not refer to an existing DAX cluster.
type nonrec tag = {
value : string_ option;
The value of the tag. Tag values are case-sensitive and can be null.
*)key : string_ option;
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 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.
type nonrec tag_list = tag list
type nonrec key_list = string_ list
The tag does not exist.
The Amazon Resource Name (ARN) supplied in the request is not valid.
type nonrec tag_resource_request = {
resource_name : string_;
The name of the DAX resource to which tags should be added.
*)}
You have exceeded the maximum number of tags for this DAX cluster.
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
type nonrec subnet_group_name_list = string_ list
type nonrec subnet_group_list = subnet_group list
The specified subnet group is currently in use.
The specified subnet group already exists.
type nonrec sse_specification = {
enabled : sse_enabled;
Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
*)}
Represents the settings used to enable server-side encryption.
type nonrec reboot_node_response = {
cluster : cluster option;
A description of the DAX cluster after a node has been rebooted.
*)}
None of the nodes in the cluster have the given node ID.
type nonrec node_type_specific_value = {
value : string_ option;
The parameter value for this node type.
*)node_type : string_ option;
A node type to which the parameter value applies.
*)}
Represents a parameter value that is applicable to a particular node type.
type nonrec node_type_specific_value_list = node_type_specific_value list
type nonrec parameter = {
change_type : change_type option;
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.
is_modifiable : is_modifiable option;
Whether the customer is allowed to modify the parameter.
*)allowed_values : string_ option;
A range of values within which the parameter can be set.
*)data_type : string_ option;
The data type of the parameter. For example, integer
:
source : string_ option;
How the parameter is defined. For example, system
denotes a system-defined parameter.
description : string_ option;
A description of the parameter
*)node_type_specific_values : node_type_specific_value_list option;
A list of node types, and specific parameter values for each node.
*)parameter_value : string_ option;
The value for the parameter.
*)parameter_type : parameter_type option;
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
*)parameter_name : string_ option;
The name of the parameter.
*)}
Describes an individual setting that controls some aspect of DAX behavior.
type nonrec parameter_list = parameter list
You have attempted to exceed the maximum number of parameter groups.
type nonrec parameter_group_name_list = string_ list
type nonrec parameter_group_list = parameter_group list
The specified parameter group already exists.
You have attempted to exceed the maximum number of nodes for your AWS account.
You have attempted to exceed the maximum number of nodes for a DAX cluster.
The VPC network is in an invalid state.
There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).
type nonrec increase_replication_factor_response = {
cluster : cluster option;
A description of the DAX cluster. with its new replication factor.
*)}
type nonrec availability_zone_list = string_ list
type nonrec increase_replication_factor_request = {
availability_zones : availability_zone_list option;
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.
*)new_replication_factor : integer;
The new number of nodes for the DAX cluster.
*)cluster_name : string_;
The name of the DAX cluster that will receive additional nodes.
*)}
type nonrec event = {
date : t_stamp option;
The date and time when the event occurred.
*)message : string_ option;
A user-defined message associated with the event.
*)source_type : source_type option;
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
*)source_name : string_ option;
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
*)}
Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.
type nonrec event_list = event list
type nonrec describe_subnet_groups_response = {
subnet_groups : subnet_group_list option;
An array of subnet groups. Each element in the array represents a single subnet group.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec describe_subnet_groups_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
subnet_group_names : subnet_group_name_list option;
The name of the subnet group.
*)}
type nonrec describe_parameters_response = {
parameters : parameter_list option;
A list of parameters within a parameter group. Each element in the list represents one parameter.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec describe_parameters_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
source : string_ option;
How the parameter is defined. For example, system
denotes a system-defined parameter.
parameter_group_name : string_;
The name of the parameter group.
*)}
type nonrec describe_parameter_groups_response = {
parameter_groups : parameter_group_list option;
An array of parameter groups. Each element in the array represents one parameter group.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec describe_parameter_groups_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
parameter_group_names : parameter_group_name_list option;
The names of the parameter groups.
*)}
type nonrec describe_events_response = {
events : event_list option;
An array of events. Each element in the array represents one event.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec describe_events_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
duration : integer_optional option;
The number of minutes' worth of events to retrieve.
*)end_time : t_stamp option;
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*)start_time : t_stamp option;
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*)source_type : source_type option;
The event source to retrieve events for. If no value is specified, all events are returned.
*)source_name : string_ option;
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
*)}
type nonrec describe_default_parameters_response = {
parameters : parameter_list option;
A list of parameters. Each element in the list represents one parameter.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec describe_default_parameters_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
}
type nonrec cluster_list = cluster list
type nonrec describe_clusters_response = {
clusters : cluster_list option;
The descriptions of your DAX clusters, in response to a DescribeClusters request.
*)next_token : string_ option;
Provides an identifier to allow retrieval of paginated results.
*)}
type nonrec cluster_name_list = string_ list
type nonrec describe_clusters_request = {
next_token : string_ option;
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
.
max_results : integer_optional option;
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.
cluster_names : cluster_name_list option;
The names of the DAX clusters being described.
*)}
type nonrec delete_subnet_group_response = {
deletion_message : string_ option;
A user-specified message for this action (i.e., a reason for deleting the subnet group).
*)}
type nonrec delete_subnet_group_request = {
subnet_group_name : string_;
The name of the subnet group to delete.
*)}
type nonrec delete_parameter_group_response = {
deletion_message : string_ option;
A user-specified message for this action (i.e., a reason for deleting the parameter group).
*)}
type nonrec delete_parameter_group_request = {
parameter_group_name : string_;
The name of the parameter group to delete.
*)}
type nonrec delete_cluster_response = {
cluster : cluster option;
A description of the DAX cluster that is being deleted.
*)}
type nonrec delete_cluster_request = {
cluster_name : string_;
The name of the cluster to be deleted.
*)}
type nonrec decrease_replication_factor_response = {
cluster : cluster option;
A description of the DAX cluster, after you have decreased its replication factor.
*)}
type nonrec decrease_replication_factor_request = {
node_ids_to_remove : node_identifier_list option;
The unique identifiers of the nodes to be removed from the cluster.
*)availability_zones : availability_zone_list option;
The Availability Zone(s) from which to remove nodes.
*)new_replication_factor : integer;
The new number of nodes for the DAX cluster.
*)cluster_name : string_;
The name of the DAX cluster from which you want to remove nodes.
*)}
type nonrec create_subnet_group_response = {
subnet_group : subnet_group option;
Represents the output of a CreateSubnetGroup operation.
*)}
type nonrec create_subnet_group_request = {
subnet_ids : subnet_identifier_list;
A list of VPC subnet IDs for the subnet group.
*)description : string_ option;
A description for the subnet group
*)subnet_group_name : string_;
A name for the subnet group. This value is stored as a lowercase string.
*)}
type nonrec create_parameter_group_response = {
parameter_group : parameter_group option;
Represents the output of a CreateParameterGroup action.
*)}
type nonrec create_cluster_response = {
cluster : cluster option;
A description of the DAX cluster that you have created.
*)}
type nonrec create_cluster_request = {
cluster_endpoint_encryption_type : cluster_endpoint_encryption_type option;
The type of encryption the cluster's endpoint should support. Values are:
NONE
for no encryptionTLS
for Transport Layer Securitysse_specification : sse_specification option;
Represents the settings used to enable server-side encryption on the cluster.
*)parameter_group_name : string_ option;
The parameter group to be associated with the DAX cluster.
*)iam_role_arn : 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.
*)notification_topic_arn : string_ option;
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.
*)preferred_maintenance_window : string_ option;
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.
*)security_group_ids : security_group_identifier_list option;
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.
*)subnet_group_name : string_ option;
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.
*)availability_zones : availability_zone_list option;
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.
replication_factor : integer;
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.
*)description : string_ option;
A description of the cluster.
*)node_type : string_;
The compute and memory capacity of the nodes in the cluster.
*)cluster_name : string_;
The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
}
You have attempted to exceed the maximum number of DAX clusters for your AWS account.
You already have a DAX cluster with the given identifier.