Class: Aws::DAX::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-dax/client.rb

Overview

An API client for DAX. To construct a client, you need to configure a ‘:region` and `:credentials`.

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DAX::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::DAX::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'lib/aws-sdk-dax/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1867
1868
1869
 
# File 'lib/aws-sdk-dax/client.rb', line 1867

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1870
1871
1872
 
# File 'lib/aws-sdk-dax/client.rb', line 1870

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/aws-sdk-dax/client.rb', line 1840

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::DAX')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-dax'
  context[:gem_version] = '1.87.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_cluster(params = {}) ⇒ 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
  },
  cluster_endpoint_encryption_type: "NONE", # accepts NONE, TLS
  network_type: "ipv4", # accepts ipv4, ipv6, dual_stack
})

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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :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`.

    <note markdown=“1”> Amazon Web Services recommends that you have at least two read replicas per cluster.

    </note>
  • :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`

    <note markdown=“1”> 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.

    </note>
  • :notification_topic_arn (String) —

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

    <note markdown=“1”> The Amazon SNS topic owner must be same as the DAX cluster owner.

    </note>
  • :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.

  • :cluster_endpoint_encryption_type (String) —

    The type of encryption the cluster’s endpoint should support. Values are:

    • ‘NONE` for no encryption

    • ‘TLS` for Transport Layer Security

  • :network_type (String) —

    Specifies the IP protocol(s) the cluster uses for network communications. Values are:

    • ‘ipv4` - The cluster is accessible only through IPv4 addresses

    • ‘ipv6` - The cluster is accessible only through IPv6 addresses

    • ‘dual_stack` - The cluster is accessible through both IPv4 and IPv6 addresses.

    <note markdown=“1”> If no explicit ‘NetworkType` is provided, the network type is derived based on the subnet group’s configuration.

    </note>

Returns:

See Also:



688
689
690
691
 
# File 'lib/aws-sdk-dax/client.rb', line 688

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_parameter_group(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



723
724
725
726
 
# File 'lib/aws-sdk-dax/client.rb', line 723

def create_parameter_group(params = {}, options = {})
  req = build_request(:create_parameter_group, params)
  req.send_request(options)
end

#create_subnet_group(params = {}) ⇒ 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
resp.subnet_group.subnets[0].supported_network_types #=> Array
resp.subnet_group.subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.subnet_group.supported_network_types #=> Array
resp.subnet_group.supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



769
770
771
772
 
# File 'lib/aws-sdk-dax/client.rb', line 769

def create_subnet_group(params = {}, options = {})
  req = build_request(:create_subnet_group, params)
  req.send_request(options)
end

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

Removes one or more nodes from a DAX cluster.

<note markdown=“1”> You cannot use ‘DecreaseReplicationFactor` to remove the last node in a DAX cluster. If you need to do this, use `DeleteCluster` instead.

</note>

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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



849
850
851
852
 
# File 'lib/aws-sdk-dax/client.rb', line 849

