You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DAX::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon DynamoDB Accelerator (DAX). To construct a client, you need to configure a :region and :credentials.

dax = Aws::DAX::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::DAX::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::DAX::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_cluster(options = {}) ⇒ Types::CreateClusterResponse

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  cluster_name: "String", # required
  node_type: "String", # required
  description: "String",
  replication_factor: 1, # required
  availability_zones: ["String"],
  subnet_group_name: "String",
  security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  iam_role_arn: "String", # required
  parameter_group_name: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  sse_specification: {
    enabled: false, # required
  },
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    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.

  • :node_type (required, String)

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

  • :description (String)

    A description of the cluster.

  • :replication_factor (required, 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.

  • :availability_zones (Array<String>)

    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.

  • :subnet_group_name (String)

    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.

  • :security_group_ids (Array<String>)

    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.

  • :preferred_maintenance_window (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

    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.

  • :notification_topic_arn (String)

    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.

  • :iam_role_arn (required, 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.

  • :parameter_group_name (String)

    The parameter group to be associated with the DAX cluster.

  • :tags (Array<Types::Tag>)

    A set of tags to associate with the DAX cluster.

  • :sse_specification (Types::SSESpecification)

    Represents the settings used to enable server-side encryption on the cluster.

Returns:

See Also:

#create_parameter_group(options = {}) ⇒ Types::CreateParameterGroupResponse

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.

Examples:

Request syntax with placeholder values


resp = client.create_parameter_group({
  parameter_group_name: "String", # required
  description: "String",
})

Response structure


resp.parameter_group.parameter_group_name #=> String
resp.parameter_group.description #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group to apply to all of the clusters in this replication group.

  • :description (String)

    A description of the parameter group.

Returns:

See Also:

#create_subnet_group(options = {}) ⇒ Types::CreateSubnetGroupResponse

Creates a new subnet group.

Examples:

Request syntax with placeholder values


resp = client.create_subnet_group({
  subnet_group_name: "String", # required
  description: "String",
  subnet_ids: ["String"], # required
})

Response structure


resp.subnet_group.subnet_group_name #=> String
resp.subnet_group.description #=> String
resp.subnet_group.vpc_id #=> String
resp.subnet_group.subnets #=> Array
resp.subnet_group.subnets[0].subnet_identifier #=> String
resp.subnet_group.subnets[0].subnet_availability_zone #=> String

Options Hash (options):

  • :subnet_group_name (required, String)

    A name for the subnet group. This value is stored as a lowercase string.

  • :description (String)

    A description for the subnet group

  • :subnet_ids (required, Array<String>)

    A list of VPC subnet IDs for the subnet group.

Returns:

See Also:

#decrease_replication_factor(options = {}) ⇒ Types::DecreaseReplicationFactorResponse

Removes one or more nodes from a DAX cluster.

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

Examples:

Request syntax with placeholder values


resp = client.decrease_replication_factor({
  cluster_name: "String", # required
  new_replication_factor: 1, # required
  availability_zones: ["String"],
  node_ids_to_remove: ["String"],
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    The name of the DAX cluster from which you want to remove nodes.

  • :new_replication_factor (required, Integer)

    The new number of nodes for the DAX cluster.

  • :availability_zones (Array<String>)

    The Availability Zone(s) from which to remove nodes.

  • :node_ids_to_remove (Array<String>)

    The unique identifiers of the nodes to be removed from the cluster.

Returns:

See Also:

#delete_cluster(options = {}) ⇒ Types::DeleteClusterResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster_name: "String", # required
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    The name of the cluster to be deleted.

Returns:

See Also:

#delete_parameter_group(options = {}) ⇒ Types::DeleteParameterGroupResponse

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

Examples:

Request syntax with placeholder values


resp = client.delete_parameter_group({
  parameter_group_name: "String", # required
})

Response structure


resp.deletion_message #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group to delete.

Returns:

See Also:

#delete_subnet_group(options = {}) ⇒ Types::DeleteSubnetGroupResponse

Deletes a subnet group.

You cannot delete a subnet group if it is associated with any DAX clusters.

Examples:

Request syntax with placeholder values


resp = client.delete_subnet_group({
  subnet_group_name: "String", # required
})

Response structure


resp.deletion_message #=> String

Options Hash (options):

  • :subnet_group_name (required, String)

    The name of the subnet group to delete.

Returns:

See Also:

#describe_clusters(options = {}) ⇒ Types::DescribeClustersResponse

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.

Examples:

Request syntax with placeholder values


resp = client.describe_clusters({
  cluster_names: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.clusters #=> Array
resp.clusters[0].cluster_name #=> String
resp.clusters[0].description #=> String
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].total_nodes #=> Integer
resp.clusters[0].active_nodes #=> Integer
resp.clusters[0].node_type #=> String
resp.clusters[0].status #=> String
resp.clusters[0].cluster_discovery_endpoint.address #=> String
resp.clusters[0].cluster_discovery_endpoint.port #=> Integer
resp.clusters[0].node_ids_to_remove #=> Array
resp.clusters[0].node_ids_to_remove[0] #=> String
resp.clusters[0].nodes #=> Array
resp.clusters[0].nodes[0].node_id #=> String
resp.clusters[0].nodes[0].endpoint.address #=> String
resp.clusters[0].nodes[0].endpoint.port #=> Integer
resp.clusters[0].nodes[0].node_create_time #=> Time
resp.clusters[0].nodes[0].availability_zone #=> String
resp.clusters[0].nodes[0].node_status #=> String
resp.clusters[0].nodes[0].parameter_group_status #=> String
resp.clusters[0].preferred_maintenance_window #=> String
resp.clusters[0].notification_configuration.topic_arn #=> String
resp.clusters[0].notification_configuration.topic_status #=> String
resp.clusters[0].subnet_group #=> String
resp.clusters[0].security_groups #=> Array
resp.clusters[0].security_groups[0].security_group_identifier #=> String
resp.clusters[0].security_groups[0].status #=> String
resp.clusters[0].iam_role_arn #=> String
resp.clusters[0].parameter_group.parameter_group_name #=> String
resp.clusters[0].parameter_group.parameter_apply_status #=> String
resp.clusters[0].parameter_group.node_ids_to_reboot #=> Array
resp.clusters[0].parameter_group.node_ids_to_reboot[0] #=> String
resp.clusters[0].sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_names (Array<String>)

    The names of the DAX clusters being described.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#describe_default_parameters(options = {}) ⇒ Types::DescribeDefaultParametersResponse

Returns the default system parameter information for the DAX caching software.

Examples:

Request syntax with placeholder values


resp = client.describe_default_parameters({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_type #=> String, one of "DEFAULT", "NODE_TYPE_SPECIFIC"
resp.parameters[0].parameter_value #=> String
resp.parameters[0].node_type_specific_values #=> Array
resp.parameters[0].node_type_specific_values[0].node_type #=> String
resp.parameters[0].node_type_specific_values[0].value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].source #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].is_modifiable #=> String, one of "TRUE", "FALSE", "CONDITIONAL"
resp.parameters[0].change_type #=> String, one of "IMMEDIATE", "REQUIRES_REBOOT"

Options Hash (options):

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#describe_events(options = {}) ⇒ Types::DescribeEventsResponse

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  source_name: "String",
  source_type: "CLUSTER", # accepts CLUSTER, PARAMETER_GROUP, SUBNET_GROUP
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.events #=> Array
resp.events[0].source_name #=> String
resp.events[0].source_type #=> String, one of "CLUSTER", "PARAMETER_GROUP", "SUBNET_GROUP"
resp.events[0].message #=> String
resp.events[0].date #=> Time

Options Hash (options):

  • :source_name (String)

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

  • :source_type (String)

    The event source to retrieve events for. If no value is specified, all events are returned.

  • :start_time (Time)

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

  • :end_time (Time)

    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.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#describe_parameter_groups(options = {}) ⇒ Types::DescribeParameterGroupsResponse

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

Examples:

Request syntax with placeholder values


resp = client.describe_parameter_groups({
  parameter_group_names: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.parameter_groups #=> Array
resp.parameter_groups[0].parameter_group_name #=> String
resp.parameter_groups[0].description #=> String

Options Hash (options):

  • :parameter_group_names (Array<String>)

    The names of the parameter groups.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#describe_parameters(options = {}) ⇒ Types::DescribeParametersResponse

Returns the detailed parameter list for a particular parameter group.

Examples:

Request syntax with placeholder values


resp = client.describe_parameters({
  parameter_group_name: "String", # required
  source: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_type #=> String, one of "DEFAULT", "NODE_TYPE_SPECIFIC"
resp.parameters[0].parameter_value #=> String
resp.parameters[0].node_type_specific_values #=> Array
resp.parameters[0].node_type_specific_values[0].node_type #=> String
resp.parameters[0].node_type_specific_values[0].value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].source #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].is_modifiable #=> String, one of "TRUE", "FALSE", "CONDITIONAL"
resp.parameters[0].change_type #=> String, one of "IMMEDIATE", "REQUIRES_REBOOT"

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group.

  • :source (String)

    How the parameter is defined. For example, system denotes a system-defined parameter.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#describe_subnet_groups(options = {}) ⇒ Types::DescribeSubnetGroupsResponse

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

Examples:

Request syntax with placeholder values


resp = client.describe_subnet_groups({
  subnet_group_names: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.subnet_groups #=> Array
resp.subnet_groups[0].subnet_group_name #=> String
resp.subnet_groups[0].description #=> String
resp.subnet_groups[0].vpc_id #=> String
resp.subnet_groups[0].subnets #=> Array
resp.subnet_groups[0].subnets[0].subnet_identifier #=> String
resp.subnet_groups[0].subnets[0].subnet_availability_zone #=> String

Options Hash (options):

  • :subnet_group_names (Array<String>)

    The name of the subnet group.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:

#increase_replication_factor(options = {}) ⇒ Types::IncreaseReplicationFactorResponse

Adds one or more nodes to a DAX cluster.

Examples:

Request syntax with placeholder values


resp = client.increase_replication_factor({
  cluster_name: "String", # required
  new_replication_factor: 1, # required
  availability_zones: ["String"],
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    The name of the DAX cluster that will receive additional nodes.

  • :new_replication_factor (required, Integer)

    The new number of nodes for the DAX cluster.

  • :availability_zones (Array<String>)

    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.

Returns:

See Also:

#list_tags(options = {}) ⇒ Types::ListTagsResponse

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource_name: "String", # required
  next_token: "String",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :resource_name (required, String)

    The name of the DAX resource to which the tags belong.

  • :next_token (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.

Returns:

See Also:

#reboot_node(options = {}) ⇒ Types::RebootNodeResponse

Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.

RebootNode restarts the DAX engine process and does not remove the contents of the cache.

Examples:

Request syntax with placeholder values


resp = client.reboot_node({
  cluster_name: "String", # required
  node_id: "String", # required
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    The name of the DAX cluster containing the node to be rebooted.

  • :node_id (required, String)

    The system-assigned ID of the node to be rebooted.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Types::TagResourceResponse

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_name: "String", # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_name (required, String)

    The name of the DAX resource to which tags should be added.

  • :tags (required, Array<Types::Tag>)

    The tags to be assigned to the DAX resource.

Returns:

See Also:

#untag_resource(options = {}) ⇒ Types::UntagResourceResponse

Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_name: "String", # required
  tag_keys: ["String"], # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_name (required, String)

    The name of the DAX resource from which the tags should be removed.

  • :tag_keys (required, Array<String>)

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

Returns:

See Also:

#update_cluster(options = {}) ⇒ Types::UpdateClusterResponse

Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.

Examples:

Request syntax with placeholder values


resp = client.update_cluster({
  cluster_name: "String", # required
  description: "String",
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  notification_topic_status: "String",
  parameter_group_name: "String",
  security_group_ids: ["String"],
})

Response structure


resp.cluster.cluster_name #=> String
resp.cluster.description #=> String
resp.cluster.cluster_arn #=> String
resp.cluster.total_nodes #=> Integer
resp.cluster.active_nodes #=> Integer
resp.cluster.node_type #=> String
resp.cluster.status #=> String
resp.cluster.cluster_discovery_endpoint.address #=> String
resp.cluster.cluster_discovery_endpoint.port #=> Integer
resp.cluster.node_ids_to_remove #=> Array
resp.cluster.node_ids_to_remove[0] #=> String
resp.cluster.nodes #=> Array
resp.cluster.nodes[0].node_id #=> String
resp.cluster.nodes[0].endpoint.address #=> String
resp.cluster.nodes[0].endpoint.port #=> Integer
resp.cluster.nodes[0].node_create_time #=> Time
resp.cluster.nodes[0].availability_zone #=> String
resp.cluster.nodes[0].node_status #=> String
resp.cluster.nodes[0].parameter_group_status #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.notification_configuration.topic_arn #=> String
resp.cluster.notification_configuration.topic_status #=> String
resp.cluster.subnet_group #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_identifier #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.iam_role_arn #=> String
resp.cluster.parameter_group.parameter_group_name #=> String
resp.cluster.parameter_group.parameter_apply_status #=> String
resp.cluster.parameter_group.node_ids_to_reboot #=> Array
resp.cluster.parameter_group.node_ids_to_reboot[0] #=> String
resp.cluster.sse_description.status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED"

Options Hash (options):

  • :cluster_name (required, String)

    The name of the DAX cluster to be modified.

  • :description (String)

    A description of the changes being made to the cluster.

  • :preferred_maintenance_window (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.

  • :notification_topic_arn (String)

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

  • :notification_topic_status (String)

    The current state of the topic.

  • :parameter_group_name (String)

    The name of a parameter group for this cluster.

  • :security_group_ids (Array<String>)

    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.

Returns:

See Also:

#update_parameter_group(options = {}) ⇒ Types::UpdateParameterGroupResponse

Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Examples:

Request syntax with placeholder values


resp = client.update_parameter_group({
  parameter_group_name: "String", # required
  parameter_name_values: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
    },
  ],
})

Response structure


resp.parameter_group.parameter_group_name #=> String
resp.parameter_group.description #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group.

  • :parameter_name_values (required, Array<Types::ParameterNameValue>)

    An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

Returns:

See Also:

#update_subnet_group(options = {}) ⇒ Types::UpdateSubnetGroupResponse

Modifies an existing subnet group.

Examples:

Request syntax with placeholder values


resp = client.update_subnet_group({
  subnet_group_name: "String", # required
  description: "String",
  subnet_ids: ["String"],
})

Response structure


resp.subnet_group.subnet_group_name #=> String
resp.subnet_group.description #=> String
resp.subnet_group.vpc_id #=> String
resp.subnet_group.subnets #=> Array
resp.subnet_group.subnets[0].subnet_identifier #=> String
resp.subnet_group.subnets[0].subnet_availability_zone #=> String

Options Hash (options):

  • :subnet_group_name (required, String)

    The name of the subnet group.

  • :description (String)

    A description of the subnet group.

  • :subnet_ids (Array<String>)

    A list of subnet IDs in the subnet group.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.