def decrease_replication_factor(params = {}, options = {})
  req = build_request(:decrease_replication_factor, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ 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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The name of the cluster to be deleted.

Returns:

See Also:



915
916
917
918
 
# File 'lib/aws-sdk-dax/client.rb', line 915

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_parameter_group(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

    The name of the parameter group to delete.

Returns:

See Also:



944
945
946
947
 
# File 'lib/aws-sdk-dax/client.rb', line 944

def delete_parameter_group(params = {}, options = {})
  req = build_request(:delete_parameter_group, params)
  req.send_request(options)
end

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

Deletes a subnet group.

<note markdown=“1”> You cannot delete a subnet group if it is associated with any DAX clusters.

</note>

Examples:

Request syntax with placeholder values


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

Response structure


resp.deletion_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :subnet_group_name (required, String) —

    The name of the subnet group to delete.

Returns:

See Also:



977
978
979
980
 
# File 'lib/aws-sdk-dax/client.rb', line 977

def delete_subnet_group(params = {}, options = {})
  req = build_request(:delete_subnet_group, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ 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].cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.clusters[0].cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.clusters[0].network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



1076
1077
1078
1079
 
# File 'lib/aws-sdk-dax/client.rb', line 1076

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#describe_default_parameters(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

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



1131
1132
1133
1134
 
# File 'lib/aws-sdk-dax/client.rb', line 1131

def describe_default_parameters(params = {}, options = {})
  req = build_request(:describe_default_parameters, params)
  req.send_request(options)
end

#describe_events(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

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

  • :end_time (Time, DateTime, Date, Integer, String) —

    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:



1207
1208
1209
1210
 
# File 'lib/aws-sdk-dax/client.rb', line 1207

def describe_events(params = {}, options = {})
  req = build_request(:describe_events, params)
  req.send_request(options)
end

#describe_parameter_groups(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



1257
1258
1259
1260
 
# File 'lib/aws-sdk-dax/client.rb', line 1257

def describe_parameter_groups(params = {}, options = {})
  req = build_request(:describe_parameter_groups, params)
  req.send_request(options)
end

#describe_parameters(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

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



1320
1321
1322
1323
 
# File 'lib/aws-sdk-dax/client.rb', line 1320

def describe_parameters(params = {}, options = {})
  req = build_request(:describe_parameters, params)
  req.send_request(options)
end

#describe_subnet_groups(params = {}) ⇒ 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
resp.subnet_groups[0].subnets[0].supported_network_types #=> Array
resp.subnet_groups[0].subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.subnet_groups[0].supported_network_types #=> Array
resp.subnet_groups[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



1377
1378
1379
1380
 
# File 'lib/aws-sdk-dax/client.rb', line 1377

def describe_subnet_groups(params = {}, options = {})
  req = build_request(:describe_subnet_groups, params)
  req.send_request(options)
end

#increase_replication_factor(params = {}) ⇒ 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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



1451
1452
1453
1454
 
# File 'lib/aws-sdk-dax/client.rb', line 1451

def increase_replication_factor(params = {}, options = {})
  req = build_request(:increase_replication_factor, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



1490
1491
1492
1493
 
# File 'lib/aws-sdk-dax/client.rb', line 1490

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

#reboot_node(params = {}) ⇒ 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.

<note markdown=“1”> ‘RebootNode` restarts the DAX engine process and does not remove the contents of the cache.

</note>

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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



1564
1565
1566
1567
 
# File 'lib/aws-sdk-dax/client.rb', line 1564

def reboot_node(params = {}, options = {})
  req = build_request(:reboot_node, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



1604
1605
1606
1607
 
# File 'lib/aws-sdk-dax/client.rb', line 1604

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



1640
1641
1642
1643
 
# File 'lib/aws-sdk-dax/client.rb', line 1640

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_cluster(params = {}) ⇒ 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.cluster_discovery_endpoint.url #=> String
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].endpoint.url #=> String
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"
resp.cluster.cluster_endpoint_encryption_type #=> String, one of "NONE", "TLS"
resp.cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :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. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

  • :parameter_group_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:



1736
1737
1738
1739
 
# File 'lib/aws-sdk-dax/client.rb', line 1736

def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

#update_parameter_group(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1786
1787
1788
1789
 
# File 'lib/aws-sdk-dax/client.rb', line 1786

def update_parameter_group(params = {}, options = {})
  req = build_request(:update_parameter_group, params)
  req.send_request(options)
end

#update_subnet_group(params = {}) ⇒ 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
resp.subnet_group.subnets[0].supported_network_types #=> Array
resp.subnet_group.subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.subnet_group.supported_network_types #=> Array
resp.subnet_group.supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

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



1831
1832
1833
1834
 
# File 'lib/aws-sdk-dax/client.rb', line 1831

def update_subnet_group(params = {}, options = {})
  req = build_request(:update_subnet_group, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1860
1861
1862
 
# File 'lib/aws-sdk-dax/client.rb', line 1860

def waiter_names
  []
end