Class: Aws::ElastiCache::Client

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

Overview

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

client = Aws::ElastiCache::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. This can be an 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.

  • :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 DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :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 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` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

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

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

    A Bearer Token Provider. This can be an 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::ElastiCache::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ElastiCache::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.



467
468
469
 
# File 'lib/aws-sdk-elasticache/client.rb', line 467

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. 



11604
11605
11606
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11604

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. 



11607
11608
11609
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11607

def errors_module
  Errors
end

Instance Method Details

#add_tags_to_resource(params = {}) ⇒ Types::TagListMessage

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions].

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

For more information, see [Using Cost Allocation Tags in Amazon ElastiCache] in the *ElastiCache User Guide*.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html [2]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Tagging.html

Examples:

Example: AddTagsToResource


# Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.

resp = client.add_tags_to_resource({
  resource_name: "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", 
  tags: [
    {
      key: "APIVersion", 
      value: "20150202", 
    }, 
    {
      key: "Service", 
      value: "ElastiCache", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  tag_list: [
    {
      key: "APIVersion", 
      value: "20150202", 
    }, 
    {
      key: "Service", 
      value: "ElastiCache", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_name (required, String) —

    The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example ‘arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`. ElastiCache resources are cluster and snapshot.

    For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces].

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



573
574
575
576
 
# File 'lib/aws-sdk-elasticache/client.rb', line 573

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

#authorize_cache_security_group_ingress(params = {}) ⇒ Types::AuthorizeCacheSecurityGroupIngressResult

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

<note markdown=“1”> You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

</note>

Examples:

Example: AuthorizeCacheCacheSecurityGroupIngress


# Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2. Amazon
# EC2 security groups are used as the authorization mechanism.

resp = client.authorize_cache_security_group_ingress({
  cache_security_group_name: "my-sec-grp", 
  ec2_security_group_name: "my-ec2-sec-grp", 
  ec2_security_group_owner_id: "1234567890", 
})

Request syntax with placeholder values


resp = client.authorize_cache_security_group_ingress({
  cache_security_group_name: "String", # required
  ec2_security_group_name: "String", # required
  ec2_security_group_owner_id: "String", # required
})

Response structure


resp.cache_security_group.owner_id #=> String
resp.cache_security_group.cache_security_group_name #=> String
resp.cache_security_group.description #=> String
resp.cache_security_group.ec2_security_groups #=> Array
resp.cache_security_group.ec2_security_groups[0].status #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cache_security_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_security_group_name (required, String) —

    The cache security group that allows network ingress.

  • :ec2_security_group_name (required, String) —

    The Amazon EC2 security group to be authorized for ingress to the cache security group.

  • :ec2_security_group_owner_id (required, String) —

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

Returns:

See Also:



638
639
640
641
 
# File 'lib/aws-sdk-elasticache/client.rb', line 638

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

#batch_apply_update_action(params = {}) ⇒ Types::UpdateActionResultsMessage

Apply the service update. For more information on service updates and applying them, see [Applying Service Updates].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/applying-updates.html

Examples:

Request syntax with placeholder values


resp = client.batch_apply_update_action({
  replication_group_ids: ["String"],
  cache_cluster_ids: ["String"],
  service_update_name: "String", # required
})

Response structure


resp.processed_update_actions #=> Array
resp.processed_update_actions[0].replication_group_id #=> String
resp.processed_update_actions[0].cache_cluster_id #=> String
resp.processed_update_actions[0].service_update_name #=> String
resp.processed_update_actions[0].update_action_status #=> String, one of "not-applied", "waiting-to-start", "in-progress", "stopping", "stopped", "complete", "scheduling", "scheduled", "not-applicable"
resp.unprocessed_update_actions #=> Array
resp.unprocessed_update_actions[0].replication_group_id #=> String
resp.unprocessed_update_actions[0].cache_cluster_id #=> String
resp.unprocessed_update_actions[0].service_update_name #=> String
resp.unprocessed_update_actions[0].error_type #=> String
resp.unprocessed_update_actions[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_ids (Array<String>) —

    The replication group IDs

  • :cache_cluster_ids (Array<String>) —

    The cache cluster IDs

  • :service_update_name (required, String) —

    The unique ID of the service update

Returns:

See Also:



690
691
692
693
 
# File 'lib/aws-sdk-elasticache/client.rb', line 690

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

#batch_stop_update_action(params = {}) ⇒ Types::UpdateActionResultsMessage

Stop the service update. For more information on service updates and stopping them, see [Stopping Service Updates].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/stopping-self-service-updates.html

Examples:

Request syntax with placeholder values


resp = client.batch_stop_update_action({
  replication_group_ids: ["String"],
  cache_cluster_ids: ["String"],
  service_update_name: "String", # required
})

Response structure


resp.processed_update_actions #=> Array
resp.processed_update_actions[0].replication_group_id #=> String
resp.processed_update_actions[0].cache_cluster_id #=> String
resp.processed_update_actions[0].service_update_name #=> String
resp.processed_update_actions[0].update_action_status #=> String, one of "not-applied", "waiting-to-start", "in-progress", "stopping", "stopped", "complete", "scheduling", "scheduled", "not-applicable"
resp.unprocessed_update_actions #=> Array
resp.unprocessed_update_actions[0].replication_group_id #=> String
resp.unprocessed_update_actions[0].cache_cluster_id #=> String
resp.unprocessed_update_actions[0].service_update_name #=> String
resp.unprocessed_update_actions[0].error_type #=> String
resp.unprocessed_update_actions[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_ids (Array<String>) —

    The replication group IDs

  • :cache_cluster_ids (Array<String>) —

    The cache cluster IDs

  • :service_update_name (required, String) —

    The unique ID of the service update

Returns:

See Also:



742
743
744
745
 
# File 'lib/aws-sdk-elasticache/client.rb', line 742

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

#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: {}) 


11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11458

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::ElastiCache')
  )
  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-elasticache'
  context[:gem_version] = '1.124.0'
  Seahorse::Client::Request.new(handlers, context)
end

#complete_migration(params = {}) ⇒ Types::CompleteMigrationResponse

Complete the migration of data.

Examples:

Request syntax with placeholder values


resp = client.complete_migration({
  replication_group_id: "String", # required
  force: false,
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The ID of the replication group to which data is being migrated.

  • :force (Boolean) —

    Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

Returns:

See Also:



851
852
853
854
 
# File 'lib/aws-sdk-elasticache/client.rb', line 851

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

#copy_serverless_cache_snapshot(params = {}) ⇒ Types::CopyServerlessCacheSnapshotResponse

Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

Examples:

Request syntax with placeholder values


resp = client.copy_serverless_cache_snapshot({
  source_serverless_cache_snapshot_name: "String", # required
  target_serverless_cache_snapshot_name: "String", # required
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.serverless_cache_snapshot.serverless_cache_snapshot_name #=> String
resp.serverless_cache_snapshot.arn #=> String
resp.serverless_cache_snapshot.kms_key_id #=> String
resp.serverless_cache_snapshot.snapshot_type #=> String
resp.serverless_cache_snapshot.status #=> String
resp.serverless_cache_snapshot.create_time #=> Time
resp.serverless_cache_snapshot.expiry_time #=> Time
resp.serverless_cache_snapshot.bytes_used_for_cache #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.serverless_cache_name #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.engine #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.major_engine_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_serverless_cache_snapshot_name (required, String) —

    The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :target_serverless_cache_snapshot_name (required, String) —

    The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :kms_key_id (String) —

    The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

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

    A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

Returns:

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-elasticache/client.rb', line 912

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

#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult

Makes a copy of an existing snapshot.

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

Users or groups that have permissions to use the ‘CopySnapshot` operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the `CopySnapshot` operation. For more information about using IAM to control the use of ElastiCache operations, see [Exporting Snapshots] and [Authentication &amp; Access Control].

You could receive the following error messages.

**Error Messages**

  • **Error Message:** The S3 bucket %s is outside of the region.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket] in the ElastiCache User Guide.

  • **Error Message:** The S3 bucket %s does not exist.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket] in the ElastiCache User Guide.

  • **Error Message:** The S3 bucket %s is not owned by the authenticated user.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see [Step 1: Create an Amazon S3 Bucket] in the ElastiCache User Guide.

  • **Error Message:** The authenticated user does not have sufficient permissions to perform the desired activity.

    Solution: Contact your system administrator to get the needed permissions.

  • **Error Message:** The S3 bucket %s already contains an object with key %s.

    Solution: Give the ‘TargetSnapshotName` a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for `TargetSnapshotName`.

  • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

    Solution: Add List and Read permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket] in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

    Solution: Add Upload/Delete permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket] in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

    Solution: Add View Permissions on the bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket] in the ElastiCache User Guide.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html [2]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.html [3]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-create-s3-bucket [4]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access

Examples:

Example: CopySnapshot


# Copies a snapshot to a specified name.

resp = client.copy_snapshot({
  source_snapshot_name: "my-snapshot", 
  target_bucket: "", 
  target_snapshot_name: "my-snapshot-copy", 
})

resp.to_h outputs the following:
{
  snapshot: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2016-12-21T22:24:04.955Z"), 
    cache_cluster_id: "my-redis4", 
    cache_node_type: "cache.m3.large", 
    cache_parameter_group_name: "default.redis3.2", 
    cache_subnet_group_name: "default", 
    engine: "redis", 
    engine_version: "3.2.4", 
    node_snapshots: [
      {
        cache_node_create_time: Time.parse("2016-12-21T22:24:04.955Z"), 
        cache_node_id: "0001", 
        cache_size: "3 MB", 
        snapshot_create_time: Time.parse("2016-12-28T07:00:52Z"), 
      }, 
    ], 
    num_cache_nodes: 1, 
    port: 6379, 
    preferred_availability_zone: "us-east-1c", 
    preferred_maintenance_window: "tue:09:30-tue:10:30", 
    snapshot_name: "my-snapshot-copy", 
    snapshot_retention_limit: 7, 
    snapshot_source: "manual", 
    snapshot_status: "creating", 
    snapshot_window: "07:00-08:00", 
    vpc_id: "vpc-3820329f3", 
  }, 
}

Request syntax with placeholder values


resp = client.copy_snapshot({
  source_snapshot_name: "String", # required
  target_snapshot_name: "String", # required
  target_bucket: "String",
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot.snapshot_name #=> String
resp.snapshot.replication_group_id #=> String
resp.snapshot.replication_group_description #=> String
resp.snapshot.cache_cluster_id #=> String
resp.snapshot.snapshot_status #=> String
resp.snapshot.snapshot_source #=> String
resp.snapshot.cache_node_type #=> String
resp.snapshot.engine #=> String
resp.snapshot.engine_version #=> String
resp.snapshot.num_cache_nodes #=> Integer
resp.snapshot.preferred_availability_zone #=> String
resp.snapshot.preferred_outpost_arn #=> String
resp.snapshot.cache_cluster_create_time #=> Time
resp.snapshot.preferred_maintenance_window #=> String
resp.snapshot.topic_arn #=> String
resp.snapshot.port #=> Integer
resp.snapshot.cache_parameter_group_name #=> String
resp.snapshot.cache_subnet_group_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.auto_minor_version_upgrade #=> Boolean
resp.snapshot.snapshot_retention_limit #=> Integer
resp.snapshot.snapshot_window #=> String
resp.snapshot.num_node_groups #=> Integer
resp.snapshot.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.snapshot.node_snapshots #=> Array
resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
resp.snapshot.node_snapshots[0].node_group_id #=> String
resp.snapshot.node_snapshots[0].cache_node_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
resp.snapshot.node_snapshots[0].cache_size #=> String
resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.data_tiering #=> String, one of "enabled", "disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :source_snapshot_name (required, String) —

    The name of an existing snapshot from which to make a copy.

  • :target_snapshot_name (required, String) —

    A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

  • :target_bucket (String) —

    The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

    When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket] in the *Amazon ElastiCache User Guide*.

    For more information, see [Exporting a Snapshot] in the *Amazon ElastiCache User Guide*.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access [2]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html

  • :kms_key_id (String) —

    The ID of the KMS key used to encrypt the target snapshot.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



1140
1141
1142
1143
 
# File 'lib/aws-sdk-elasticache/client.rb', line 1140

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

#create_cache_cluster(params = {}) ⇒ Types::CreateCacheClusterResult

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.

This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

Examples:

Example: CreateCacheCluster


# Creates a Memcached cluster with 2 nodes. 

resp = client.create_cache_cluster({
  az_mode: "cross-az", 
  cache_cluster_id: "my-memcached-cluster", 
  cache_node_type: "cache.r3.large", 
  cache_subnet_group_name: "default", 
  engine: "memcached", 
  engine_version: "1.4.24", 
  num_cache_nodes: 2, 
  port: 11211, 
})

resp.to_h outputs the following:
{
  cache_cluster: {
    auto_minor_version_upgrade: true, 
    cache_cluster_id: "my-memcached-cluster", 
    cache_cluster_status: "creating", 
    cache_node_type: "cache.r3.large", 
    cache_parameter_group: {
      cache_node_ids_to_reboot: [
      ], 
      cache_parameter_group_name: "default.memcached1.4", 
      parameter_apply_status: "in-sync", 
    }, 
    cache_security_groups: [
    ], 
    cache_subnet_group_name: "default", 
    client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
    engine: "memcached", 
    engine_version: "1.4.24", 
    num_cache_nodes: 2, 
    pending_modified_values: {
    }, 
    preferred_availability_zone: "Multiple", 
    preferred_maintenance_window: "wed:09:00-wed:10:00", 
  }, 
}

Example: CreateCacheCluster


# Creates a Redis cluster with 1 node. 

resp = client.create_cache_cluster({
  auto_minor_version_upgrade: true, 
  cache_cluster_id: "my-redis", 
  cache_node_type: "cache.r3.larage", 
  cache_subnet_group_name: "default", 
  engine: "redis", 
  engine_version: "3.2.4", 
  num_cache_nodes: 1, 
  port: 6379, 
  preferred_availability_zone: "us-east-1c", 
  snapshot_retention_limit: 7, 
})

resp.to_h outputs the following:
{
  cache_cluster: {
    auto_minor_version_upgrade: true, 
    cache_cluster_id: "my-redis", 
    cache_cluster_status: "creating", 
    cache_node_type: "cache.m3.large", 
    cache_parameter_group: {
      cache_node_ids_to_reboot: [
      ], 
      cache_parameter_group_name: "default.redis3.2", 
      parameter_apply_status: "in-sync", 
    }, 
    cache_security_groups: [
    ], 
    cache_subnet_group_name: "default", 
    client_download_landing_page: "https: //console.aws.amazon.com/elasticache/home#client-download: ", 
    engine: "redis", 
    engine_version: "3.2.4", 
    num_cache_nodes: 1, 
    pending_modified_values: {
    }, 
    preferred_availability_zone: "us-east-1c", 
    preferred_maintenance_window: "fri: 05: 30-fri: 06: 30", 
    snapshot_retention_limit: 7, 
    snapshot_window: "10: 00-11: 00", 
  }, 
}

Request syntax with placeholder values


resp = client.create_cache_cluster({
  cache_cluster_id: "String", # required
  replication_group_id: "String",
  az_mode: "single-az", # accepts single-az, cross-az
  preferred_availability_zone: "String",
  preferred_availability_zones: ["String"],
  num_cache_nodes: 1,
  cache_node_type: "String",
  engine: "String",
  engine_version: "String",
  cache_parameter_group_name: "String",
  cache_subnet_group_name: "String",
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  snapshot_arns: ["String"],
  snapshot_name: "String",
  preferred_maintenance_window: "String",
  port: 1,
  notification_topic_arn: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  auth_token: "String",
  outpost_mode: "single-outpost", # accepts single-outpost, cross-outpost
  preferred_outpost_arn: "String",
  preferred_outpost_arns: ["String"],
  log_delivery_configurations: [
    {
      log_type: "slow-log", # accepts slow-log, engine-log
      destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
      destination_details: {
        cloud_watch_logs_details: {
          log_group: "String",
        },
        kinesis_firehose_details: {
          delivery_stream: "String",
        },
      },
      log_format: "text", # accepts text, json
      enabled: false,
    },
  ],
  transit_encryption_enabled: false,
  network_type: "ipv4", # accepts ipv4, ipv6, dual_stack
  ip_discovery: "ipv4", # accepts ipv4, ipv6
})

Response structure


resp.cache_cluster.cache_cluster_id #=> String
resp.cache_cluster.configuration_endpoint.address #=> String
resp.cache_cluster.configuration_endpoint.port #=> Integer
resp.cache_cluster.client_download_landing_page #=> String
resp.cache_cluster.cache_node_type #=> String
resp.cache_cluster.engine #=> String
resp.cache_cluster.engine_version #=> String
resp.cache_cluster.cache_cluster_status #=> String
resp.cache_cluster.num_cache_nodes #=> Integer
resp.cache_cluster.preferred_availability_zone #=> String
resp.cache_cluster.preferred_outpost_arn #=> String
resp.cache_cluster.cache_cluster_create_time #=> Time
resp.cache_cluster.preferred_maintenance_window #=> String
resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove #=> Array
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove[0] #=> String
resp.cache_cluster.pending_modified_values.engine_version #=> String
resp.cache_cluster.pending_modified_values.cache_node_type #=> String
resp.cache_cluster.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.cache_cluster.pending_modified_values.log_delivery_configurations #=> Array
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.cache_cluster.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.cache_cluster.notification_configuration.topic_arn #=> String
resp.cache_cluster.notification_configuration.topic_status #=> String
resp.cache_cluster.cache_security_groups #=> Array
resp.cache_cluster.cache_security_groups[0].cache_security_group_name #=> String
resp.cache_cluster.cache_security_groups[0].status #=> String
resp.cache_cluster.cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_cluster.cache_parameter_group.parameter_apply_status #=> String
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot #=> Array
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot[0] #=> String
resp.cache_cluster.cache_subnet_group_name #=> String
resp.cache_cluster.cache_nodes #=> Array
resp.cache_cluster.cache_nodes[0].cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].cache_node_status #=> String
resp.cache_cluster.cache_nodes[0].cache_node_create_time #=> Time
resp.cache_cluster.cache_nodes[0].endpoint.address #=> String
resp.cache_cluster.cache_nodes[0].endpoint.port #=> Integer
resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
resp.cache_cluster.security_groups #=> Array
resp.cache_cluster.security_groups[0].security_group_id #=> String
resp.cache_cluster.security_groups[0].status #=> String
resp.cache_cluster.replication_group_id #=> String
resp.cache_cluster.snapshot_retention_limit #=> Integer
resp.cache_cluster.snapshot_window #=> String
resp.cache_cluster.auth_token_enabled #=> Boolean
resp.cache_cluster.auth_token_last_modified_date #=> Time
resp.cache_cluster.transit_encryption_enabled #=> Boolean
resp.cache_cluster.at_rest_encryption_enabled #=> Boolean
resp.cache_cluster.arn #=> String
resp.cache_cluster.replication_group_log_delivery_enabled #=> Boolean
resp.cache_cluster.log_delivery_configurations #=> Array
resp.cache_cluster.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.cache_cluster.log_delivery_configurations[0].message #=> String
resp.cache_cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_cluster.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.cache_cluster.transit_encryption_mode #=> String, one of "preferred", "required"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (required, String) —

    The node group (shard) identifier. This parameter is stored as a lowercase string.

    Constraints:

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

    • The first character must be a letter.

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

  • :replication_group_id (String) —

    The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

    If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

    <note markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

    </note>
  • :az_mode (String) —

    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster’s region.

    This parameter is only supported for Memcached clusters.

    If the ‘AZMode` and `PreferredAvailabilityZones` are not specified, ElastiCache assumes `single-az` mode.

  • :preferred_availability_zone (String) —

    The EC2 Availability Zone in which the cluster is created.

    All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use ‘PreferredAvailabilityZones`.

    Default: System chosen Availability Zone.

  • :preferred_availability_zones (Array<String>) —

    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

    This option is only supported on Memcached.

    <note markdown=“1”> If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of

    ‘NumCacheNodes`.

    </note>

    If you want all the nodes in the same Availability Zone, use ‘PreferredAvailabilityZone` instead, or repeat the Availability Zone multiple times in the list.

    Default: System chosen Availability Zones.

  • :num_cache_nodes (Integer) —

    The initial number of cache nodes that the cluster has.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at [aws.amazon.com/contact-us/elasticache-node-limit-request/][1].

    [1]: aws.amazon.com/contact-us/elasticache-node-limit-request/

  • :cache_node_type (String) —

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        **M7g node types**: ‘cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge`

        **M5 node types:** ‘cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge`

        **M4 node types:** ‘cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`

        **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): ‘cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium`

        **T3 node types:** ‘cache.t3.micro`, `cache.t3.small`, `cache.t3.medium`

        **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **T1 node types:** ‘cache.t1.micro`

        **M1 node types:** ‘cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge`

        **M3 node types:** ‘cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge`

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **C1 node types:** ‘cache.c1.xlarge`

    • Memory optimized:

      • Current generation:

        **R7g node types**: ‘cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge`

        **R5 node types:** ‘cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge`

        **R4 node types:** ‘cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

        **R3 node types:** ‘cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`

    **Additional node type info**

    • All current generation instance types are created in Amazon VPC by default.

    • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

    • The configuration variables ‘appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

  • :engine (String) —

    The name of the cache engine to be used for this cluster.

    Valid values for this parameter are: ‘memcached` | `redis`

  • :engine_version (String) —

    The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement

  • :cache_parameter_group_name (String) —

    The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has ‘cluster-enabled=’yes’‘ when creating a cluster.

  • :cache_subnet_group_name (String) —

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

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

    If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [Subnets and Subnet Groups].

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html

  • :cache_security_group_names (Array<String>) —

    A list of security group names to associate with this cluster.

    Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

  • :security_group_ids (Array<String>) —

    One or more VPC security groups associated with the cluster.

    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

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

    A list of tags to be added to this resource.

  • :snapshot_arns (Array<String>) —

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

    <note markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

    </note>

    Example of an Amazon S3 ARN: ‘arn:aws:s3:::my_bucket/snapshot1.rdb`

  • :snapshot_name (String) —

    The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to ‘restoring` while the new node group (shard) is being created.

    <note markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

    </note>
  • :preferred_maintenance_window (String) —

    Specifies the weekly time range during which maintenance on the 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.

  • :port (Integer) —

    The port number on which each of the cache nodes accepts connections.

  • :notification_topic_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

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

    </note>
  • :auto_minor_version_upgrade (Boolean) —

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

  • :snapshot_retention_limit (Integer) —

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set ‘SnapshotRetentionLimit` to 5, a snapshot taken today is retained for 5 days before being deleted.

    <note markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

    </note>

    Default: 0 (i.e., automatic backups are disabled for this cache cluster).

  • :snapshot_window (String) —

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: ‘05:00-09:00`

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    <note markdown=“1”> This parameter is only valid if the ‘Engine` parameter is `redis`.

    </note>
  • :auth_token (String) —

    **Reserved parameter.** The password used to access a password protected server.

    Password constraints:

    • Must be only printable ASCII characters.

    • Must be at least 16 characters and no more than 128 characters in length.

    • The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see [AUTH password] at redis.io/commands/AUTH.

    [1]: redis.io/commands/AUTH

  • :outpost_mode (String) —

    Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

  • :preferred_outpost_arn (String) —

    The outpost ARN in which the cache cluster is created.

  • :preferred_outpost_arns (Array<String>) —

    The outpost ARNs in which the cache cluster is created.

  • :log_delivery_configurations (Array<Types::LogDeliveryConfigurationRequest>) —

    Specifies the destination, format and type of the logs.

  • :transit_encryption_enabled (Boolean) —

    A flag that enables in-transit encryption when set to true.

  • :network_type (String) —

    Must be either ‘ipv4` | `ipv6` | `dual_stack`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

  • :ip_discovery (String) —

    The network type you choose when modifying a cluster, either ‘ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

Returns:

See Also:



1759
1760
1761
1762
 
# File 'lib/aws-sdk-elasticache/client.rb', line 1759

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

#create_cache_parameter_group(params = {}) ⇒ Types::CreateCacheParameterGroupResult

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

  • ModifyCacheParameterGroup][1

    in the ElastiCache API Reference.

  • Parameters and Parameter Groups][2

    in the ElastiCache User Guide.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html [2]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/ParameterGroups.html

Examples:

Example: CreateCacheParameterGroup


# Creates the Amazon ElastiCache parameter group custom-redis2-8.

resp = client.create_cache_parameter_group({
  cache_parameter_group_family: "redis2.8", 
  cache_parameter_group_name: "custom-redis2-8", 
  description: "Custom Redis 2.8 parameter group.", 
})

resp.to_h outputs the following:
{
  cache_parameter_group: {
    cache_parameter_group_family: "redis2.8", 
    cache_parameter_group_name: "custom-redis2-8", 
    description: "Custom Redis 2.8 parameter group.", 
  }, 
}

Request syntax with placeholder values


resp = client.create_cache_parameter_group({
  cache_parameter_group_name: "String", # required
  cache_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_parameter_group.cache_parameter_group_family #=> String
resp.cache_parameter_group.description #=> String
resp.cache_parameter_group.is_global #=> Boolean
resp.cache_parameter_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (required, String) —

    A user-specified name for the cache parameter group.

  • :cache_parameter_group_family (required, String) —

    The name of the cache parameter group family that the cache parameter group can be used with.

    Valid values are: ‘valkey8` | `valkey7` | `memcached1.4` | `memcached1.5` | `memcached1.6` | `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | `redis6.x` | `redis7`

  • :description (required, String) —

    A user-specified description for the cache parameter group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



1852
1853
1854
1855
 
# File 'lib/aws-sdk-elasticache/client.rb', line 1852

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

#create_cache_security_group(params = {}) ⇒ Types::CreateCacheSecurityGroupResult

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see [CreateCacheSubnetGroup].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html

Examples:

Example: CreateCacheSecurityGroup


# Creates an ElastiCache security group. ElastiCache security groups are only for clusters not running in an AWS VPC.

resp = client.create_cache_security_group({
  cache_security_group_name: "my-cache-sec-grp", 
  description: "Example ElastiCache security group.", 
})

Request syntax with placeholder values


resp = client.create_cache_security_group({
  cache_security_group_name: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cache_security_group.owner_id #=> String
resp.cache_security_group.cache_security_group_name #=> String
resp.cache_security_group.description #=> String
resp.cache_security_group.ec2_security_groups #=> Array
resp.cache_security_group.ec2_security_groups[0].status #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cache_security_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_security_group_name (required, String) —

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

    Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word “Default”.

    Example: ‘mysecuritygroup`

  • :description (required, String) —

    A description for the cache security group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



1928
1929
1930
1931
 
# File 'lib/aws-sdk-elasticache/client.rb', line 1928

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

#create_cache_subnet_group(params = {}) ⇒ Types::CreateCacheSubnetGroupResult

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

Examples:

Example: CreateCacheSubnet


# Creates a new cache subnet group.

resp = client.create_cache_subnet_group({
  cache_subnet_group_description: "Sample subnet group", 
  cache_subnet_group_name: "my-sn-grp2", 
  subnet_ids: [
    "subnet-6f28c982", 
    "subnet-bcd382f3", 
    "subnet-845b3e7c0", 
  ], 
})

resp.to_h outputs the following:
{
  cache_subnet_group: {
    cache_subnet_group_description: "My subnet group.", 
    cache_subnet_group_name: "my-sn-grp", 
    subnets: [
      {
        subnet_availability_zone: {
          name: "us-east-1a", 
        }, 
        subnet_identifier: "subnet-6f28c982", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1c", 
        }, 
        subnet_identifier: "subnet-bcd382f3", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1b", 
        }, 
        subnet_identifier: "subnet-845b3e7c0", 
      }, 
    ], 
    vpc_id: "vpc-91280df6", 
  }, 
}

Request syntax with placeholder values


resp = client.create_cache_subnet_group({
  cache_subnet_group_name: "String", # required
  cache_subnet_group_description: "String", # required
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cache_subnet_group.cache_subnet_group_name #=> String
resp.cache_subnet_group.cache_subnet_group_description #=> String
resp.cache_subnet_group.vpc_id #=> String
resp.cache_subnet_group.subnets #=> Array
resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.cache_subnet_group.subnets[0].subnet_outpost.subnet_outpost_arn #=> String
resp.cache_subnet_group.subnets[0].supported_network_types #=> Array
resp.cache_subnet_group.subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_subnet_group.arn #=> String
resp.cache_subnet_group.supported_network_types #=> Array
resp.cache_subnet_group.supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_subnet_group_name (required, String) —

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

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: ‘mysubnetgroup`

  • :cache_subnet_group_description (required, String) —

    A description for the cache subnet group.

  • :subnet_ids (required, Array<String>) —

    A list of VPC subnet IDs for the cache subnet group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



2039
2040
2041
2042
 
# File 'lib/aws-sdk-elasticache/client.rb', line 2039

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

#create_global_replication_group(params = {}) ⇒ Types::CreateGlobalReplicationGroupResult

Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see [Replication Across Regions Using Global Datastore].

  • The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

  • The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastore.html

Examples:

Request syntax with placeholder values


resp = client.create_global_replication_group({
  global_replication_group_id_suffix: "String", # required
  global_replication_group_description: "String",
  primary_replication_group_id: "String", # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id_suffix (required, String) —

    The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with “dsdfu” along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.

    For a full list of Amazon Regions and their respective Global datastore iD prefixes, see [Using the Amazon CLI with Global datastores ][1].

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Redis-Global-Datastores-CLI.html

  • :global_replication_group_description (String) —

    Provides details of the Global datastore

  • :primary_replication_group_id (required, String) —

    The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

Returns:

See Also:



2125
2126
2127
2128
 
# File 'lib/aws-sdk-elasticache/client.rb', line 2125

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

#create_replication_group(params = {}) ⇒ Types::CreateReplicationGroupResult

Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see [Creating a Subnet Group]. For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see [Amazon Service Limits] and choose the limit type **Nodes per cluster per instance type**.

When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see [Scaling self-designed clusters] in the *ElastiCache User Guide*.

<note markdown=“1”> This operation is valid for Valkey and Redis OSS only.

</note>

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html [2]: docs.aws.amazon.com/general/latest/gr/aws_service_limits.html [3]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Scaling.html

Examples:

Example: CreateCacheReplicationGroup


# Creates a Redis replication group with 3 nodes.

resp = client.create_replication_group({
  automatic_failover_enabled: true, 
  cache_node_type: "cache.m3.medium", 
  engine: "redis", 
  engine_version: "2.8.24", 
  num_cache_clusters: 3, 
  replication_group_description: "A Redis replication group.", 
  replication_group_id: "my-redis-rg", 
  snapshot_retention_limit: 30, 
})

resp.to_h outputs the following:
{
  replication_group: {
    automatic_failover: "enabling", 
    description: "A Redis replication group.", 
    member_clusters: [
      "my-redis-rg-001", 
      "my-redis-rg-002", 
      "my-redis-rg-003", 
    ], 
    pending_modified_values: {
    }, 
    replication_group_id: "my-redis-rg", 
    snapshotting_cluster_id: "my-redis-rg-002", 
    status: "creating", 
  }, 
}

Example: CreateReplicationGroup


# Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the
# other shard has two read replicas.

resp = client.create_replication_group({
  auto_minor_version_upgrade: true, 
  cache_node_type: "cache.m3.medium", 
  cache_parameter_group_name: "default.redis3.2.cluster.on", 
  engine: "redis", 
  engine_version: "3.2.4", 
  node_group_configuration: [
    {
      primary_availability_zone: "us-east-1c", 
      replica_availability_zones: [
        "us-east-1b", 
      ], 
      replica_count: 1, 
      slots: "0-8999", 
    }, 
    {
      primary_availability_zone: "us-east-1a", 
      replica_availability_zones: [
        "us-east-1a", 
        "us-east-1c", 
      ], 
      replica_count: 2, 
      slots: "9000-16383", 
    }, 
  ], 
  num_node_groups: 2, 
  replication_group_description: "A multi-sharded replication group", 
  replication_group_id: "clustered-redis-rg", 
  snapshot_retention_limit: 8, 
})

resp.to_h outputs the following:
{
  replication_group: {
    automatic_failover: "enabled", 
    description: "Sharded replication group", 
    member_clusters: [
      "rc-rg3-0001-001", 
      "rc-rg3-0001-002", 
      "rc-rg3-0002-001", 
      "rc-rg3-0002-002", 
      "rc-rg3-0002-003", 
    ], 
    pending_modified_values: {
    }, 
    replication_group_id: "clustered-redis-rg", 
    snapshot_retention_limit: 8, 
    snapshot_window: "05:30-06:30", 
    status: "creating", 
  }, 
}

Request syntax with placeholder values


resp = client.create_replication_group({
  replication_group_id: "String", # required
  replication_group_description: "String", # required
  global_replication_group_id: "String",
  primary_cluster_id: "String",
  automatic_failover_enabled: false,
  multi_az_enabled: false,
  num_cache_clusters: 1,
  preferred_cache_cluster_a_zs: ["String"],
  num_node_groups: 1,
  replicas_per_node_group: 1,
  node_group_configuration: [
    {
      node_group_id: "AllowedNodeGroupId",
      slots: "String",
      replica_count: 1,
      primary_availability_zone: "String",
      replica_availability_zones: ["String"],
      primary_outpost_arn: "String",
      replica_outpost_arns: ["String"],
    },
  ],
  cache_node_type: "String",
  engine: "String",
  engine_version: "String",
  cache_parameter_group_name: "String",
  cache_subnet_group_name: "String",
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  snapshot_arns: ["String"],
  snapshot_name: "String",
  preferred_maintenance_window: "String",
  port: 1,
  notification_topic_arn: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  auth_token: "String",
  transit_encryption_enabled: false,
  at_rest_encryption_enabled: false,
  kms_key_id: "String",
  user_group_ids: ["UserGroupId"],
  log_delivery_configurations: [
    {
      log_type: "slow-log", # accepts slow-log, engine-log
      destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
      destination_details: {
        cloud_watch_logs_details: {
          log_group: "String",
        },
        kinesis_firehose_details: {
          delivery_stream: "String",
        },
      },
      log_format: "text", # accepts text, json
      enabled: false,
    },
  ],
  data_tiering_enabled: false,
  network_type: "ipv4", # accepts ipv4, ipv6, dual_stack
  ip_discovery: "ipv4", # accepts ipv4, ipv6
  transit_encryption_mode: "preferred", # accepts preferred, required
  cluster_mode: "enabled", # accepts enabled, disabled, compatible
  serverless_cache_snapshot_name: "String",
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The replication group identifier. This parameter is stored as a lowercase string.

    Constraints:

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

    • The first character must be a letter.

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

  • :replication_group_description (required, String) —

    A user-created description for the replication group.

  • :global_replication_group_id (String) —

    The name of the Global datastore

  • :primary_cluster_id (String) —

    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of ‘available`.

    This parameter is not required if ‘NumCacheClusters`, `NumNodeGroups`, or `ReplicasPerNodeGroup` is specified.

  • :automatic_failover_enabled (Boolean) —

    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

    ‘AutomaticFailoverEnabled` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

    Default: false

  • :multi_az_enabled (Boolean) —

    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see [Minimizing Downtime: Multi-AZ].

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/AutoFailover.html

  • :num_cache_clusters (Integer) —

    The number of clusters this replication group initially has.

    This parameter is not used if there is more than one node group (shard). You should use ‘ReplicasPerNodeGroup` instead.

    If ‘AutomaticFailoverEnabled` is `true`, the value of this parameter must be at least 2. If `AutomaticFailoverEnabled` is `false` you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

    The maximum permitted value for ‘NumCacheClusters` is 6 (1 primary plus 5 replicas).

  • :preferred_cache_cluster_a_zs (Array<String>) —

    A list of EC2 Availability Zones in which the replication group’s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

    This parameter is not used if there is more than one node group (shard). You should use ‘NodeGroupConfiguration` instead.

    <note markdown=“1”> If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of

    ‘NumCacheClusters`.

    </note>

    Default: system chosen Availability Zones.

  • :num_node_groups (Integer) —

    An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.

    Default: 1

  • :replicas_per_node_group (Integer) —

    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

  • :node_group_configuration (Array<Types::NodeGroupConfiguration>) —

    A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: ‘PrimaryAvailabilityZone`, `ReplicaAvailabilityZones`, `ReplicaCount`, and `Slots`.

    If you’re creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

  • :cache_node_type (String) —

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        **M7g node types**: ‘cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge`

        **M5 node types:** ‘cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge`

        **M4 node types:** ‘cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`

        **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): ‘cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium`

        **T3 node types:** ‘cache.t3.micro`, `cache.t3.small`, `cache.t3.medium`

        **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **T1 node types:** ‘cache.t1.micro`

        **M1 node types:** ‘cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge`

        **M3 node types:** ‘cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge`

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **C1 node types:** ‘cache.c1.xlarge`

    • Memory optimized:

      • Current generation:

        **R7g node types**: ‘cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge`

        **R5 node types:** ‘cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge`

        **R4 node types:** ‘cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

        **R3 node types:** ‘cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`

    **Additional node type info**

    • All current generation instance types are created in Amazon VPC by default.

    • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

    • The configuration variables ‘appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

  • :engine (String) —

    The name of the cache engine to be used for the clusters in this replication group. The value must be set to ‘valkey` or `redis`.

  • :engine_version (String) —

    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the ‘DescribeCacheEngineVersions` operation.

    Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]) in the *ElastiCache User Guide*, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement

  • :cache_parameter_group_name (String) —

    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

    If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

    • To create a Valkey or Redis OSS (cluster mode disabled) replication group, use ‘CacheParameterGroupName=default.redis3.2`.

    • To create a Valkey or Redis OSS (cluster mode enabled) replication group, use ‘CacheParameterGroupName=default.redis3.2.cluster.on`.

  • :cache_subnet_group_name (String) —

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

    If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [Subnets and Subnet Groups].

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.html

  • :cache_security_group_names (Array<String>) —

    A list of cache security group names to associate with this replication group.

  • :security_group_ids (Array<String>) —

    One or more Amazon VPC security groups associated with this replication group.

    Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

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

    A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=‘myKey`, Value=`myKeyValue`. You can include multiple tags as shown following: Key=`myKey`, Value=`myKeyValue` Key=`mySecondKey`, Value=`mySecondKeyValue`. Tags on replication groups will be replicated to all nodes.

  • :snapshot_arns (Array<String>) —

    A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

    Example of an Amazon S3 ARN: ‘arn:aws:s3:::my_bucket/snapshot1.rdb`

  • :snapshot_name (String) —

    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to ‘restoring` while the new replication group is being created.

  • :preferred_maintenance_window (String) —

    Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30`

  • :port (Integer) —

    The port number on which each member of the replication group accepts connections.

  • :notification_topic_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

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

    </note>
  • :auto_minor_version_upgrade (Boolean) —

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

  • :snapshot_retention_limit (Integer) —

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set ‘SnapshotRetentionLimit` to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Default: 0 (i.e., automatic backups are disabled for this cluster).

  • :snapshot_window (String) —

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: ‘05:00-09:00`

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

  • :auth_token (String) —

    **Reserved parameter.** The password used to access a password protected server.

    ‘AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`.

    For HIPAA compliance, you must specify ‘TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.

    Password constraints:

    • Must be only printable ASCII characters.

    • Must be at least 16 characters and no more than 128 characters in length.

    • The only permitted printable special characters are !, &amp;, #, $, ^, &lt;, &gt;, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see [AUTH password] at redis.io/commands/AUTH.

    [1]: redis.io/commands/AUTH

  • :transit_encryption_enabled (Boolean) —

    A flag that enables in-transit encryption when set to ‘true`.

    This parameter is valid only if the ‘Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6`, `4.x` or later, and the cluster is being created in an Amazon VPC.

    If you enable in-transit encryption, you must also specify a value for ‘CacheSubnetGroup`.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version ‘3.2.6`, `4.x` or later.

    Default: ‘false`

    For HIPAA compliance, you must specify ‘TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`.

  • :at_rest_encryption_enabled (Boolean) —

    A flag that enables encryption at rest when set to ‘true`.

    You cannot modify the value of ‘AtRestEncryptionEnabled` after the replication group is created. To enable encryption at rest on a replication group you must set `AtRestEncryptionEnabled` to `true` when you create the replication group.

    Required: Only available when creating a replication group in an Amazon VPC using Valkey 7.2 and later, Redis OSS version ‘3.2.6`, or Redis OSS `4.x` and later.

    Default: ‘true` when using Valkey, `false` when using Redis OSS

  • :kms_key_id (String) —

    The ID of the KMS key used to encrypt the disk in the cluster.

  • :user_group_ids (Array<String>) —

    The user group to associate with the replication group.

  • :log_delivery_configurations (Array<Types::LogDeliveryConfigurationRequest>) —

    Specifies the destination, format and type of the logs.

  • :data_tiering_enabled (Boolean) —

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see [Data tiering].

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html

  • :network_type (String) —

    Must be either ‘ipv4` | `ipv6` | `dual_stack`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

  • :ip_discovery (String) —

    The network type you choose when creating a replication group, either ‘ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

  • :transit_encryption_mode (String) —

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    When setting ‘TransitEncryptionEnabled` to `true`, you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only.

    Setting ‘TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`.

    This process will not trigger the replacement of the replication group.

  • :cluster_mode (String) —

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

  • :serverless_cache_snapshot_name (String) —

    The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.

Returns:

See Also:



2920
2921
2922
2923
 
# File 'lib/aws-sdk-elasticache/client.rb', line 2920

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

#create_serverless_cache(params = {}) ⇒ Types::CreateServerlessCacheResponse

Creates a serverless cache.

Examples:

Request syntax with placeholder values


resp = client.create_serverless_cache({
  serverless_cache_name: "String", # required
  description: "String",
  engine: "String", # required
  major_engine_version: "String",
  cache_usage_limits: {
    data_storage: {
      maximum: 1,
      minimum: 1,
      unit: "GB", # required, accepts GB
    },
    ecpu_per_second: {
      maximum: 1,
      minimum: 1,
    },
  },
  kms_key_id: "String",
  security_group_ids: ["String"],
  snapshot_arns_to_restore: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  user_group_id: "String",
  subnet_ids: ["String"],
  snapshot_retention_limit: 1,
  daily_snapshot_time: "String",
})

Response structure


resp.serverless_cache.serverless_cache_name #=> String
resp.serverless_cache.description #=> String
resp.serverless_cache.create_time #=> Time
resp.serverless_cache.status #=> String
resp.serverless_cache.engine #=> String
resp.serverless_cache.major_engine_version #=> String
resp.serverless_cache.full_engine_version #=> String
resp.serverless_cache.cache_usage_limits.data_storage.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.minimum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.unit #=> String, one of "GB"
resp.serverless_cache.cache_usage_limits.ecpu_per_second.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.ecpu_per_second.minimum #=> Integer
resp.serverless_cache.kms_key_id #=> String
resp.serverless_cache.security_group_ids #=> Array
resp.serverless_cache.security_group_ids[0] #=> String
resp.serverless_cache.endpoint.address #=> String
resp.serverless_cache.endpoint.port #=> Integer
resp.serverless_cache.reader_endpoint.address #=> String
resp.serverless_cache.reader_endpoint.port #=> Integer
resp.serverless_cache.arn #=> String
resp.serverless_cache.user_group_id #=> String
resp.serverless_cache.subnet_ids #=> Array
resp.serverless_cache.subnet_ids[0] #=> String
resp.serverless_cache.snapshot_retention_limit #=> Integer
resp.serverless_cache.daily_snapshot_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_name (required, String) —

    User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

  • :description (String) —

    User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.

  • :engine (required, String) —

    The name of the cache engine to be used for creating the serverless cache.

  • :major_engine_version (String) —

    The version of the cache engine that will be used to create the serverless cache.

  • :cache_usage_limits (Types::CacheUsageLimits) —

    Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.

  • :kms_key_id (String) —

    ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

  • :security_group_ids (Array<String>) —

    A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.

  • :snapshot_arns_to_restore (Array<String>) —

    The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

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

    The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

  • :user_group_id (String) —

    The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

  • :subnet_ids (Array<String>) —

    A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.

  • :snapshot_retention_limit (Integer) —

    The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :daily_snapshot_time (String) —

    The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

Returns:

See Also:



3058
3059
3060
3061
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3058

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

#create_serverless_cache_snapshot(params = {}) ⇒ Types::CreateServerlessCacheSnapshotResponse

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

Examples:

Request syntax with placeholder values


resp = client.create_serverless_cache_snapshot({
  serverless_cache_snapshot_name: "String", # required
  serverless_cache_name: "String", # required
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.serverless_cache_snapshot.serverless_cache_snapshot_name #=> String
resp.serverless_cache_snapshot.arn #=> String
resp.serverless_cache_snapshot.kms_key_id #=> String
resp.serverless_cache_snapshot.snapshot_type #=> String
resp.serverless_cache_snapshot.status #=> String
resp.serverless_cache_snapshot.create_time #=> Time
resp.serverless_cache_snapshot.expiry_time #=> Time
resp.serverless_cache_snapshot.bytes_used_for_cache #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.serverless_cache_name #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.engine #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.major_engine_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_snapshot_name (required, String) —

    The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters.

  • :serverless_cache_name (required, String) —

    The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :kms_key_id (String) —

    The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

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

    A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.

Returns:

See Also:



3122
3123
3124
3125
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3122

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

#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResult

Creates a copy of an entire cluster or replication group at a specific moment in time.

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

Examples:

Example: CreateSnapshot - NonClustered Redis, no read-replicas


# Creates a snapshot of a non-clustered Redis cluster that has only one node.

resp = client.create_snapshot({
  cache_cluster_id: "onenoderedis", 
  snapshot_name: "snapshot-1", 
})

resp.to_h outputs the following:
{
  snapshot: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2017-02-03T15:43:36.278Z"), 
    cache_cluster_id: "onenoderedis", 
    cache_node_type: "cache.m3.medium", 
    cache_parameter_group_name: "default.redis3.2", 
    cache_subnet_group_name: "default", 
    engine: "redis", 
    engine_version: "3.2.4", 
    node_snapshots: [
      {
        cache_node_create_time: Time.parse("2017-02-03T15:43:36.278Z"), 
        cache_node_id: "0001", 
        cache_size: "", 
      }, 
    ], 
    num_cache_nodes: 1, 
    port: 6379, 
    preferred_availability_zone: "us-west-2c", 
    preferred_maintenance_window: "sat:08:00-sat:09:00", 
    snapshot_name: "snapshot-1", 
    snapshot_retention_limit: 1, 
    snapshot_source: "manual", 
    snapshot_status: "creating", 
    snapshot_window: "00:00-01:00", 
    vpc_id: "vpc-73c3cd17", 
  }, 
}

Example: CreateSnapshot - NonClustered Redis, 2 read-replicas


# Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas.
# CacheClusterId must be a specific node in the cluster.

resp = client.create_snapshot({
  cache_cluster_id: "threenoderedis-001", 
  snapshot_name: "snapshot-2", 
})

resp.to_h outputs the following:
{
  snapshot: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2017-02-03T15:43:36.278Z"), 
    cache_cluster_id: "threenoderedis-001", 
    cache_node_type: "cache.m3.medium", 
    cache_parameter_group_name: "default.redis3.2", 
    cache_subnet_group_name: "default", 
    engine: "redis", 
    engine_version: "3.2.4", 
    node_snapshots: [
      {
        cache_node_create_time: Time.parse("2017-02-03T15:43:36.278Z"), 
        cache_node_id: "0001", 
        cache_size: "", 
      }, 
    ], 
    num_cache_nodes: 1, 
    port: 6379, 
    preferred_availability_zone: "us-west-2c", 
    preferred_maintenance_window: "sat:08:00-sat:09:00", 
    snapshot_name: "snapshot-2", 
    snapshot_retention_limit: 1, 
    snapshot_source: "manual", 
    snapshot_status: "creating", 
    snapshot_window: "00:00-01:00", 
    vpc_id: "vpc-73c3cd17", 
  }, 
}

Example: CreateSnapshot-clustered Redis


# Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.

resp = client.create_snapshot({
  replication_group_id: "clusteredredis", 
  snapshot_name: "snapshot-2x5", 
})

resp.to_h outputs the following:
{
  snapshot: {
    auto_minor_version_upgrade: true, 
    automatic_failover: "enabled", 
    cache_node_type: "cache.m3.medium", 
    cache_parameter_group_name: "default.redis3.2.cluster.on", 
    cache_subnet_group_name: "default", 
    engine: "redis", 
    engine_version: "3.2.4", 
    node_snapshots: [
      {
        cache_size: "", 
        node_group_id: "0001", 
      }, 
      {
        cache_size: "", 
        node_group_id: "0002", 
      }, 
    ], 
    num_node_groups: 2, 
    port: 6379, 
    preferred_maintenance_window: "mon:09:30-mon:10:30", 
    replication_group_description: "Redis cluster with 2 shards.", 
    replication_group_id: "clusteredredis", 
    snapshot_name: "snapshot-2x5", 
    snapshot_retention_limit: 1, 
    snapshot_source: "manual", 
    snapshot_status: "creating", 
    snapshot_window: "12:00-13:00", 
    vpc_id: "vpc-73c3cd17", 
  }, 
}

Request syntax with placeholder values


resp = client.create_snapshot({
  replication_group_id: "String",
  cache_cluster_id: "String",
  snapshot_name: "String", # required
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot.snapshot_name #=> String
resp.snapshot.replication_group_id #=> String
resp.snapshot.replication_group_description #=> String
resp.snapshot.cache_cluster_id #=> String
resp.snapshot.snapshot_status #=> String
resp.snapshot.snapshot_source #=> String
resp.snapshot.cache_node_type #=> String
resp.snapshot.engine #=> String
resp.snapshot.engine_version #=> String
resp.snapshot.num_cache_nodes #=> Integer
resp.snapshot.preferred_availability_zone #=> String
resp.snapshot.preferred_outpost_arn #=> String
resp.snapshot.cache_cluster_create_time #=> Time
resp.snapshot.preferred_maintenance_window #=> String
resp.snapshot.topic_arn #=> String
resp.snapshot.port #=> Integer
resp.snapshot.cache_parameter_group_name #=> String
resp.snapshot.cache_subnet_group_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.auto_minor_version_upgrade #=> Boolean
resp.snapshot.snapshot_retention_limit #=> Integer
resp.snapshot.snapshot_window #=> String
resp.snapshot.num_node_groups #=> Integer
resp.snapshot.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.snapshot.node_snapshots #=> Array
resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
resp.snapshot.node_snapshots[0].node_group_id #=> String
resp.snapshot.node_snapshots[0].cache_node_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
resp.snapshot.node_snapshots[0].cache_size #=> String
resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.data_tiering #=> String, one of "enabled", "disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (String) —

    The identifier of an existing replication group. The snapshot is created from this replication group.

  • :cache_cluster_id (String) —

    The identifier of an existing cluster. The snapshot is created from this cluster.

  • :snapshot_name (required, String) —

    A name for the snapshot being created.

  • :kms_key_id (String) —

    The ID of the KMS key used to encrypt the snapshot.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



3347
3348
3349
3350
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3347

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

#create_user(params = {}) ⇒ Types::User

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see [Using Role Based Access Control (RBAC)].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html

Examples:

Request syntax with placeholder values


resp = client.create_user({
  user_id: "UserId", # required
  user_name: "UserName", # required
  engine: "EngineType", # required
  passwords: ["String"],
  access_string: "AccessString", # required
  no_password_required: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  authentication_mode: {
    type: "password", # accepts password, no-password-required, iam
    passwords: ["String"],
  },
})

Response structure


resp.user_id #=> String
resp.user_name #=> String
resp.status #=> String
resp.engine #=> String
resp.minimum_engine_version #=> String
resp.access_string #=> String
resp.user_group_ids #=> Array
resp.user_group_ids[0] #=> String
resp.authentication.type #=> String, one of "password", "no-password", "iam"
resp.authentication.password_count #=> Integer
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The ID of the user.

  • :user_name (required, String) —

    The username of the user.

  • :engine (required, String) —

    The options are valkey or redis.

  • :passwords (Array<String>) —

    Passwords used for this user. You can create up to two passwords for each user.

  • :access_string (required, String) —

    Access permissions string used for this user.

  • :no_password_required (Boolean) —

    Indicates a password is not required for this user.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

  • :authentication_mode (Types::AuthenticationMode) —

    Specifies how to authenticate the user.

Returns:

See Also:



3438
3439
3440
3441
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3438

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

#create_user_group(params = {}) ⇒ Types::UserGroup

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see [Using Role Based Access Control (RBAC)]

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html

Examples:

Request syntax with placeholder values


resp = client.create_user_group({
  user_group_id: "String", # required
  engine: "EngineType", # required
  user_ids: ["UserId"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.user_group_id #=> String
resp.status #=> String
resp.engine #=> String
resp.user_ids #=> Array
resp.user_ids[0] #=> String
resp.minimum_engine_version #=> String
resp.pending_changes.user_ids_to_remove #=> Array
resp.pending_changes.user_ids_to_remove[0] #=> String
resp.pending_changes.user_ids_to_add #=> Array
resp.pending_changes.user_ids_to_add[0] #=> String
resp.replication_groups #=> Array
resp.replication_groups[0] #=> String
resp.serverless_caches #=> Array
resp.serverless_caches[0] #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_group_id (required, String) —

    The ID of the user group.

  • :engine (required, String) —

    Sets the engine listed in a user group. The options are valkey or redis.

  • :user_ids (Array<String>) —

    The list of user IDs that belong to the user group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.

Returns:

See Also:



3514
3515
3516
3517
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3514

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

#decrease_node_groups_in_global_replication_group(params = {}) ⇒ Types::DecreaseNodeGroupsInGlobalReplicationGroupResult

Decreases the number of node groups in a Global datastore

Examples:

Request syntax with placeholder values


resp = client.decrease_node_groups_in_global_replication_group({
  global_replication_group_id: "String", # required
  node_group_count: 1, # required
  global_node_groups_to_remove: ["String"],
  global_node_groups_to_retain: ["String"],
  apply_immediately: false, # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :node_group_count (required, Integer) —

    The number of node groups (shards) that results from the modification of the shard configuration

  • :global_node_groups_to_remove (Array<String>) —

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

  • :global_node_groups_to_retain (Array<String>) —

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

  • :apply_immediately (required, Boolean) —

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Returns:

See Also:



3587
3588
3589
3590
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3587

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

#decrease_replica_count(params = {}) ⇒ Types::DecreaseReplicaCountResult

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Examples:

Request syntax with placeholder values


resp = client.decrease_replica_count({
  replication_group_id: "String", # required
  new_replica_count: 1,
  replica_configuration: [
    {
      node_group_id: "AllowedNodeGroupId", # required
      new_replica_count: 1, # required
      preferred_availability_zones: ["String"],
      preferred_outpost_arns: ["String"],
    },
  ],
  replicas_to_remove: ["String"],
  apply_immediately: false, # required
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The id of the replication group from which you want to remove replica nodes.

  • :new_replica_count (Integer) —

    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group’s node groups.

    The minimum number of replicas in a shard or replication group is:

    • Valkey or Redis OSS (cluster mode disabled)

      • If Multi-AZ is enabled: 1

      • If Multi-AZ is not enabled: 0

    • Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

  • :replica_configuration (Array<Types::ConfigureShard>) —

    A list of ‘ConfigureShard` objects that can be used to configure each shard in a Valkey or Redis OSS replication group. The `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`, and `PreferredAvailabilityZones`.

  • :replicas_to_remove (Array<String>) —

    A list of the node ids to remove from the replication group or node group (shard).

  • :apply_immediately (required, Boolean) —

    If ‘True`, the number of replica nodes is decreased immediately. `ApplyImmediately=False` is not currently supported.

Returns:

See Also:



3737
3738
3739
3740
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3737

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

#delete_cache_cluster(params = {}) ⇒ Types::DeleteCacheClusterResult

Deletes a previously provisioned cluster. ‘DeleteCacheCluster` deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Valkey or Redis OSS (cluster mode enabled) clusters

  • Valkey or Redis OSS (cluster mode disabled) clusters

  • A cluster that is the last read replica of a replication group

  • A cluster that is the primary node of a replication group

  • A node group (shard) that has Multi-AZ mode enabled

  • A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group

  • A cluster that is not in the ‘available` state

Examples:

Example: DeleteCacheCluster


# Deletes an Amazon ElastiCache cluster.

resp = client.delete_cache_cluster({
  cache_cluster_id: "my-memcached", 
})

resp.to_h outputs the following:
{
  cache_cluster: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2016-12-22T16:05:17.314Z"), 
    cache_cluster_id: "my-memcached", 
    cache_cluster_status: "deleting", 
    cache_node_type: "cache.r3.large", 
    cache_parameter_group: {
      cache_node_ids_to_reboot: [
      ], 
      cache_parameter_group_name: "default.memcached1.4", 
      parameter_apply_status: "in-sync", 
    }, 
    cache_security_groups: [
    ], 
    cache_subnet_group_name: "default", 
    client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
    configuration_endpoint: {
      address: "my-memcached2.ameaqx.cfg.use1.cache.amazonaws.com", 
      port: 11211, 
    }, 
    engine: "memcached", 
    engine_version: "1.4.24", 
    num_cache_nodes: 2, 
    pending_modified_values: {
    }, 
    preferred_availability_zone: "Multiple", 
    preferred_maintenance_window: "tue:07:30-tue:08:30", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_cache_cluster({
  cache_cluster_id: "String", # required
  final_snapshot_identifier: "String",
})

Response structure


resp.cache_cluster.cache_cluster_id #=> String
resp.cache_cluster.configuration_endpoint.address #=> String
resp.cache_cluster.configuration_endpoint.port #=> Integer
resp.cache_cluster.client_download_landing_page #=> String
resp.cache_cluster.cache_node_type #=> String
resp.cache_cluster.engine #=> String
resp.cache_cluster.engine_version #=> String
resp.cache_cluster.cache_cluster_status #=> String
resp.cache_cluster.num_cache_nodes #=> Integer
resp.cache_cluster.preferred_availability_zone #=> String
resp.cache_cluster.preferred_outpost_arn #=> String
resp.cache_cluster.cache_cluster_create_time #=> Time
resp.cache_cluster.preferred_maintenance_window #=> String
resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove #=> Array
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove[0] #=> String
resp.cache_cluster.pending_modified_values.engine_version #=> String
resp.cache_cluster.pending_modified_values.cache_node_type #=> String
resp.cache_cluster.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.cache_cluster.pending_modified_values.log_delivery_configurations #=> Array
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.cache_cluster.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.cache_cluster.notification_configuration.topic_arn #=> String
resp.cache_cluster.notification_configuration.topic_status #=> String
resp.cache_cluster.cache_security_groups #=> Array
resp.cache_cluster.cache_security_groups[0].cache_security_group_name #=> String
resp.cache_cluster.cache_security_groups[0].status #=> String
resp.cache_cluster.cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_cluster.cache_parameter_group.parameter_apply_status #=> String
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot #=> Array
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot[0] #=> String
resp.cache_cluster.cache_subnet_group_name #=> String
resp.cache_cluster.cache_nodes #=> Array
resp.cache_cluster.cache_nodes[0].cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].cache_node_status #=> String
resp.cache_cluster.cache_nodes[0].cache_node_create_time #=> Time
resp.cache_cluster.cache_nodes[0].endpoint.address #=> String
resp.cache_cluster.cache_nodes[0].endpoint.port #=> Integer
resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
resp.cache_cluster.security_groups #=> Array
resp.cache_cluster.security_groups[0].security_group_id #=> String
resp.cache_cluster.security_groups[0].status #=> String
resp.cache_cluster.replication_group_id #=> String
resp.cache_cluster.snapshot_retention_limit #=> Integer
resp.cache_cluster.snapshot_window #=> String
resp.cache_cluster.auth_token_enabled #=> Boolean
resp.cache_cluster.auth_token_last_modified_date #=> Time
resp.cache_cluster.transit_encryption_enabled #=> Boolean
resp.cache_cluster.at_rest_encryption_enabled #=> Boolean
resp.cache_cluster.arn #=> String
resp.cache_cluster.replication_group_log_delivery_enabled #=> Boolean
resp.cache_cluster.log_delivery_configurations #=> Array
resp.cache_cluster.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.cache_cluster.log_delivery_configurations[0].message #=> String
resp.cache_cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_cluster.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.cache_cluster.transit_encryption_mode #=> String, one of "preferred", "required"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (required, String) —

    The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

  • :final_snapshot_identifier (String) —

    The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

Returns:

See Also:



3904
3905
3906
3907
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3904

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

#delete_cache_parameter_group(params = {}) ⇒ Struct

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

Examples:

Example: DeleteCacheParameterGroup


# Deletes the Amazon ElastiCache parameter group custom-mem1-4.

resp = client.delete_cache_parameter_group({
  cache_parameter_group_name: "custom-mem1-4", 
})

Request syntax with placeholder values


resp = client.delete_cache_parameter_group({
  cache_parameter_group_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (required, String) —

    The name of the cache parameter group to delete.

    <note markdown=“1”> The specified cache security group must not be associated with any clusters.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3942
3943
3944
3945
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3942

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

#delete_cache_security_group(params = {}) ⇒ Struct

Deletes a cache security group.

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

</note>

Examples:

Example: DeleteCacheSecurityGroup


# Deletes a cache security group.

resp = client.delete_cache_security_group({
  cache_security_group_name: "my-sec-group", 
})

Request syntax with placeholder values


resp = client.delete_cache_security_group({
  cache_security_group_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cache_security_group_name (required, String) —

    The name of the cache security group to delete.

    <note markdown=“1”> You cannot delete the default security group.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3982
3983
3984
3985
 
# File 'lib/aws-sdk-elasticache/client.rb', line 3982

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

#delete_cache_subnet_group(params = {}) ⇒ Struct

Deletes a cache subnet group.

<note markdown=“1”> You cannot delete a default cache subnet group or one that is associated with any clusters.

</note>

Examples:

Example: DeleteCacheSubnetGroup


# Deletes the Amazon ElastiCache subnet group my-subnet-group.

resp = client.delete_cache_subnet_group({
  cache_subnet_group_name: "my-subnet-group", 
})

Request syntax with placeholder values


resp = client.delete_cache_subnet_group({
  cache_subnet_group_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cache_subnet_group_name (required, String) —

    The name of the cache subnet group to delete.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4021
4022
4023
4024
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4021

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

#delete_global_replication_group(params = {}) ⇒ Types::DeleteGlobalReplicationGroupResult

Deleting a Global datastore is a two-step process:

  • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

  • Once the Global datastore contains only the primary cluster, you can use the ‘DeleteGlobalReplicationGroup` API to delete the Global datastore while retainining the primary cluster using `RetainPrimaryReplicationGroup=true`.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting ‘RetainPrimaryReplicationGroup=true`. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Examples:

Request syntax with placeholder values


resp = client.delete_global_replication_group({
  global_replication_group_id: "String", # required
  retain_primary_replication_group: false, # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :retain_primary_replication_group (required, Boolean) —

    The primary replication group is retained as a standalone replication group.

Returns:

See Also:



4091
4092
4093
4094
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4091

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

#delete_replication_group(params = {}) ⇒ Types::DeleteReplicationGroupResult

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting ‘RetainPrimaryCluster=true`.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

<note markdown=“1”> * ‘CreateSnapshot` permission is required to create a final snapshot.

Without this permission, the API call will fail with an `Access
Denied` exception.

  • This operation is valid for Redis OSS only.

</note>

Examples:

Example: DeleteReplicationGroup


# Deletes the Amazon ElastiCache replication group my-redis-rg.

resp = client.delete_replication_group({
  replication_group_id: "my-redis-rg", 
  retain_primary_cluster: false, 
})

resp.to_h outputs the following:
{
  replication_group: {
    automatic_failover: "disabled", 
    description: "simple redis cluster", 
    pending_modified_values: {
    }, 
    replication_group_id: "my-redis-rg", 
    status: "deleting", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_replication_group({
  replication_group_id: "String", # required
  retain_primary_cluster: false,
  final_snapshot_identifier: "String",
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The identifier for the cluster to be deleted. This parameter is not case sensitive.

  • :retain_primary_cluster (Boolean) —

    If set to ‘true`, all of the read replicas are deleted, but the primary node is retained.

  • :final_snapshot_identifier (String) —

    The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

Returns:

See Also:



4245
4246
4247
4248
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4245

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

#delete_serverless_cache(params = {}) ⇒ Types::DeleteServerlessCacheResponse

Deletes a specified existing serverless cache.

<note markdown=“1”> ‘CreateServerlessCacheSnapshot` permission is required to create a final snapshot. Without this permission, the API call will fail with an `Access Denied` exception.

</note>

Examples:

Request syntax with placeholder values


resp = client.delete_serverless_cache({
  serverless_cache_name: "String", # required
  final_snapshot_name: "String",
})

Response structure


resp.serverless_cache.serverless_cache_name #=> String
resp.serverless_cache.description #=> String
resp.serverless_cache.create_time #=> Time
resp.serverless_cache.status #=> String
resp.serverless_cache.engine #=> String
resp.serverless_cache.major_engine_version #=> String
resp.serverless_cache.full_engine_version #=> String
resp.serverless_cache.cache_usage_limits.data_storage.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.minimum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.unit #=> String, one of "GB"
resp.serverless_cache.cache_usage_limits.ecpu_per_second.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.ecpu_per_second.minimum #=> Integer
resp.serverless_cache.kms_key_id #=> String
resp.serverless_cache.security_group_ids #=> Array
resp.serverless_cache.security_group_ids[0] #=> String
resp.serverless_cache.endpoint.address #=> String
resp.serverless_cache.endpoint.port #=> Integer
resp.serverless_cache.reader_endpoint.address #=> String
resp.serverless_cache.reader_endpoint.port #=> Integer
resp.serverless_cache.arn #=> String
resp.serverless_cache.user_group_id #=> String
resp.serverless_cache.subnet_ids #=> Array
resp.serverless_cache.subnet_ids[0] #=> String
resp.serverless_cache.snapshot_retention_limit #=> Integer
resp.serverless_cache.daily_snapshot_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_name (required, String) —

    The identifier of the serverless cache to be deleted.

  • :final_snapshot_name (String) —

    Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.

Returns:

See Also:



4309
4310
4311
4312
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4309

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

#delete_serverless_cache_snapshot(params = {}) ⇒ Types::DeleteServerlessCacheSnapshotResponse

Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

Examples:

Request syntax with placeholder values


resp = client.delete_serverless_cache_snapshot({
  serverless_cache_snapshot_name: "String", # required
})

Response structure


resp.serverless_cache_snapshot.serverless_cache_snapshot_name #=> String
resp.serverless_cache_snapshot.arn #=> String
resp.serverless_cache_snapshot.kms_key_id #=> String
resp.serverless_cache_snapshot.snapshot_type #=> String
resp.serverless_cache_snapshot.status #=> String
resp.serverless_cache_snapshot.create_time #=> Time
resp.serverless_cache_snapshot.expiry_time #=> Time
resp.serverless_cache_snapshot.bytes_used_for_cache #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.serverless_cache_name #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.engine #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.major_engine_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_snapshot_name (required, String) —

    Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

Returns:

See Also:



4349
4350
4351
4352
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4349

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

#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResult

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

Examples:

Example: DeleteSnapshot


# Deletes the Redis snapshot snapshot-20160822.

resp = client.delete_snapshot({
  snapshot_name: "snapshot-20161212", 
})

resp.to_h outputs the following:
{
  snapshot: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2016-12-21T22:27:12.543Z"), 
    cache_cluster_id: "my-redis5", 
    cache_node_type: "cache.m3.large", 
    cache_parameter_group_name: "default.redis3.2", 
    cache_subnet_group_name: "default", 
    engine: "redis", 
    engine_version: "3.2.4", 
    node_snapshots: [
      {
        cache_node_create_time: Time.parse("2016-12-21T22:27:12.543Z"), 
        cache_node_id: "0001", 
        cache_size: "3 MB", 
        snapshot_create_time: Time.parse("2016-12-21T22:30:26Z"), 
      }, 
    ], 
    num_cache_nodes: 1, 
    port: 6379, 
    preferred_availability_zone: "us-east-1c", 
    preferred_maintenance_window: "fri:05:30-fri:06:30", 
    snapshot_name: "snapshot-20161212", 
    snapshot_retention_limit: 7, 
    snapshot_source: "manual", 
    snapshot_status: "deleting", 
    snapshot_window: "10:00-11:00", 
    vpc_id: "vpc-91280df6", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_snapshot({
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.snapshot_name #=> String
resp.snapshot.replication_group_id #=> String
resp.snapshot.replication_group_description #=> String
resp.snapshot.cache_cluster_id #=> String
resp.snapshot.snapshot_status #=> String
resp.snapshot.snapshot_source #=> String
resp.snapshot.cache_node_type #=> String
resp.snapshot.engine #=> String
resp.snapshot.engine_version #=> String
resp.snapshot.num_cache_nodes #=> Integer
resp.snapshot.preferred_availability_zone #=> String
resp.snapshot.preferred_outpost_arn #=> String
resp.snapshot.cache_cluster_create_time #=> Time
resp.snapshot.preferred_maintenance_window #=> String
resp.snapshot.topic_arn #=> String
resp.snapshot.port #=> Integer
resp.snapshot.cache_parameter_group_name #=> String
resp.snapshot.cache_subnet_group_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.auto_minor_version_upgrade #=> Boolean
resp.snapshot.snapshot_retention_limit #=> Integer
resp.snapshot.snapshot_window #=> String
resp.snapshot.num_node_groups #=> Integer
resp.snapshot.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.snapshot.node_snapshots #=> Array
resp.snapshot.node_snapshots[0].cache_cluster_id #=> String
resp.snapshot.node_snapshots[0].node_group_id #=> String
resp.snapshot.node_snapshots[0].cache_node_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.node_group_id #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.slots #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_count #=> Integer
resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
resp.snapshot.node_snapshots[0].cache_size #=> String
resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.data_tiering #=> String, one of "enabled", "disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_name (required, String) —

    The name of the snapshot to be deleted.

Returns:

See Also:



4466
4467
4468
4469
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4466

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

#delete_user(params = {}) ⇒ Types::User

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see [Using Role Based Access Control (RBAC)].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  user_id: "UserId", # required
})

Response structure


resp.user_id #=> String
resp.user_name #=> String
resp.status #=> String
resp.engine #=> String
resp.minimum_engine_version #=> String
resp.access_string #=> String
resp.user_group_ids #=> Array
resp.user_group_ids[0] #=> String
resp.authentication.type #=> String, one of "password", "no-password", "iam"
resp.authentication.password_count #=> Integer
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The ID of the user.

Returns:

See Also:



4519
4520
4521
4522
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4519

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

#delete_user_group(params = {}) ⇒ Types::UserGroup

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see [Using Role Based Access Control (RBAC)].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html

Examples:

Request syntax with placeholder values


resp = client.delete_user_group({
  user_group_id: "String", # required
})

Response structure


resp.user_group_id #=> String
resp.status #=> String
resp.engine #=> String
resp.user_ids #=> Array
resp.user_ids[0] #=> String
resp.minimum_engine_version #=> String
resp.pending_changes.user_ids_to_remove #=> Array
resp.pending_changes.user_ids_to_remove[0] #=> String
resp.pending_changes.user_ids_to_add #=> Array
resp.pending_changes.user_ids_to_add[0] #=> String
resp.replication_groups #=> Array
resp.replication_groups[0] #=> String
resp.serverless_caches #=> Array
resp.serverless_caches[0] #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_group_id (required, String) —

    The ID of the user group.

Returns:

See Also:



4576
4577
4578
4579
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4576

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

#describe_cache_clusters(params = {}) ⇒ Types::CacheClusterMessage

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

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* cache_cluster_available
* cache_cluster_deleted

Examples:

Example: DescribeCacheClusters


# Lists the details for up to 50 cache clusters.

resp = client.describe_cache_clusters({
  cache_cluster_id: "my-mem-cluster", 
})

resp.to_h outputs the following:
{
  cache_clusters: [
    {
      auto_minor_version_upgrade: true, 
      cache_cluster_create_time: Time.parse("2016-12-21T21:59:43.794Z"), 
      cache_cluster_id: "my-mem-cluster", 
      cache_cluster_status: "available", 
      cache_node_type: "cache.t2.medium", 
      cache_parameter_group: {
        cache_node_ids_to_reboot: [
        ], 
        cache_parameter_group_name: "default.memcached1.4", 
        parameter_apply_status: "in-sync", 
      }, 
      cache_security_groups: [
      ], 
      cache_subnet_group_name: "default", 
      client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
      configuration_endpoint: {
        address: "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com", 
        port: 11211, 
      }, 
      engine: "memcached", 
      engine_version: "1.4.24", 
      num_cache_nodes: 2, 
      pending_modified_values: {
      }, 
      preferred_availability_zone: "Multiple", 
      preferred_maintenance_window: "wed:06:00-wed:07:00", 
    }, 
  ], 
}

Example: DescribeCacheClusters


# Lists the details for the cache cluster my-mem-cluster.

resp = client.describe_cache_clusters({
  cache_cluster_id: "my-mem-cluster", 
  show_cache_node_info: true, 
})

resp.to_h outputs the following:
{
  cache_clusters: [
    {
      auto_minor_version_upgrade: true, 
      cache_cluster_create_time: Time.parse("2016-12-21T21:59:43.794Z"), 
      cache_cluster_id: "my-mem-cluster", 
      cache_cluster_status: "available", 
      cache_node_type: "cache.t2.medium", 
      cache_nodes: [
        {
          cache_node_create_time: Time.parse("2016-12-21T21:59:43.794Z"), 
          cache_node_id: "0001", 
          cache_node_status: "available", 
          customer_availability_zone: "us-east-1b", 
          endpoint: {
            address: "my-mem-cluster.ameaqx.0001.use1.cache.amazonaws.com", 
            port: 11211, 
          }, 
          parameter_group_status: "in-sync", 
        }, 
        {
          cache_node_create_time: Time.parse("2016-12-21T21:59:43.794Z"), 
          cache_node_id: "0002", 
          cache_node_status: "available", 
          customer_availability_zone: "us-east-1a", 
          endpoint: {
            address: "my-mem-cluster.ameaqx.0002.use1.cache.amazonaws.com", 
            port: 11211, 
          }, 
          parameter_group_status: "in-sync", 
        }, 
      ], 
      cache_parameter_group: {
        cache_node_ids_to_reboot: [
        ], 
        cache_parameter_group_name: "default.memcached1.4", 
        parameter_apply_status: "in-sync", 
      }, 
      cache_security_groups: [
      ], 
      cache_subnet_group_name: "default", 
      client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
      configuration_endpoint: {
        address: "my-mem-cluster.ameaqx.cfg.use1.cache.amazonaws.com", 
        port: 11211, 
      }, 
      engine: "memcached", 
      engine_version: "1.4.24", 
      num_cache_nodes: 2, 
      pending_modified_values: {
      }, 
      preferred_availability_zone: "Multiple", 
      preferred_maintenance_window: "wed:06:00-wed:07:00", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_cache_clusters({
  cache_cluster_id: "String",
  max_records: 1,
  marker: "String",
  show_cache_node_info: false,
  show_cache_clusters_not_in_replication_groups: false,
})

Response structure


resp.marker #=> String
resp.cache_clusters #=> Array
resp.cache_clusters[0].cache_cluster_id #=> String
resp.cache_clusters[0].configuration_endpoint.address #=> String
resp.cache_clusters[0].configuration_endpoint.port #=> Integer
resp.cache_clusters[0].client_download_landing_page #=> String
resp.cache_clusters[0].cache_node_type #=> String
resp.cache_clusters[0].engine #=> String
resp.cache_clusters[0].engine_version #=> String
resp.cache_clusters[0].cache_cluster_status #=> String
resp.cache_clusters[0].num_cache_nodes #=> Integer
resp.cache_clusters[0].preferred_availability_zone #=> String
resp.cache_clusters[0].preferred_outpost_arn #=> String
resp.cache_clusters[0].cache_cluster_create_time #=> Time
resp.cache_clusters[0].preferred_maintenance_window #=> String
resp.cache_clusters[0].pending_modified_values.num_cache_nodes #=> Integer
resp.cache_clusters[0].pending_modified_values.cache_node_ids_to_remove #=> Array
resp.cache_clusters[0].pending_modified_values.cache_node_ids_to_remove[0] #=> String
resp.cache_clusters[0].pending_modified_values.engine_version #=> String
resp.cache_clusters[0].pending_modified_values.cache_node_type #=> String
resp.cache_clusters[0].pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations #=> Array
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_clusters[0].pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_clusters[0].pending_modified_values.transit_encryption_enabled #=> Boolean
resp.cache_clusters[0].pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.cache_clusters[0].notification_configuration.topic_arn #=> String
resp.cache_clusters[0].notification_configuration.topic_status #=> String
resp.cache_clusters[0].cache_security_groups #=> Array
resp.cache_clusters[0].cache_security_groups[0].cache_security_group_name #=> String
resp.cache_clusters[0].cache_security_groups[0].status #=> String
resp.cache_clusters[0].cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_clusters[0].cache_parameter_group.parameter_apply_status #=> String
resp.cache_clusters[0].cache_parameter_group.cache_node_ids_to_reboot #=> Array
resp.cache_clusters[0].cache_parameter_group.cache_node_ids_to_reboot[0] #=> String
resp.cache_clusters[0].cache_subnet_group_name #=> String
resp.cache_clusters[0].cache_nodes #=> Array
resp.cache_clusters[0].cache_nodes[0].cache_node_id #=> String
resp.cache_clusters[0].cache_nodes[0].cache_node_status #=> String
resp.cache_clusters[0].cache_nodes[0].cache_node_create_time #=> Time
resp.cache_clusters[0].cache_nodes[0].endpoint.address #=> String
resp.cache_clusters[0].cache_nodes[0].endpoint.port #=> Integer
resp.cache_clusters[0].cache_nodes[0].parameter_group_status #=> String
resp.cache_clusters[0].cache_nodes[0].source_cache_node_id #=> String
resp.cache_clusters[0].cache_nodes[0].customer_availability_zone #=> String
resp.cache_clusters[0].cache_nodes[0].customer_outpost_arn #=> String
resp.cache_clusters[0].auto_minor_version_upgrade #=> Boolean
resp.cache_clusters[0].security_groups #=> Array
resp.cache_clusters[0].security_groups[0].security_group_id #=> String
resp.cache_clusters[0].security_groups[0].status #=> String
resp.cache_clusters[0].replication_group_id #=> String
resp.cache_clusters[0].snapshot_retention_limit #=> Integer
resp.cache_clusters[0].snapshot_window #=> String
resp.cache_clusters[0].auth_token_enabled #=> Boolean
resp.cache_clusters[0].auth_token_last_modified_date #=> Time
resp.cache_clusters[0].transit_encryption_enabled #=> Boolean
resp.cache_clusters[0].at_rest_encryption_enabled #=> Boolean
resp.cache_clusters[0].arn #=> String
resp.cache_clusters[0].replication_group_log_delivery_enabled #=> Boolean
resp.cache_clusters[0].log_delivery_configurations #=> Array
resp.cache_clusters[0].log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_clusters[0].log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_clusters[0].log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_clusters[0].log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_clusters[0].log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_clusters[0].log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.cache_clusters[0].log_delivery_configurations[0].message #=> String
resp.cache_clusters[0].network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_clusters[0].ip_discovery #=> String, one of "ipv4", "ipv6"
resp.cache_clusters[0].transit_encryption_mode #=> String, one of "preferred", "required"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (String) —

    The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn’t case sensitive.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

  • :show_cache_node_info (Boolean) —

    An optional flag that can be included in the ‘DescribeCacheCluster` request to retrieve information about the individual cache nodes.

  • :show_cache_clusters_not_in_replication_groups (Boolean) —

    An optional flag that can be included in the ‘DescribeCacheCluster` request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.

Returns:

See Also:



4849
4850
4851
4852
 
# File 'lib/aws-sdk-elasticache/client.rb', line 4849

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

#describe_cache_engine_versions(params = {}) ⇒ Types::CacheEngineVersionMessage

Returns a list of the available cache engines and their versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeCacheEngineVersions


# Lists the details for up to 25 Memcached and Redis cache engine versions.

resp = client.describe_cache_engine_versions({
})

resp.to_h outputs the following:
{
  cache_engine_versions: [
    {
      cache_engine_description: "memcached", 
      cache_engine_version_description: "memcached version 1.4.14", 
      cache_parameter_group_family: "memcached1.4", 
      engine: "memcached", 
      engine_version: "1.4.14", 
    }, 
    {
      cache_engine_description: "memcached", 
      cache_engine_version_description: "memcached version 1.4.24", 
      cache_parameter_group_family: "memcached1.4", 
      engine: "memcached", 
      engine_version: "1.4.24", 
    }, 
    {
      cache_engine_description: "memcached", 
      cache_engine_version_description: "memcached version 1.4.33", 
      cache_parameter_group_family: "memcached1.4", 
      engine: "memcached", 
      engine_version: "1.4.33", 
    }, 
    {
      cache_engine_description: "memcached", 
      cache_engine_version_description: "memcached version 1.4.5", 
      cache_parameter_group_family: "memcached1.4", 
      engine: "memcached", 
      engine_version: "1.4.5", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.6.13", 
      cache_parameter_group_family: "redis2.6", 
      engine: "redis", 
      engine_version: "2.6.13", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.19", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.19", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.21", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.21", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.22 R5", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.22", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.23 R4", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.23", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.24 R3", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.24", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.6", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.6", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 3.2.4", 
      cache_parameter_group_family: "redis3.2", 
      engine: "redis", 
      engine_version: "3.2.4", 
    }, 
  ], 
}

Example: DescribeCacheEngineVersions


# Lists the details for up to 50 Redis cache engine versions.

resp = client.describe_cache_engine_versions({
  default_only: false, 
  engine: "redis", 
  max_records: 50, 
})

resp.to_h outputs the following:
{
  cache_engine_versions: [
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.6.13", 
      cache_parameter_group_family: "redis2.6", 
      engine: "redis", 
      engine_version: "2.6.13", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.19", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.19", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.21", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.21", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.22 R5", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.22", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.23 R4", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.23", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.24 R3", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.24", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 2.8.6", 
      cache_parameter_group_family: "redis2.8", 
      engine: "redis", 
      engine_version: "2.8.6", 
    }, 
    {
      cache_engine_description: "Redis", 
      cache_engine_version_description: "redis version 3.2.4", 
      cache_parameter_group_family: "redis3.2", 
      engine: "redis", 
      engine_version: "3.2.4", 
    }, 
  ], 
  marker: "", 
}

Request syntax with placeholder values


resp = client.describe_cache_engine_versions({
  engine: "String",
  engine_version: "String",
  cache_parameter_group_family: "String",
  max_records: 1,
  marker: "String",
  default_only: false,
})

Response structure


resp.marker #=> String
resp.cache_engine_versions #=> Array
resp.cache_engine_versions[0].engine #=> String
resp.cache_engine_versions[0].engine_version #=> String
resp.cache_engine_versions[0].cache_parameter_group_family #=> String
resp.cache_engine_versions[0].cache_engine_description #=> String
resp.cache_engine_versions[0].cache_engine_version_description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine (String) —

    The cache engine to return. Valid values: ‘memcached` | `redis`

  • :engine_version (String) —

    The cache engine version to return.

    Example: ‘1.4.14`

  • :cache_parameter_group_family (String) —

    The name of a specific cache parameter group family to return details for.

    Valid values are: ‘memcached1.4` | `memcached1.5` | `memcached1.6` | `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | `redis6.x` | `redis6.2` | `redis7` | `valkey7`

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

  • :default_only (Boolean) —

    If ‘true`, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Returns:

See Also:



5103
5104
5105
5106
 
# File 'lib/aws-sdk-elasticache/client.rb', line 5103

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

#describe_cache_parameter_groups(params = {}) ⇒ Types::CacheParameterGroupsMessage

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeCacheParameterGroups


# Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains
# only the descriptions for that group.

resp = client.describe_cache_parameter_groups({
  cache_parameter_group_name: "custom-mem1-4", 
})

resp.to_h outputs the following:
{
  cache_parameter_groups: [
    {
      cache_parameter_group_family: "memcached1.4", 
      cache_parameter_group_name: "custom-mem1-4", 
      description: "Custom memcache param group", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_cache_parameter_groups({
  cache_parameter_group_name: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.cache_parameter_groups #=> Array
resp.cache_parameter_groups[0].cache_parameter_group_name #=> String
resp.cache_parameter_groups[0].cache_parameter_group_family #=> String
resp.cache_parameter_groups[0].description #=> String
resp.cache_parameter_groups[0].is_global #=> Boolean
resp.cache_parameter_groups[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (String) —

    The name of a specific cache parameter group to return details for.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



5181
5182
5183
5184
 
# File 'lib/aws-sdk-elasticache/client.rb', line 5181

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

#describe_cache_parameters(params = {}) ⇒ Types::CacheParameterGroupDetails

Returns the detailed parameter list for a particular cache parameter group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeCacheParameters


# Lists up to 100 user parameter values for the parameter group custom.redis2.8.

resp = client.describe_cache_parameters({
  cache_parameter_group_name: "custom-redis2-8", 
  max_records: 100, 
  source: "user", 
})

resp.to_h outputs the following:
{
  marker: "", 
  parameters: [
    {
      allowed_values: "yes,no", 
      change_type: "requires-reboot", 
      data_type: "string", 
      description: "Apply rehashing or not.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "activerehashing", 
      parameter_value: "yes", 
      source: "system", 
    }, 
    {
      allowed_values: "always,everysec,no", 
      change_type: "immediate", 
      data_type: "string", 
      description: "fsync policy for AOF persistence", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "appendfsync", 
      parameter_value: "everysec", 
      source: "system", 
    }, 
    {
      allowed_values: "yes,no", 
      change_type: "immediate", 
      data_type: "string", 
      description: "Enable Redis persistence.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "appendonly", 
      parameter_value: "no", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Normal client output buffer hard limit in bytes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-normal-hard-limit", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Normal client output buffer soft limit in bytes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-normal-soft-limit", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Normal client output buffer soft limit in seconds.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-normal-soft-seconds", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Pubsub client output buffer hard limit in bytes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-pubsub-hard-limit", 
      parameter_value: "33554432", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Pubsub client output buffer soft limit in bytes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-pubsub-soft-limit", 
      parameter_value: "8388608", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Pubsub client output buffer soft limit in seconds.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-pubsub-soft-seconds", 
      parameter_value: "60", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Slave client output buffer soft limit in seconds.", 
      is_modifiable: false, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "client-output-buffer-limit-slave-soft-seconds", 
      parameter_value: "60", 
      source: "system", 
    }, 
    {
      allowed_values: "yes,no", 
      change_type: "immediate", 
      data_type: "string", 
      description: "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.23", 
      parameter_name: "close-on-slave-write", 
      parameter_value: "yes", 
      source: "system", 
    }, 
    {
      allowed_values: "1-1200000", 
      change_type: "requires-reboot", 
      data_type: "integer", 
      description: "Set the number of databases.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "databases", 
      parameter_value: "16", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The maximum number of hash entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "hash-max-ziplist-entries", 
      parameter_value: "512", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The threshold of biggest hash entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "hash-max-ziplist-value", 
      parameter_value: "64", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The maximum number of list entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "list-max-ziplist-entries", 
      parameter_value: "512", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The threshold of biggest list entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "list-max-ziplist-value", 
      parameter_value: "64", 
      source: "system", 
    }, 
    {
      allowed_values: "5000", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", 
      is_modifiable: false, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "lua-time-limit", 
      parameter_value: "5000", 
      source: "system", 
    }, 
    {
      allowed_values: "1-65000", 
      change_type: "requires-reboot", 
      data_type: "integer", 
      description: "The maximum number of Redis clients.", 
      is_modifiable: false, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "maxclients", 
      parameter_value: "65000", 
      source: "system", 
    }, 
    {
      allowed_values: "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", 
      change_type: "immediate", 
      data_type: "string", 
      description: "Max memory policy.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "maxmemory-policy", 
      parameter_value: "volatile-lru", 
      source: "system", 
    }, 
    {
      allowed_values: "1-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Max memory samples.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "maxmemory-samples", 
      parameter_value: "3", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "min-slaves-max-lag", 
      parameter_value: "10", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "min-slaves-to-write", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      change_type: "immediate", 
      data_type: "string", 
      description: "The keyspace events for Redis to notify Pub/Sub clients about. By default all notifications are disabled", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "notify-keyspace-events", 
      source: "system", 
    }, 
    {
      allowed_values: "16384-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The replication backlog size in bytes for PSYNC. This is the size of the buffer which accumulates slave data when slave is disconnected for some time, so that when slave reconnects again, only transfer the portion of data which the slave missed. Minimum value is 16K.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "repl-backlog-size", 
      parameter_value: "1048576", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The amount of time in seconds after the master no longer have any slaves connected for the master to free the replication backlog. A value of 0 means to never release the backlog.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "repl-backlog-ttl", 
      parameter_value: "3600", 
      source: "system", 
    }, 
    {
      allowed_values: "11-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The timeout in seconds for bulk transfer I/O during sync and master timeout from the perspective of the slave, and slave timeout from the perspective of the master.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "repl-timeout", 
      parameter_value: "60", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The amount of memory reserved for non-cache memory usage, in bytes. You may want to increase this parameter for nodes with read replicas, AOF enabled, etc, to reduce swap usage.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "reserved-memory", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The limit in the size of the set in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "set-max-intset-entries", 
      parameter_value: "512", 
      source: "system", 
    }, 
    {
      allowed_values: "yes,no", 
      change_type: "immediate", 
      data_type: "string", 
      description: "Configures if chaining of slaves is allowed", 
      is_modifiable: false, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "slave-allow-chaining", 
      parameter_value: "no", 
      source: "system", 
    }, 
    {
      allowed_values: "-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The execution time, in microseconds, to exceed in order for the command to get logged. Note that a negative number disables the slow log, while a value of zero forces the logging of every command.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "slowlog-log-slower-than", 
      parameter_value: "10000", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "slowlog-max-len", 
      parameter_value: "128", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "If non-zero, send ACKs every given number of seconds.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "tcp-keepalive", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0,20-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "Close connection if client is idle for a given number of seconds, or never if 0.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "timeout", 
      parameter_value: "0", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The maximum number of sorted set entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "zset-max-ziplist-entries", 
      parameter_value: "128", 
      source: "system", 
    }, 
    {
      allowed_values: "0-", 
      change_type: "immediate", 
      data_type: "integer", 
      description: "The threshold of biggest sorted set entries in order for the dataset to be compressed.", 
      is_modifiable: true, 
      minimum_engine_version: "2.8.6", 
      parameter_name: "zset-max-ziplist-value", 
      parameter_value: "64", 
      source: "system", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_cache_parameters({
  cache_parameter_group_name: "String", # required
  source: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_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 #=> Boolean
resp.parameters[0].minimum_engine_version #=> String
resp.parameters[0].change_type #=> String, one of "immediate", "requires-reboot"
resp.cache_node_type_specific_parameters #=> Array
resp.cache_node_type_specific_parameters[0].parameter_name #=> String
resp.cache_node_type_specific_parameters[0].description #=> String
resp.cache_node_type_specific_parameters[0].source #=> String
resp.cache_node_type_specific_parameters[0].data_type #=> String
resp.cache_node_type_specific_parameters[0].allowed_values #=> String
resp.cache_node_type_specific_parameters[0].is_modifiable #=> Boolean
resp.cache_node_type_specific_parameters[0].minimum_engine_version #=> String
resp.cache_node_type_specific_parameters[0].cache_node_type_specific_values #=> Array
resp.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].cache_node_type #=> String
resp.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].value #=> String
resp.cache_node_type_specific_parameters[0].change_type #=> String, one of "immediate", "requires-reboot"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (required, String) —

    The name of a specific cache parameter group to return details for.

  • :source (String) —

    The parameter types to return.

    Valid values: ‘user` | `system` | `engine-default`

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



5661
5662
5663
5664
 
# File 'lib/aws-sdk-elasticache/client.rb', line 5661

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

#describe_cache_security_groups(params = {}) ⇒ Types::CacheSecurityGroupMessage

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeCacheSecurityGroups


# Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only
# the description of that group.

resp = client.describe_cache_security_groups({
  cache_security_group_name: "my-sec-group", 
})

Request syntax with placeholder values


resp = client.describe_cache_security_groups({
  cache_security_group_name: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.cache_security_groups #=> Array
resp.cache_security_groups[0].owner_id #=> String
resp.cache_security_groups[0].cache_security_group_name #=> String
resp.cache_security_groups[0].description #=> String
resp.cache_security_groups[0].ec2_security_groups #=> Array
resp.cache_security_groups[0].ec2_security_groups[0].status #=> String
resp.cache_security_groups[0].ec2_security_groups[0].ec2_security_group_name #=> String
resp.cache_security_groups[0].ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cache_security_groups[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_security_group_name (String) —

    The name of the cache security group to return details for.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



5732
5733
5734
5735
 
# File 'lib/aws-sdk-elasticache/client.rb', line 5732

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

#describe_cache_subnet_groups(params = {}) ⇒ Types::CacheSubnetGroupMessage

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeCacheSubnetGroups


# Describes up to 25 cache subnet groups.

resp = client.describe_cache_subnet_groups({
  max_records: 25, 
})

resp.to_h outputs the following:
{
  cache_subnet_groups: [
    {
      cache_subnet_group_description: "Default CacheSubnetGroup", 
      cache_subnet_group_name: "default", 
      subnets: [
        {
          subnet_availability_zone: {
            name: "us-east-1a", 
          }, 
          subnet_identifier: "subnet-1a2b3c4d", 
        }, 
        {
          subnet_availability_zone: {
            name: "us-east-1c", 
          }, 
          subnet_identifier: "subnet-a1b2c3d4", 
        }, 
        {
          subnet_availability_zone: {
            name: "us-east-1e", 
          }, 
          subnet_identifier: "subnet-abcd1234", 
        }, 
        {
          subnet_availability_zone: {
            name: "us-east-1b", 
          }, 
          subnet_identifier: "subnet-1234abcd", 
        }, 
      ], 
      vpc_id: "vpc-91280df6", 
    }, 
  ], 
  marker: "", 
}

Request syntax with placeholder values


resp = client.describe_cache_subnet_groups({
  cache_subnet_group_name: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.cache_subnet_groups #=> Array
resp.cache_subnet_groups[0].cache_subnet_group_name #=> String
resp.cache_subnet_groups[0].cache_subnet_group_description #=> String
resp.cache_subnet_groups[0].vpc_id #=> String
resp.cache_subnet_groups[0].subnets #=> Array
resp.cache_subnet_groups[0].subnets[0].subnet_identifier #=> String
resp.cache_subnet_groups[0].subnets[0].subnet_availability_zone.name #=> String
resp.cache_subnet_groups[0].subnets[0].subnet_outpost.subnet_outpost_arn #=> String
resp.cache_subnet_groups[0].subnets[0].supported_network_types #=> Array
resp.cache_subnet_groups[0].subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_subnet_groups[0].arn #=> String
resp.cache_subnet_groups[0].supported_network_types #=> Array
resp.cache_subnet_groups[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_subnet_group_name (String) —

    The name of the cache subnet group to return details for.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



5844
5845
5846
5847
 
# File 'lib/aws-sdk-elasticache/client.rb', line 5844

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

#describe_engine_default_parameters(params = {}) ⇒ Types::DescribeEngineDefaultParametersResult

Returns the default engine and system parameter information for the specified cache engine.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeEngineDefaultParameters


# Returns the default engine and system parameter information for the specified cache engine.

resp = client.describe_engine_default_parameters({
  cache_parameter_group_family: "redis2.8", 
  max_records: 25, 
})

resp.to_h outputs the following:
{
  engine_defaults: {
    cache_node_type_specific_parameters: [
      {
        allowed_values: "0-", 
        cache_node_type_specific_values: [
          {
            cache_node_type: "cache.c1.xlarge", 
            value: "650117120", 
          }, 
          {
            cache_node_type: "cache.m1.large", 
            value: "702545920", 
          }, 
          {
            cache_node_type: "cache.m1.medium", 
            value: "309329920", 
          }, 
          {
            cache_node_type: "cache.m1.small", 
            value: "94371840", 
          }, 
          {
            cache_node_type: "cache.m1.xlarge", 
            value: "1488977920", 
          }, 
          {
            cache_node_type: "cache.m2.2xlarge", 
            value: "3502243840", 
          }, 
          {
            cache_node_type: "cache.m2.4xlarge", 
            value: "7088373760", 
          }, 
          {
            cache_node_type: "cache.m2.xlarge", 
            value: "1709178880", 
          }, 
          {
            cache_node_type: "cache.m3.2xlarge", 
            value: "2998927360", 
          }, 
          {
            cache_node_type: "cache.m3.large", 
            value: "650117120", 
          }, 
          {
            cache_node_type: "cache.m3.medium", 
            value: "309329920", 
          }, 
          {
            cache_node_type: "cache.m3.xlarge", 
            value: "1426063360", 
          }, 
          {
            cache_node_type: "cache.m4.10xlarge", 
            value: "16604761424", 
          }, 
          {
            cache_node_type: "cache.m4.2xlarge", 
            value: "3188912636", 
          }, 
          {
            cache_node_type: "cache.m4.4xlarge", 
            value: "6525729063", 
          }, 
          {
            cache_node_type: "cache.m4.large", 
            value: "689259315", 
          }, 
          {
            cache_node_type: "cache.m4.xlarge", 
            value: "1532850176", 
          }, 
          {
            cache_node_type: "cache.r3.2xlarge", 
            value: "6081740800", 
          }, 
          {
            cache_node_type: "cache.r3.4xlarge", 
            value: "12268339200", 
          }, 
          {
            cache_node_type: "cache.r3.8xlarge", 
            value: "24536678400", 
          }, 
          {
            cache_node_type: "cache.r3.large", 
            value: "1468006400", 
          }, 
          {
            cache_node_type: "cache.r3.xlarge", 
            value: "3040870400", 
          }, 
          {
            cache_node_type: "cache.t1.micro", 
            value: "14260633", 
          }, 
          {
            cache_node_type: "cache.t2.medium", 
            value: "346134937", 
          }, 
          {
            cache_node_type: "cache.t2.micro", 
            value: "58195968", 
          }, 
          {
            cache_node_type: "cache.t2.small", 
            value: "166513868", 
          }, 
        ], 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Slave client output buffer hard limit in bytes.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-slave-hard-limit", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        cache_node_type_specific_values: [
          {
            cache_node_type: "cache.c1.xlarge", 
            value: "650117120", 
          }, 
          {
            cache_node_type: "cache.m1.large", 
            value: "702545920", 
          }, 
          {
            cache_node_type: "cache.m1.medium", 
            value: "309329920", 
          }, 
          {
            cache_node_type: "cache.m1.small", 
            value: "94371840", 
          }, 
          {
            cache_node_type: "cache.m1.xlarge", 
            value: "1488977920", 
          }, 
          {
            cache_node_type: "cache.m2.2xlarge", 
            value: "3502243840", 
          }, 
          {
            cache_node_type: "cache.m2.4xlarge", 
            value: "7088373760", 
          }, 
          {
            cache_node_type: "cache.m2.xlarge", 
            value: "1709178880", 
          }, 
          {
            cache_node_type: "cache.m3.2xlarge", 
            value: "2998927360", 
          }, 
          {
            cache_node_type: "cache.m3.large", 
            value: "650117120", 
          }, 
          {
            cache_node_type: "cache.m3.medium", 
            value: "309329920", 
          }, 
          {
            cache_node_type: "cache.m3.xlarge", 
            value: "1426063360", 
          }, 
          {
            cache_node_type: "cache.m4.10xlarge", 
            value: "16604761424", 
          }, 
          {
            cache_node_type: "cache.m4.2xlarge", 
            value: "3188912636", 
          }, 
          {
            cache_node_type: "cache.m4.4xlarge", 
            value: "6525729063", 
          }, 
          {
            cache_node_type: "cache.m4.large", 
            value: "689259315", 
          }, 
          {
            cache_node_type: "cache.m4.xlarge", 
            value: "1532850176", 
          }, 
          {
            cache_node_type: "cache.r3.2xlarge", 
            value: "6081740800", 
          }, 
          {
            cache_node_type: "cache.r3.4xlarge", 
            value: "12268339200", 
          }, 
          {
            cache_node_type: "cache.r3.8xlarge", 
            value: "24536678400", 
          }, 
          {
            cache_node_type: "cache.r3.large", 
            value: "1468006400", 
          }, 
          {
            cache_node_type: "cache.r3.xlarge", 
            value: "3040870400", 
          }, 
          {
            cache_node_type: "cache.t1.micro", 
            value: "14260633", 
          }, 
          {
            cache_node_type: "cache.t2.medium", 
            value: "346134937", 
          }, 
          {
            cache_node_type: "cache.t2.micro", 
            value: "58195968", 
          }, 
          {
            cache_node_type: "cache.t2.small", 
            value: "166513868", 
          }, 
        ], 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Slave client output buffer soft limit in bytes.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-slave-soft-limit", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        cache_node_type_specific_values: [
          {
            cache_node_type: "cache.c1.xlarge", 
            value: "6501171200", 
          }, 
          {
            cache_node_type: "cache.m1.large", 
            value: "7025459200", 
          }, 
          {
            cache_node_type: "cache.m1.medium", 
            value: "3093299200", 
          }, 
          {
            cache_node_type: "cache.m1.small", 
            value: "943718400", 
          }, 
          {
            cache_node_type: "cache.m1.xlarge", 
            value: "14889779200", 
          }, 
          {
            cache_node_type: "cache.m2.2xlarge", 
            value: "35022438400", 
          }, 
          {
            cache_node_type: "cache.m2.4xlarge", 
            value: "70883737600", 
          }, 
          {
            cache_node_type: "cache.m2.xlarge", 
            value: "17091788800", 
          }, 
          {
            cache_node_type: "cache.m3.2xlarge", 
            value: "29989273600", 
          }, 
          {
            cache_node_type: "cache.m3.large", 
            value: "6501171200", 
          }, 
          {
            cache_node_type: "cache.m3.medium", 
            value: "2988441600", 
          }, 
          {
            cache_node_type: "cache.m3.xlarge", 
            value: "14260633600", 
          }, 
          {
            cache_node_type: "cache.m4.10xlarge", 
            value: "166047614239", 
          }, 
          {
            cache_node_type: "cache.m4.2xlarge", 
            value: "31889126359", 
          }, 
          {
            cache_node_type: "cache.m4.4xlarge", 
            value: "65257290629", 
          }, 
          {
            cache_node_type: "cache.m4.large", 
            value: "6892593152", 
          }, 
          {
            cache_node_type: "cache.m4.xlarge", 
            value: "15328501760", 
          }, 
          {
            cache_node_type: "cache.r3.2xlarge", 
            value: "62495129600", 
          }, 
          {
            cache_node_type: "cache.r3.4xlarge", 
            value: "126458265600", 
          }, 
          {
            cache_node_type: "cache.r3.8xlarge", 
            value: "254384537600", 
          }, 
          {
            cache_node_type: "cache.r3.large", 
            value: "14470348800", 
          }, 
          {
            cache_node_type: "cache.r3.xlarge", 
            value: "30513561600", 
          }, 
          {
            cache_node_type: "cache.t1.micro", 
            value: "142606336", 
          }, 
          {
            cache_node_type: "cache.t2.medium", 
            value: "3461349376", 
          }, 
          {
            cache_node_type: "cache.t2.micro", 
            value: "581959680", 
          }, 
          {
            cache_node_type: "cache.t2.small", 
            value: "1665138688", 
          }, 
        ], 
        change_type: "immediate", 
        data_type: "integer", 
        description: "The maximum configurable amount of memory to use to store items, in bytes.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "maxmemory", 
        source: "system", 
      }, 
    ], 
    cache_parameter_group_family: "redis2.8", 
    marker: "bWluLXNsYXZlcy10by13cml0ZQ==", 
    parameters: [
      {
        allowed_values: "yes,no", 
        change_type: "requires-reboot", 
        data_type: "string", 
        description: "Apply rehashing or not.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "activerehashing", 
        parameter_value: "yes", 
        source: "system", 
      }, 
      {
        allowed_values: "always,everysec,no", 
        change_type: "immediate", 
        data_type: "string", 
        description: "fsync policy for AOF persistence", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "appendfsync", 
        parameter_value: "everysec", 
        source: "system", 
      }, 
      {
        allowed_values: "yes,no", 
        change_type: "immediate", 
        data_type: "string", 
        description: "Enable Redis persistence.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "appendonly", 
        parameter_value: "no", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Normal client output buffer hard limit in bytes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-normal-hard-limit", 
        parameter_value: "0", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Normal client output buffer soft limit in bytes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-normal-soft-limit", 
        parameter_value: "0", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Normal client output buffer soft limit in seconds.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-normal-soft-seconds", 
        parameter_value: "0", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Pubsub client output buffer hard limit in bytes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-pubsub-hard-limit", 
        parameter_value: "33554432", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Pubsub client output buffer soft limit in bytes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-pubsub-soft-limit", 
        parameter_value: "8388608", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Pubsub client output buffer soft limit in seconds.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-pubsub-soft-seconds", 
        parameter_value: "60", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Slave client output buffer soft limit in seconds.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "client-output-buffer-limit-slave-soft-seconds", 
        parameter_value: "60", 
        source: "system", 
      }, 
      {
        allowed_values: "yes,no", 
        change_type: "immediate", 
        data_type: "string", 
        description: "If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.23", 
        parameter_name: "close-on-slave-write", 
        parameter_value: "yes", 
        source: "system", 
      }, 
      {
        allowed_values: "1-1200000", 
        change_type: "requires-reboot", 
        data_type: "integer", 
        description: "Set the number of databases.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "databases", 
        parameter_value: "16", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "The maximum number of hash entries in order for the dataset to be compressed.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "hash-max-ziplist-entries", 
        parameter_value: "512", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "The threshold of biggest hash entries in order for the dataset to be compressed.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "hash-max-ziplist-value", 
        parameter_value: "64", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "The maximum number of list entries in order for the dataset to be compressed.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "list-max-ziplist-entries", 
        parameter_value: "512", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "The threshold of biggest list entries in order for the dataset to be compressed.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "list-max-ziplist-value", 
        parameter_value: "64", 
        source: "system", 
      }, 
      {
        allowed_values: "5000", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "lua-time-limit", 
        parameter_value: "5000", 
        source: "system", 
      }, 
      {
        allowed_values: "1-65000", 
        change_type: "requires-reboot", 
        data_type: "integer", 
        description: "The maximum number of Redis clients.", 
        is_modifiable: false, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "maxclients", 
        parameter_value: "65000", 
        source: "system", 
      }, 
      {
        allowed_values: "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction", 
        change_type: "immediate", 
        data_type: "string", 
        description: "Max memory policy.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "maxmemory-policy", 
        parameter_value: "volatile-lru", 
        source: "system", 
      }, 
      {
        allowed_values: "1-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Max memory samples.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "maxmemory-samples", 
        parameter_value: "3", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "min-slaves-max-lag", 
        parameter_value: "10", 
        source: "system", 
      }, 
      {
        allowed_values: "0-", 
        change_type: "immediate", 
        data_type: "integer", 
        description: "Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.", 
        is_modifiable: true, 
        minimum_engine_version: "2.8.6", 
        parameter_name: "min-slaves-to-write", 
        parameter_value: "0", 
        source: "system", 
      }, 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.describe_engine_default_parameters({
  cache_parameter_group_family: "String", # required
  max_records: 1,
  marker: "String",
})

Response structure


resp.engine_defaults.cache_parameter_group_family #=> String
resp.engine_defaults.marker #=> String
resp.engine_defaults.parameters #=> Array
resp.engine_defaults.parameters[0].parameter_name #=> String
resp.engine_defaults.parameters[0].parameter_value #=> String
resp.engine_defaults.parameters[0].description #=> String
resp.engine_defaults.parameters[0].source #=> String
resp.engine_defaults.parameters[0].data_type #=> String
resp.engine_defaults.parameters[0].allowed_values #=> String
resp.engine_defaults.parameters[0].is_modifiable #=> Boolean
resp.engine_defaults.parameters[0].minimum_engine_version #=> String
resp.engine_defaults.parameters[0].change_type #=> String, one of "immediate", "requires-reboot"
resp.engine_defaults.cache_node_type_specific_parameters #=> Array
resp.engine_defaults.cache_node_type_specific_parameters[0].parameter_name #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].description #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].source #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].data_type #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].allowed_values #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].is_modifiable #=> Boolean
resp.engine_defaults.cache_node_type_specific_parameters[0].minimum_engine_version #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].cache_node_type_specific_values #=> Array
resp.engine_defaults.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].cache_node_type #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].cache_node_type_specific_values[0].value #=> String
resp.engine_defaults.cache_node_type_specific_parameters[0].change_type #=> String, one of "immediate", "requires-reboot"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_family (required, String) —

    The name of the cache parameter group family.

    Valid values are: ‘memcached1.4` | `memcached1.5` | `memcached1.6` | `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | `redis6.x` | `redis6.2` | `redis7`

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



6532
6533
6534
6535
 
# File 'lib/aws-sdk-elasticache/client.rb', line 6532

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

#describe_events(params = {}) ⇒ Types::EventsMessage

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeEvents


# Describes all the cache-cluster events for the past 120 minutes.

resp = client.describe_events({
  duration: 360, 
  source_type: "cache-cluster", 
})

resp.to_h outputs the following:
{
  events: [
    {
      date: Time.parse("2016-12-22T16:27:56.088Z"), 
      message: "Added cache node 0001 in availability zone us-east-1e", 
      source_identifier: "redis-cluster", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:27:56.078Z"), 
      message: "Cache cluster created", 
      source_identifier: "redis-cluster", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.326Z"), 
      message: "Added cache node 0002 in availability zone us-east-1c", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.323Z"), 
      message: "Added cache node 0001 in availability zone us-east-1e", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.314Z"), 
      message: "Cache cluster created", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
  ], 
  marker: "", 
}

Example: DescribeEvents


# Describes all the replication-group events from 3:00P to 5:00P on November 11, 2016.

resp = client.describe_events({
  start_time: Time.parse("2016-12-22T15:00:00.000Z"), 
})

resp.to_h outputs the following:
{
  events: [
    {
      date: Time.parse("2016-12-22T21:35:46.674Z"), 
      message: "Snapshot succeeded for snapshot with ID 'cr-bkup' of replication group with ID 'clustered-redis'", 
      source_identifier: "clustered-redis-0001-001", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:27:56.088Z"), 
      message: "Added cache node 0001 in availability zone us-east-1e", 
      source_identifier: "redis-cluster", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:27:56.078Z"), 
      message: "Cache cluster created", 
      source_identifier: "redis-cluster", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.326Z"), 
      message: "Added cache node 0002 in availability zone us-east-1c", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.323Z"), 
      message: "Added cache node 0001 in availability zone us-east-1e", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
    {
      date: Time.parse("2016-12-22T16:05:17.314Z"), 
      message: "Cache cluster created", 
      source_identifier: "my-memcached2", 
      source_type: "cache-cluster", 
    }, 
  ], 
  marker: "", 
}

Request syntax with placeholder values


resp = client.describe_events({
  source_identifier: "String",
  source_type: "cache-cluster", # accepts cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group, replication-group, serverless-cache, serverless-cache-snapshot, user, user-group
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.events #=> Array
resp.events[0].source_identifier #=> String
resp.events[0].source_type #=> String, one of "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group", "replication-group", "serverless-cache", "serverless-cache-snapshot", "user", "user-group"
resp.events[0].message #=> String
resp.events[0].date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :source_identifier (String) —

    The identifier of the event source for which events are returned. If not specified, 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.

    Example: 2017-03-30T07:03:49.555Z

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

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

    Example: 2017-03-30T07:03:49.555Z

  • :duration (Integer) —

    The number of minutes worth of events to retrieve.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



6715
6716
6717
6718
 
# File 'lib/aws-sdk-elasticache/client.rb', line 6715

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

#describe_global_replication_groups(params = {}) ⇒ Types::DescribeGlobalReplicationGroupsResult

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_global_replication_groups({
  global_replication_group_id: "String",
  max_records: 1,
  marker: "String",
  show_member_info: false,
})

Response structure


resp.marker #=> String
resp.global_replication_groups #=> Array
resp.global_replication_groups[0].global_replication_group_id #=> String
resp.global_replication_groups[0].global_replication_group_description #=> String
resp.global_replication_groups[0].status #=> String
resp.global_replication_groups[0].cache_node_type #=> String
resp.global_replication_groups[0].engine #=> String
resp.global_replication_groups[0].engine_version #=> String
resp.global_replication_groups[0].members #=> Array
resp.global_replication_groups[0].members[0].replication_group_id #=> String
resp.global_replication_groups[0].members[0].replication_group_region #=> String
resp.global_replication_groups[0].members[0].role #=> String
resp.global_replication_groups[0].members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_groups[0].members[0].status #=> String
resp.global_replication_groups[0].cluster_enabled #=> Boolean
resp.global_replication_groups[0].global_node_groups #=> Array
resp.global_replication_groups[0].global_node_groups[0].global_node_group_id #=> String
resp.global_replication_groups[0].global_node_groups[0].slots #=> String
resp.global_replication_groups[0].auth_token_enabled #=> Boolean
resp.global_replication_groups[0].transit_encryption_enabled #=> Boolean
resp.global_replication_groups[0].at_rest_encryption_enabled #=> Boolean
resp.global_replication_groups[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (String) —

    The name of the Global datastore

  • :max_records (Integer) —

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

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

  • :show_member_info (Boolean) —

    Returns the list of members that comprise the Global datastore.

Returns:

See Also:



6787
6788
6789
6790
 
# File 'lib/aws-sdk-elasticache/client.rb', line 6787

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

#describe_replication_groups(params = {}) ⇒ Types::ReplicationGroupMessage

Returns information about a particular replication group. If no identifier is specified, ‘DescribeReplicationGroups` returns information about all replication groups.

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* replication_group_available
* replication_group_deleted

Examples:

Example: DescribeReplicationGroups


# Returns information about the replication group myreplgroup.

resp = client.describe_replication_groups({
})

resp.to_h outputs the following:
{
  marker: "", 
  replication_groups: [
    {
      automatic_failover: "enabled", 
      description: "Test cluster", 
      member_clusters: [
        "clustered-redis-0001-001", 
        "clustered-redis-0001-002", 
        "clustered-redis-0002-001", 
        "clustered-redis-0002-002", 
      ], 
      node_groups: [
        {
          node_group_id: "0001", 
          node_group_members: [
            {
              cache_cluster_id: "clustered-redis-0001-001", 
              cache_node_id: "0001", 
              preferred_availability_zone: "us-east-1e", 
            }, 
            {
              cache_cluster_id: "clustered-redis-0001-002", 
              cache_node_id: "0001", 
              preferred_availability_zone: "us-east-1c", 
            }, 
          ], 
          status: "available", 
        }, 
        {
          node_group_id: "0002", 
          node_group_members: [
            {
              cache_cluster_id: "clustered-redis-0002-001", 
              cache_node_id: "0001", 
              preferred_availability_zone: "us-east-1c", 
            }, 
            {
              cache_cluster_id: "clustered-redis-0002-002", 
              cache_node_id: "0001", 
              preferred_availability_zone: "us-east-1b", 
            }, 
          ], 
          status: "available", 
        }, 
      ], 
      pending_modified_values: {
      }, 
      replication_group_id: "clustered-redis", 
      status: "available", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_replication_groups({
  replication_group_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.replication_groups #=> Array
resp.replication_groups[0].replication_group_id #=> String
resp.replication_groups[0].description #=> String
resp.replication_groups[0].global_replication_group_info.global_replication_group_id #=> String
resp.replication_groups[0].global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_groups[0].status #=> String
resp.replication_groups[0].pending_modified_values.primary_cluster_id #=> String
resp.replication_groups[0].pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_groups[0].pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_groups[0].pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_groups[0].pending_modified_values.log_delivery_configurations #=> Array
resp.replication_groups[0].pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_groups[0].pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_groups[0].pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_groups[0].pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_groups[0].pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_groups[0].pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_groups[0].pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_groups[0].pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_groups[0].member_clusters #=> Array
resp.replication_groups[0].member_clusters[0] #=> String
resp.replication_groups[0].node_groups #=> Array
resp.replication_groups[0].node_groups[0].node_group_id #=> String
resp.replication_groups[0].node_groups[0].status #=> String
resp.replication_groups[0].node_groups[0].primary_endpoint.address #=> String
resp.replication_groups[0].node_groups[0].primary_endpoint.port #=> Integer
resp.replication_groups[0].node_groups[0].reader_endpoint.address #=> String
resp.replication_groups[0].node_groups[0].reader_endpoint.port #=> Integer
resp.replication_groups[0].node_groups[0].slots #=> String
resp.replication_groups[0].node_groups[0].node_group_members #=> Array
resp.replication_groups[0].node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_groups[0].node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_groups[0].node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_groups[0].node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_groups[0].node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_groups[0].node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_groups[0].node_groups[0].node_group_members[0].current_role #=> String
resp.replication_groups[0].snapshotting_cluster_id #=> String
resp.replication_groups[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_groups[0].multi_az #=> String, one of "enabled", "disabled"
resp.replication_groups[0].configuration_endpoint.address #=> String
resp.replication_groups[0].configuration_endpoint.port #=> Integer
resp.replication_groups[0].snapshot_retention_limit #=> Integer
resp.replication_groups[0].snapshot_window #=> String
resp.replication_groups[0].cluster_enabled #=> Boolean
resp.replication_groups[0].cache_node_type #=> String
resp.replication_groups[0].auth_token_enabled #=> Boolean
resp.replication_groups[0].auth_token_last_modified_date #=> Time
resp.replication_groups[0].transit_encryption_enabled #=> Boolean
resp.replication_groups[0].at_rest_encryption_enabled #=> Boolean
resp.replication_groups[0].member_clusters_outpost_arns #=> Array
resp.replication_groups[0].member_clusters_outpost_arns[0] #=> String
resp.replication_groups[0].kms_key_id #=> String
resp.replication_groups[0].arn #=> String
resp.replication_groups[0].user_group_ids #=> Array
resp.replication_groups[0].user_group_ids[0] #=> String
resp.replication_groups[0].log_delivery_configurations #=> Array
resp.replication_groups[0].log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_groups[0].log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_groups[0].log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_groups[0].log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_groups[0].log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_groups[0].log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_groups[0].log_delivery_configurations[0].message #=> String
resp.replication_groups[0].replication_group_create_time #=> Time
resp.replication_groups[0].data_tiering #=> String, one of "enabled", "disabled"
resp.replication_groups[0].auto_minor_version_upgrade #=> Boolean
resp.replication_groups[0].network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_groups[0].ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_groups[0].transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_groups[0].cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_groups[0].engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (String) —

    The identifier for the replication group to be described. This parameter is not case sensitive.

    If you do not specify this parameter, information about all replication groups is returned.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



6991
6992
6993
6994
 
# File 'lib/aws-sdk-elasticache/client.rb', line 6991

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

#describe_reserved_cache_nodes(params = {}) ⇒ Types::ReservedCacheNodeMessage

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeReservedCacheNodes


# Returns information about reserved cache nodes for this account, or about a specified reserved cache node. If the
# account has no reserved cache nodes, the operation returns an empty list, as shown here.

resp = client.describe_reserved_cache_nodes({
  max_records: 25, 
})

Request syntax with placeholder values


resp = client.describe_reserved_cache_nodes({
  reserved_cache_node_id: "String",
  reserved_cache_nodes_offering_id: "String",
  cache_node_type: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.reserved_cache_nodes #=> Array
resp.reserved_cache_nodes[0].reserved_cache_node_id #=> String
resp.reserved_cache_nodes[0].reserved_cache_nodes_offering_id #=> String
resp.reserved_cache_nodes[0].cache_node_type #=> String
resp.reserved_cache_nodes[0].start_time #=> Time
resp.reserved_cache_nodes[0].duration #=> Integer
resp.reserved_cache_nodes[0].fixed_price #=> Float
resp.reserved_cache_nodes[0].usage_price #=> Float
resp.reserved_cache_nodes[0].cache_node_count #=> Integer
resp.reserved_cache_nodes[0].product_description #=> String
resp.reserved_cache_nodes[0].offering_type #=> String
resp.reserved_cache_nodes[0].state #=> String
resp.reserved_cache_nodes[0].recurring_charges #=> Array
resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_cache_nodes[0].recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_cache_nodes[0].reservation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_cache_node_id (String) —

    The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

  • :reserved_cache_nodes_offering_id (String) —

    The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

  • :cache_node_type (String) —

    The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        **M7g node types**: ‘cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge`

        **M5 node types:** ‘cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge`

        **M4 node types:** ‘cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`

        **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): ‘cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium`

        **T3 node types:** ‘cache.t3.micro`, `cache.t3.small`, `cache.t3.medium`

        **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **T1 node types:** ‘cache.t1.micro`

        **M1 node types:** ‘cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge`

        **M3 node types:** ‘cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge`

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **C1 node types:** ‘cache.c1.xlarge`

    • Memory optimized:

      • Current generation:

        **R7g node types**: ‘cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge`

        **R5 node types:** ‘cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge`

        **R4 node types:** ‘cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

        **R3 node types:** ‘cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`

    **Additional node type info**

    • All current generation instance types are created in Amazon VPC by default.

    • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

    • The configuration variables ‘appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

  • :duration (String) —

    The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

    Valid Values: ‘1 | 3 | 31536000 | 94608000`

  • :product_description (String) —

    The product description filter value. Use this parameter to show only those reservations matching the specified product description.

  • :offering_type (String) —

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid values: ‘“Light Utilization”|“Medium Utilization”|“Heavy Utilization”|“All Upfront”|“Partial Upfront”| “No Upfront”`

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



7210
7211
7212
7213
 
# File 'lib/aws-sdk-elasticache/client.rb', line 7210

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

#describe_reserved_cache_nodes_offerings(params = {}) ⇒ Types::ReservedCacheNodesOfferingMessage

Lists available reserved cache node offerings.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeReseredCacheNodeOfferings


# Lists available reserved cache node offerings.

resp = client.describe_reserved_cache_nodes_offerings({
  max_records: 20, 
})

resp.to_h outputs the following:
{
  marker: "1ef01f5b-433f-94ff-a530-61a56bfc8e7a", 
  reserved_cache_nodes_offerings: [
    {
      cache_node_type: "cache.m1.small", 
      duration: 94608000, 
      fixed_price: 157.0, 
      offering_type: "Medium Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "0167633d-37f6-4222-b872-b1f22eb79ba4", 
      usage_price: 0.017, 
    }, 
    {
      cache_node_type: "cache.m4.xlarge", 
      duration: 94608000, 
      fixed_price: 1248.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.077, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "02c04e13-baca-4e71-9ceb-620eed94827d", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m2.4xlarge", 
      duration: 94608000, 
      fixed_price: 2381.0, 
      offering_type: "Medium Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "02e1755e-76e8-48e3-8d82-820a5726a458", 
      usage_price: 0.276, 
    }, 
    {
      cache_node_type: "cache.m1.small", 
      duration: 94608000, 
      fixed_price: 188.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.013, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "03315215-7b87-421a-a3dd-785021e4113f", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m4.10xlarge", 
      duration: 31536000, 
      fixed_price: 6158.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 1.125, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "05ffbb44-2ace-4476-a2a5-8ec99f866fb3", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m1.small", 
      duration: 31536000, 
      fixed_price: 101.0, 
      offering_type: "Medium Utilization", 
      product_description: "redis", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "065c71ae-4a4e-4f1e-bebf-37525f4c6cb2", 
      usage_price: 0.023, 
    }, 
    {
      cache_node_type: "cache.m1.medium", 
      duration: 94608000, 
      fixed_price: 314.0, 
      offering_type: "Medium Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "06774b12-7f5e-48c1-907a-f286c63f327d", 
      usage_price: 0.034, 
    }, 
    {
      cache_node_type: "cache.m2.xlarge", 
      duration: 31536000, 
      fixed_price: 163.0, 
      offering_type: "Light Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "0924ac6b-847f-4761-ba6b-4290b2adf719", 
      usage_price: 0.137, 
    }, 
    {
      cache_node_type: "cache.m2.xlarge", 
      duration: 94608000, 
      fixed_price: 719.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.049, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "09eeb126-69b6-4d3f-8f94-ca3510629f53", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.r3.2xlarge", 
      duration: 94608000, 
      fixed_price: 4132.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.182, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "0a516ad8-557f-4310-9dd0-2448c2ff4d62", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.c1.xlarge", 
      duration: 94608000, 
      fixed_price: 875.0, 
      offering_type: "Light Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "0b0c1cc5-2177-4150-95d7-c67ec34dcb19", 
      usage_price: 0.363, 
    }, 
    {
      cache_node_type: "cache.m4.10xlarge", 
      duration: 94608000, 
      fixed_price: 12483.0, 
      offering_type: "Heavy Utilization", 
      product_description: "memcached", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.76, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "0c2b139b-1cff-43d0-8fba-0c753f9b1950", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.c1.xlarge", 
      duration: 31536000, 
      fixed_price: 1620.0, 
      offering_type: "Heavy Utilization", 
      product_description: "memcached", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.207, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "0c52115b-38cb-47a2-8dbc-e02e40b6a13f", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m2.4xlarge", 
      duration: 94608000, 
      fixed_price: 2381.0, 
      offering_type: "Medium Utilization", 
      product_description: "redis", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "12fcb19c-5416-4e1d-934f-28f1e2cb8599", 
      usage_price: 0.276, 
    }, 
    {
      cache_node_type: "cache.m4.xlarge", 
      duration: 31536000, 
      fixed_price: 616.0, 
      offering_type: "Heavy Utilization", 
      product_description: "memcached", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.112, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "13af20ad-914d-4d8b-9763-fa2e565f3549", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.r3.8xlarge", 
      duration: 94608000, 
      fixed_price: 16528.0, 
      offering_type: "Heavy Utilization", 
      product_description: "memcached", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.729, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "14da3d3f-b526-4dbf-b09b-355578b2a576", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m1.medium", 
      duration: 94608000, 
      fixed_price: 140.0, 
      offering_type: "Light Utilization", 
      product_description: "redis", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "15d7018c-71fb-4717-8409-4bdcdca18da7", 
      usage_price: 0.052, 
    }, 
    {
      cache_node_type: "cache.m4.4xlarge", 
      duration: 94608000, 
      fixed_price: 4993.0, 
      offering_type: "Heavy Utilization", 
      product_description: "memcached", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.304, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "1ae7ec5f-a76e-49b6-822b-629b1768a13a", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.m3.2xlarge", 
      duration: 31536000, 
      fixed_price: 1772.0, 
      offering_type: "Heavy Utilization", 
      product_description: "redis", 
      recurring_charges: [
        {
          recurring_charge_amount: 0.25, 
          recurring_charge_frequency: "Hourly", 
        }, 
      ], 
      reserved_cache_nodes_offering_id: "1d31242b-3925-48d1-b882-ce03204e6013", 
      usage_price: 0.0, 
    }, 
    {
      cache_node_type: "cache.t1.micro", 
      duration: 31536000, 
      fixed_price: 54.0, 
      offering_type: "Medium Utilization", 
      product_description: "memcached", 
      recurring_charges: [
      ], 
      reserved_cache_nodes_offering_id: "1ef01f5b-94ff-433f-a530-61a56bfc8e7a", 
      usage_price: 0.008, 
    }, 
  ], 
}

Example: DescribeReseredCacheNodeOfferings


# Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.

resp = client.describe_reserved_cache_nodes_offerings({
  cache_node_type: "cache.r3.large", 
  duration: "3", 
  max_records: 25, 
  offering_type: "Light Utilization", 
  reserved_cache_nodes_offering_id: "", 
})

resp.to_h outputs the following:
{
  marker: "", 
  reserved_cache_nodes_offerings: [
  ], 
}

Example: DescribeReseredCacheNodeOfferings


# Lists available reserved cache node offerings.

resp = client.describe_reserved_cache_nodes_offerings({
  cache_node_type: "", 
  duration: "", 
  marker: "", 
  max_records: 25, 
  offering_type: "", 
  product_description: "", 
  reserved_cache_nodes_offering_id: "438012d3-4052-4cc7-b2e3-8d3372e0e706", 
})

resp.to_h outputs the following:
{
  marker: "", 
  reserved_cache_nodes_offerings: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_reserved_cache_nodes_offerings({
  reserved_cache_nodes_offering_id: "String",
  cache_node_type: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.reserved_cache_nodes_offerings #=> Array
resp.reserved_cache_nodes_offerings[0].reserved_cache_nodes_offering_id #=> String
resp.reserved_cache_nodes_offerings[0].cache_node_type #=> String
resp.reserved_cache_nodes_offerings[0].duration #=> Integer
resp.reserved_cache_nodes_offerings[0].fixed_price #=> Float
resp.reserved_cache_nodes_offerings[0].usage_price #=> Float
resp.reserved_cache_nodes_offerings[0].product_description #=> String
resp.reserved_cache_nodes_offerings[0].offering_type #=> String
resp.reserved_cache_nodes_offerings[0].recurring_charges #=> Array
resp.reserved_cache_nodes_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_cache_nodes_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_cache_nodes_offering_id (String) —

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

    Example: ‘438012d3-4052-4cc7-b2e3-8d3372e0e706`

  • :cache_node_type (String) —

    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        **M7g node types**: ‘cache.m7g.large`, `cache.m7g.xlarge`, `cache.m7g.2xlarge`, `cache.m7g.4xlarge`, `cache.m7g.8xlarge`, `cache.m7g.12xlarge`, `cache.m7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **M6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.m6g.large`, `cache.m6g.xlarge`, `cache.m6g.2xlarge`, `cache.m6g.4xlarge`, `cache.m6g.8xlarge`, `cache.m6g.12xlarge`, `cache.m6g.16xlarge`

        **M5 node types:** ‘cache.m5.large`, `cache.m5.xlarge`, `cache.m5.2xlarge`, `cache.m5.4xlarge`, `cache.m5.12xlarge`, `cache.m5.24xlarge`

        **M4 node types:** ‘cache.m4.large`, `cache.m4.xlarge`, `cache.m4.2xlarge`, `cache.m4.4xlarge`, `cache.m4.10xlarge`

        **T4g node types** (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): ‘cache.t4g.micro`, `cache.t4g.small`, `cache.t4g.medium`

        **T3 node types:** ‘cache.t3.micro`, `cache.t3.small`, `cache.t3.medium`

        **T2 node types:** ‘cache.t2.micro`, `cache.t2.small`, `cache.t2.medium`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **T1 node types:** ‘cache.t1.micro`

        **M1 node types:** ‘cache.m1.small`, `cache.m1.medium`, `cache.m1.large`, `cache.m1.xlarge`

        **M3 node types:** ‘cache.m3.medium`, `cache.m3.large`, `cache.m3.xlarge`, `cache.m3.2xlarge`

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **C1 node types:** ‘cache.c1.xlarge`

    • Memory optimized:

      • Current generation:

        **R7g node types**: ‘cache.r7g.large`, `cache.r7g.xlarge`, `cache.r7g.2xlarge`, `cache.r7g.4xlarge`, `cache.r7g.8xlarge`, `cache.r7g.12xlarge`, `cache.r7g.16xlarge`

        <note markdown=“1”> For region availability, see [Supported Node Types]

        </note>

        **R6g node types** (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): ‘cache.r6g.large`, `cache.r6g.xlarge`, `cache.r6g.2xlarge`, `cache.r6g.4xlarge`, `cache.r6g.8xlarge`, `cache.r6g.12xlarge`, `cache.r6g.16xlarge`

        **R5 node types:** ‘cache.r5.large`, `cache.r5.xlarge`, `cache.r5.2xlarge`, `cache.r5.4xlarge`, `cache.r5.12xlarge`, `cache.r5.24xlarge`

        **R4 node types:** ‘cache.r4.large`, `cache.r4.xlarge`, `cache.r4.2xlarge`, `cache.r4.4xlarge`, `cache.r4.8xlarge`, `cache.r4.16xlarge`

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        **M2 node types:** ‘cache.m2.xlarge`, `cache.m2.2xlarge`, `cache.m2.4xlarge`

        **R3 node types:** ‘cache.r3.large`, `cache.r3.xlarge`, `cache.r3.2xlarge`, `cache.r3.4xlarge`, `cache.r3.8xlarge`

    **Additional node type info**

    • All current generation instance types are created in Amazon VPC by default.

    • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

    • The configuration variables ‘appendonly` and `appendfsync` are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion

  • :duration (String) —

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

    Valid Values: ‘1 | 3 | 31536000 | 94608000`

  • :product_description (String) —

    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

  • :offering_type (String) —

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid Values: ‘“Light Utilization”|“Medium Utilization”|“Heavy Utilization” |“All Upfront”|“Partial Upfront”| “No Upfront”`

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



7731
7732
7733
7734
 
# File 'lib/aws-sdk-elasticache/client.rb', line 7731

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

#describe_serverless_cache_snapshots(params = {}) ⇒ Types::DescribeServerlessCacheSnapshotsResponse

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_serverless_cache_snapshots({
  serverless_cache_name: "String",
  serverless_cache_snapshot_name: "String",
  snapshot_type: "String",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.serverless_cache_snapshots #=> Array
resp.serverless_cache_snapshots[0].serverless_cache_snapshot_name #=> String
resp.serverless_cache_snapshots[0].arn #=> String
resp.serverless_cache_snapshots[0].kms_key_id #=> String
resp.serverless_cache_snapshots[0].snapshot_type #=> String
resp.serverless_cache_snapshots[0].status #=> String
resp.serverless_cache_snapshots[0].create_time #=> Time
resp.serverless_cache_snapshots[0].expiry_time #=> Time
resp.serverless_cache_snapshots[0].bytes_used_for_cache #=> String
resp.serverless_cache_snapshots[0].serverless_cache_configuration.serverless_cache_name #=> String
resp.serverless_cache_snapshots[0].serverless_cache_configuration.engine #=> String
resp.serverless_cache_snapshots[0].serverless_cache_configuration.major_engine_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_name (String) —

    The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :serverless_cache_snapshot_name (String) —

    The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :snapshot_type (String) —

    The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :next_token (String) —

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

  • :max_results (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

Returns:

See Also:



7808
7809
7810
7811
 
# File 'lib/aws-sdk-elasticache/client.rb', line 7808

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

#describe_serverless_caches(params = {}) ⇒ Types::DescribeServerlessCachesResponse

Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.serverless_caches #=> Array
resp.serverless_caches[0].serverless_cache_name #=> String
resp.serverless_caches[0].description #=> String
resp.serverless_caches[0].create_time #=> Time
resp.serverless_caches[0].status #=> String
resp.serverless_caches[0].engine #=> String
resp.serverless_caches[0].major_engine_version #=> String
resp.serverless_caches[0].full_engine_version #=> String
resp.serverless_caches[0].cache_usage_limits.data_storage.maximum #=> Integer
resp.serverless_caches[0].cache_usage_limits.data_storage.minimum #=> Integer
resp.serverless_caches[0].cache_usage_limits.data_storage.unit #=> String, one of "GB"
resp.serverless_caches[0].cache_usage_limits.ecpu_per_second.maximum #=> Integer
resp.serverless_caches[0].cache_usage_limits.ecpu_per_second.minimum #=> Integer
resp.serverless_caches[0].kms_key_id #=> String
resp.serverless_caches[0].security_group_ids #=> Array
resp.serverless_caches[0].security_group_ids[0] #=> String
resp.serverless_caches[0].endpoint.address #=> String
resp.serverless_caches[0].endpoint.port #=> Integer
resp.serverless_caches[0].reader_endpoint.address #=> String
resp.serverless_caches[0].reader_endpoint.port #=> Integer
resp.serverless_caches[0].arn #=> String
resp.serverless_caches[0].user_group_id #=> String
resp.serverless_caches[0].subnet_ids #=> Array
resp.serverless_caches[0].subnet_ids[0] #=> String
resp.serverless_caches[0].snapshot_retention_limit #=> Integer
resp.serverless_caches[0].daily_snapshot_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_name (String) —

    The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL

  • :max_results (Integer) —

    The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.

  • :next_token (String) —

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.

Returns:

See Also:



7883
7884
7885
7886
 
# File 'lib/aws-sdk-elasticache/client.rb', line 7883

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

#describe_service_updates(params = {}) ⇒ Types::ServiceUpdatesMessage

Returns details of the service updates

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_service_updates({
  service_update_name: "String",
  service_update_status: ["available"], # accepts available, cancelled, expired
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.service_updates #=> Array
resp.service_updates[0].service_update_name #=> String
resp.service_updates[0].service_update_release_date #=> Time
resp.service_updates[0].service_update_end_date #=> Time
resp.service_updates[0].service_update_severity #=> String, one of "critical", "important", "medium", "low"
resp.service_updates[0].service_update_recommended_apply_by_date #=> Time
resp.service_updates[0].service_update_status #=> String, one of "available", "cancelled", "expired"
resp.service_updates[0].service_update_description #=> String
resp.service_updates[0].service_update_type #=> String, one of "security-update"
resp.service_updates[0].engine #=> String
resp.service_updates[0].engine_version #=> String
resp.service_updates[0].auto_update_after_recommended_apply_by_date #=> Boolean
resp.service_updates[0].estimated_update_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_update_name (String) —

    The unique ID of the service update

  • :service_update_status (Array<String>) —

    The status of the service update

  • :max_records (Integer) —

    The maximum number of records to include in the response

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



7942
7943
7944
7945
 
# File 'lib/aws-sdk-elasticache/client.rb', line 7942

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

#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsListMessage

Returns information about cluster or replication group snapshots. By default, ‘DescribeSnapshots` lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: DescribeSnapshots


# Returns information about the snapshot mysnapshot. By default.

resp = client.describe_snapshots({
  snapshot_name: "snapshot-20161212", 
})

resp.to_h outputs the following:
{
  marker: "", 
  snapshots: [
    {
      auto_minor_version_upgrade: true, 
      cache_cluster_create_time: Time.parse("2016-12-21T22:27:12.543Z"), 
      cache_cluster_id: "my-redis5", 
      cache_node_type: "cache.m3.large", 
      cache_parameter_group_name: "default.redis3.2", 
      cache_subnet_group_name: "default", 
      engine: "redis", 
      engine_version: "3.2.4", 
      node_snapshots: [
        {
          cache_node_create_time: Time.parse("2016-12-21T22:27:12.543Z"), 
          cache_node_id: "0001", 
          cache_size: "3 MB", 
          snapshot_create_time: Time.parse("2016-12-21T22:30:26Z"), 
        }, 
      ], 
      num_cache_nodes: 1, 
      port: 6379, 
      preferred_availability_zone: "us-east-1c", 
      preferred_maintenance_window: "fri:05:30-fri:06:30", 
      snapshot_name: "snapshot-20161212", 
      snapshot_retention_limit: 7, 
      snapshot_source: "manual", 
      snapshot_status: "available", 
      snapshot_window: "10:00-11:00", 
      vpc_id: "vpc-91280df6", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_snapshots({
  replication_group_id: "String",
  cache_cluster_id: "String",
  snapshot_name: "String",
  snapshot_source: "String",
  marker: "String",
  max_records: 1,
  show_node_group_config: false,
})

Response structure


resp.marker #=> String
resp.snapshots #=> Array
resp.snapshots[0].snapshot_name #=> String
resp.snapshots[0].replication_group_id #=> String
resp.snapshots[0].replication_group_description #=> String
resp.snapshots[0].cache_cluster_id #=> String
resp.snapshots[0].snapshot_status #=> String
resp.snapshots[0].snapshot_source #=> String
resp.snapshots[0].cache_node_type #=> String
resp.snapshots[0].engine #=> String
resp.snapshots[0].engine_version #=> String
resp.snapshots[0].num_cache_nodes #=> Integer
resp.snapshots[0].preferred_availability_zone #=> String
resp.snapshots[0].preferred_outpost_arn #=> String
resp.snapshots[0].cache_cluster_create_time #=> Time
resp.snapshots[0].preferred_maintenance_window #=> String
resp.snapshots[0].topic_arn #=> String
resp.snapshots[0].port #=> Integer
resp.snapshots[0].cache_parameter_group_name #=> String
resp.snapshots[0].cache_subnet_group_name #=> String
resp.snapshots[0].vpc_id #=> String
resp.snapshots[0].auto_minor_version_upgrade #=> Boolean
resp.snapshots[0].snapshot_retention_limit #=> Integer
resp.snapshots[0].snapshot_window #=> String
resp.snapshots[0].num_node_groups #=> Integer
resp.snapshots[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.snapshots[0].node_snapshots #=> Array
resp.snapshots[0].node_snapshots[0].cache_cluster_id #=> String
resp.snapshots[0].node_snapshots[0].node_group_id #=> String
resp.snapshots[0].node_snapshots[0].cache_node_id #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.node_group_id #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.slots #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_count #=> Integer
resp.snapshots[0].node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
resp.snapshots[0].node_snapshots[0].cache_size #=> String
resp.snapshots[0].node_snapshots[0].cache_node_create_time #=> Time
resp.snapshots[0].node_snapshots[0].snapshot_create_time #=> Time
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].arn #=> String
resp.snapshots[0].data_tiering #=> String, one of "enabled", "disabled"

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (String) —

    A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

  • :cache_cluster_id (String) —

    A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

  • :snapshot_name (String) —

    A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

  • :snapshot_source (String) —

    If set to ‘system`, the output shows snapshots that were automatically created by ElastiCache. If set to `user` the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 50

    Constraints: minimum 20; maximum 50.

  • :show_node_group_config (Boolean) —

    A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

Returns:

See Also:



8110
8111
8112
8113
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8110

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

#describe_update_actions(params = {}) ⇒ Types::UpdateActionsMessage

Returns details of the update actions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_update_actions({
  service_update_name: "String",
  replication_group_ids: ["String"],
  cache_cluster_ids: ["String"],
  engine: "String",
  service_update_status: ["available"], # accepts available, cancelled, expired
  service_update_time_range: {
    start_time: Time.now,
    end_time: Time.now,
  },
  update_action_status: ["not-applied"], # accepts not-applied, waiting-to-start, in-progress, stopping, stopped, complete, scheduling, scheduled, not-applicable
  show_node_level_update_status: false,
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.update_actions #=> Array
resp.update_actions[0].replication_group_id #=> String
resp.update_actions[0].cache_cluster_id #=> String
resp.update_actions[0].service_update_name #=> String
resp.update_actions[0].service_update_release_date #=> Time
resp.update_actions[0].service_update_severity #=> String, one of "critical", "important", "medium", "low"
resp.update_actions[0].service_update_status #=> String, one of "available", "cancelled", "expired"
resp.update_actions[0].service_update_recommended_apply_by_date #=> Time
resp.update_actions[0].service_update_type #=> String, one of "security-update"
resp.update_actions[0].update_action_available_date #=> Time
resp.update_actions[0].update_action_status #=> String, one of "not-applied", "waiting-to-start", "in-progress", "stopping", "stopped", "complete", "scheduling", "scheduled", "not-applicable"
resp.update_actions[0].nodes_updated #=> String
resp.update_actions[0].update_action_status_modified_date #=> Time
resp.update_actions[0].sla_met #=> String, one of "yes", "no", "n/a"
resp.update_actions[0].node_group_update_status #=> Array
resp.update_actions[0].node_group_update_status[0].node_group_id #=> String
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status #=> Array
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].cache_cluster_id #=> String
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].cache_node_id #=> String
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_status #=> String, one of "not-applied", "waiting-to-start", "in-progress", "stopping", "stopped", "complete"
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_deletion_date #=> Time
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_start_date #=> Time
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_end_date #=> Time
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_initiated_by #=> String, one of "system", "customer"
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_initiated_date #=> Time
resp.update_actions[0].node_group_update_status[0].node_group_member_update_status[0].node_update_status_modified_date #=> Time
resp.update_actions[0].cache_node_update_status #=> Array
resp.update_actions[0].cache_node_update_status[0].cache_node_id #=> String
resp.update_actions[0].cache_node_update_status[0].node_update_status #=> String, one of "not-applied", "waiting-to-start", "in-progress", "stopping", "stopped", "complete"
resp.update_actions[0].cache_node_update_status[0].node_deletion_date #=> Time
resp.update_actions[0].cache_node_update_status[0].node_update_start_date #=> Time
resp.update_actions[0].cache_node_update_status[0].node_update_end_date #=> Time
resp.update_actions[0].cache_node_update_status[0].node_update_initiated_by #=> String, one of "system", "customer"
resp.update_actions[0].cache_node_update_status[0].node_update_initiated_date #=> Time
resp.update_actions[0].cache_node_update_status[0].node_update_status_modified_date #=> Time
resp.update_actions[0].estimated_update_time #=> String
resp.update_actions[0].engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_update_name (String) —

    The unique ID of the service update

  • :replication_group_ids (Array<String>) —

    The replication group IDs

  • :cache_cluster_ids (Array<String>) —

    The cache cluster IDs

  • :engine (String) —

    The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

  • :service_update_status (Array<String>) —

    The status of the service update

  • :service_update_time_range (Types::TimeRangeFilter) —

    The range of time specified to search for service updates that are in available status

  • :update_action_status (Array<String>) —

    The status of the update action.

  • :show_node_level_update_status (Boolean) —

    Dictates whether to include node level update status in the response

  • :max_records (Integer) —

    The maximum number of records to include in the response

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ‘MaxRecords`.

Returns:

See Also:



8222
8223
8224
8225
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8222

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

#describe_user_groups(params = {}) ⇒ Types::DescribeUserGroupsResult

Returns a list of user groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_user_groups({
  user_group_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.user_groups #=> Array
resp.user_groups[0].user_group_id #=> String
resp.user_groups[0].status #=> String
resp.user_groups[0].engine #=> String
resp.user_groups[0].user_ids #=> Array
resp.user_groups[0].user_ids[0] #=> String
resp.user_groups[0].minimum_engine_version #=> String
resp.user_groups[0].pending_changes.user_ids_to_remove #=> Array
resp.user_groups[0].pending_changes.user_ids_to_remove[0] #=> String
resp.user_groups[0].pending_changes.user_ids_to_add #=> Array
resp.user_groups[0].pending_changes.user_ids_to_add[0] #=> String
resp.user_groups[0].replication_groups #=> Array
resp.user_groups[0].replication_groups[0] #=> String
resp.user_groups[0].serverless_caches #=> Array
resp.user_groups[0].serverless_caches[0] #=> String
resp.user_groups[0].arn #=> String
resp.marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_group_id (String) —

    The ID of the user group.

  • :max_records (Integer) —

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

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. &gt;

Returns:

See Also:



8283
8284
8285
8286
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8283

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

#describe_users(params = {}) ⇒ Types::DescribeUsersResult

Returns a list of users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_users({
  engine: "EngineType",
  user_id: "UserId",
  filters: [
    {
      name: "FilterName", # required
      values: ["FilterValue"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

Response structure


resp.users #=> Array
resp.users[0].user_id #=> String
resp.users[0].user_name #=> String
resp.users[0].status #=> String
resp.users[0].engine #=> String
resp.users[0].minimum_engine_version #=> String
resp.users[0].access_string #=> String
resp.users[0].user_group_ids #=> Array
resp.users[0].user_group_ids[0] #=> String
resp.users[0].authentication.type #=> String, one of "password", "no-password", "iam"
resp.users[0].authentication.password_count #=> Integer
resp.users[0].arn #=> String
resp.marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine (String) —

    The engine.

  • :user_id (String) —

    The ID of the user.

  • :filters (Array<Types::Filter>) —

    Filter to determine the list of User IDs to return.

  • :max_records (Integer) —

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

  • :marker (String) —

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. &gt;

Returns:

See Also:



8353
8354
8355
8356
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8353

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

#disassociate_global_replication_group(params = {}) ⇒ Types::DisassociateGlobalReplicationGroupResult

Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

Examples:

Request syntax with placeholder values


resp = client.disassociate_global_replication_group({
  global_replication_group_id: "String", # required
  replication_group_id: "String", # required
  replication_group_region: "String", # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :replication_group_id (required, String) —

    The name of the secondary cluster you wish to remove from the Global datastore

  • :replication_group_region (required, String) —

    The Amazon region of secondary cluster you wish to remove from the Global datastore

Returns:

See Also:



8413
8414
8415
8416
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8413

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

#export_serverless_cache_snapshot(params = {}) ⇒ Types::ExportServerlessCacheSnapshotResponse

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.

Examples:

Request syntax with placeholder values


resp = client.export_serverless_cache_snapshot({
  serverless_cache_snapshot_name: "String", # required
  s3_bucket_name: "String", # required
})

Response structure


resp.serverless_cache_snapshot.serverless_cache_snapshot_name #=> String
resp.serverless_cache_snapshot.arn #=> String
resp.serverless_cache_snapshot.kms_key_id #=> String
resp.serverless_cache_snapshot.snapshot_type #=> String
resp.serverless_cache_snapshot.status #=> String
resp.serverless_cache_snapshot.create_time #=> Time
resp.serverless_cache_snapshot.expiry_time #=> Time
resp.serverless_cache_snapshot.bytes_used_for_cache #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.serverless_cache_name #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.engine #=> String
resp.serverless_cache_snapshot.serverless_cache_configuration.major_engine_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_snapshot_name (required, String) —

    The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.

  • :s3_bucket_name (required, String) —

    Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Valkey and Redis OSS only.

Returns:

See Also:



8459
8460
8461
8462
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8459

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

#failover_global_replication_group(params = {}) ⇒ Types::FailoverGlobalReplicationGroupResult

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

Examples:

Request syntax with placeholder values


resp = client.failover_global_replication_group({
  global_replication_group_id: "String", # required
  primary_region: "String", # required
  primary_replication_group_id: "String", # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :primary_region (required, String) —

    The Amazon region of the primary cluster of the Global datastore

  • :primary_replication_group_id (required, String) —

    The name of the primary replication group

Returns:

See Also:



8516
8517
8518
8519
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8516

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

#increase_node_groups_in_global_replication_group(params = {}) ⇒ Types::IncreaseNodeGroupsInGlobalReplicationGroupResult

Increase the number of node groups in the Global datastore

Examples:

Request syntax with placeholder values


resp = client.increase_node_groups_in_global_replication_group({
  global_replication_group_id: "String", # required
  node_group_count: 1, # required
  regional_configurations: [
    {
      replication_group_id: "String", # required
      replication_group_region: "String", # required
      resharding_configuration: [ # required
        {
          node_group_id: "AllowedNodeGroupId",
          preferred_availability_zones: ["String"],
        },
      ],
    },
  ],
  apply_immediately: false, # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :node_group_count (required, Integer) —

    Total number of node groups you want

  • :regional_configurations (Array<Types::RegionalConfiguration>) —

    Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

  • :apply_immediately (required, Boolean) —

    Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

Returns:

See Also:



8589
8590
8591
8592
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8589

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

#increase_replica_count(params = {}) ⇒ Types::IncreaseReplicaCountResult

Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Examples:

Request syntax with placeholder values


resp = client.increase_replica_count({
  replication_group_id: "String", # required
  new_replica_count: 1,
  replica_configuration: [
    {
      node_group_id: "AllowedNodeGroupId", # required
      new_replica_count: 1, # required
      preferred_availability_zones: ["String"],
      preferred_outpost_arns: ["String"],
    },
  ],
  apply_immediately: false, # required
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The id of the replication group to which you want to add replica nodes.

  • :new_replica_count (Integer) —

    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group’s node groups.

  • :replica_configuration (Array<Types::ConfigureShard>) —

    A list of ‘ConfigureShard` objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The `ConfigureShard` has three members: `NewReplicaCount`, `NodeGroupId`, and `PreferredAvailabilityZones`.

  • :apply_immediately (required, Boolean) —

    If ‘True`, the number of replica nodes is increased immediately. `ApplyImmediately=False` is not currently supported.

Returns:

See Also:



8724
8725
8726
8727
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8724

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

#list_allowed_node_type_modifications(params = {}) ⇒ Types::AllowedNodeTypeModificationsMessage

Lists all available node types that you can scale with your cluster’s replication group’s current node type.

When you use the ‘ModifyCacheCluster` or `ModifyReplicationGroup` operations to scale your cluster or replication group, the value of the `CacheNodeType` parameter must be one of the node types returned by this operation.

Examples:

Example: ListAllowedNodeTypeModifications


# Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

resp = client.list_allowed_node_type_modifications({
  replication_group_id: "myreplgroup", 
})

resp.to_h outputs the following:
{
  scale_up_modifications: [
    "cache.m4.10xlarge", 
    "cache.m4.2xlarge", 
    "cache.m4.4xlarge", 
    "cache.m4.xlarge", 
    "cache.r3.2xlarge", 
    "cache.r3.4xlarge", 
    "cache.r3.8xlarge", 
    "cache.r3.xlarge", 
  ], 
}

Example: ListAllowedNodeTypeModifications


# Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

resp = client.list_allowed_node_type_modifications({
  cache_cluster_id: "mycluster", 
})

resp.to_h outputs the following:
{
  scale_up_modifications: [
  ], 
}

Request syntax with placeholder values


resp = client.list_allowed_node_type_modifications({
  cache_cluster_id: "String",
  replication_group_id: "String",
})

Response structure


resp.scale_up_modifications #=> Array
resp.scale_up_modifications[0] #=> String
resp.scale_down_modifications #=> Array
resp.scale_down_modifications[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (String) —

    The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

    You must provide a value for either the ‘CacheClusterId` or the `ReplicationGroupId`.

  • :replication_group_id (String) —

    The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

    You must provide a value for either the ‘CacheClusterId` or the `ReplicationGroupId`.

Returns:

See Also:



8815
8816
8817
8818
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8815

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

#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage

Lists all tags currently on a named resource.

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions].

If the cluster is not in the available state, ‘ListTagsForResource` returns an error.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html

Examples:

Example: ListTagsForResource


# Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key
# is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

resp = client.list_tags_for_resource({
  resource_name: "arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster", 
})

resp.to_h outputs the following:
{
  tag_list: [
    {
      key: "APIVersion", 
      value: "20150202", 
    }, 
    {
      key: "Service", 
      value: "ElastiCache", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_name (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example ‘arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.

    For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces].

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

See Also:



8893
8894
8895
8896
 
# File 'lib/aws-sdk-elasticache/client.rb', line 8893

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

#modify_cache_cluster(params = {}) ⇒ Types::ModifyCacheClusterResult

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

Examples:

Example: ModifyCacheCluster


# Copies a snapshot to a specified name.

resp = client.modify_cache_cluster({
  apply_immediately: true, 
  cache_cluster_id: "redis-cluster", 
  snapshot_retention_limit: 14, 
})

resp.to_h outputs the following:
{
  cache_cluster: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2016-12-22T16:27:56.078Z"), 
    cache_cluster_id: "redis-cluster", 
    cache_cluster_status: "available", 
    cache_node_type: "cache.r3.large", 
    cache_parameter_group: {
      cache_node_ids_to_reboot: [
      ], 
      cache_parameter_group_name: "default.redis3.2", 
      parameter_apply_status: "in-sync", 
    }, 
    cache_security_groups: [
    ], 
    cache_subnet_group_name: "default", 
    client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
    engine: "redis", 
    engine_version: "3.2.4", 
    num_cache_nodes: 1, 
    pending_modified_values: {
    }, 
    preferred_availability_zone: "us-east-1e", 
    preferred_maintenance_window: "fri:09:00-fri:10:00", 
    snapshot_retention_limit: 14, 
    snapshot_window: "07:00-08:00", 
  }, 
}

Request syntax with placeholder values


resp = client.modify_cache_cluster({
  cache_cluster_id: "String", # required
  num_cache_nodes: 1,
  cache_node_ids_to_remove: ["String"],
  az_mode: "single-az", # accepts single-az, cross-az
  new_availability_zones: ["String"],
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  cache_parameter_group_name: "String",
  notification_topic_status: "String",
  apply_immediately: false,
  engine: "String",
  engine_version: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  cache_node_type: "String",
  auth_token: "String",
  auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
  log_delivery_configurations: [
    {
      log_type: "slow-log", # accepts slow-log, engine-log
      destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
      destination_details: {
        cloud_watch_logs_details: {
          log_group: "String",
        },
        kinesis_firehose_details: {
          delivery_stream: "String",
        },
      },
      log_format: "text", # accepts text, json
      enabled: false,
    },
  ],
  ip_discovery: "ipv4", # accepts ipv4, ipv6
})

Response structure


resp.cache_cluster.cache_cluster_id #=> String
resp.cache_cluster.configuration_endpoint.address #=> String
resp.cache_cluster.configuration_endpoint.port #=> Integer
resp.cache_cluster.client_download_landing_page #=> String
resp.cache_cluster.cache_node_type #=> String
resp.cache_cluster.engine #=> String
resp.cache_cluster.engine_version #=> String
resp.cache_cluster.cache_cluster_status #=> String
resp.cache_cluster.num_cache_nodes #=> Integer
resp.cache_cluster.preferred_availability_zone #=> String
resp.cache_cluster.preferred_outpost_arn #=> String
resp.cache_cluster.cache_cluster_create_time #=> Time
resp.cache_cluster.preferred_maintenance_window #=> String
resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove #=> Array
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove[0] #=> String
resp.cache_cluster.pending_modified_values.engine_version #=> String
resp.cache_cluster.pending_modified_values.cache_node_type #=> String
resp.cache_cluster.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.cache_cluster.pending_modified_values.log_delivery_configurations #=> Array
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.cache_cluster.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.cache_cluster.notification_configuration.topic_arn #=> String
resp.cache_cluster.notification_configuration.topic_status #=> String
resp.cache_cluster.cache_security_groups #=> Array
resp.cache_cluster.cache_security_groups[0].cache_security_group_name #=> String
resp.cache_cluster.cache_security_groups[0].status #=> String
resp.cache_cluster.cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_cluster.cache_parameter_group.parameter_apply_status #=> String
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot #=> Array
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot[0] #=> String
resp.cache_cluster.cache_subnet_group_name #=> String
resp.cache_cluster.cache_nodes #=> Array
resp.cache_cluster.cache_nodes[0].cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].cache_node_status #=> String
resp.cache_cluster.cache_nodes[0].cache_node_create_time #=> Time
resp.cache_cluster.cache_nodes[0].endpoint.address #=> String
resp.cache_cluster.cache_nodes[0].endpoint.port #=> Integer
resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
resp.cache_cluster.security_groups #=> Array
resp.cache_cluster.security_groups[0].security_group_id #=> String
resp.cache_cluster.security_groups[0].status #=> String
resp.cache_cluster.replication_group_id #=> String
resp.cache_cluster.snapshot_retention_limit #=> Integer
resp.cache_cluster.snapshot_window #=> String
resp.cache_cluster.auth_token_enabled #=> Boolean
resp.cache_cluster.auth_token_last_modified_date #=> Time
resp.cache_cluster.transit_encryption_enabled #=> Boolean
resp.cache_cluster.at_rest_encryption_enabled #=> Boolean
resp.cache_cluster.arn #=> String
resp.cache_cluster.replication_group_log_delivery_enabled #=> Boolean
resp.cache_cluster.log_delivery_configurations #=> Array
resp.cache_cluster.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.cache_cluster.log_delivery_configurations[0].message #=> String
resp.cache_cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_cluster.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.cache_cluster.transit_encryption_mode #=> String, one of "preferred", "required"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (required, String) —

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

  • :num_cache_nodes (Integer) —

    The number of cache nodes that the cluster should have. If the value for ‘NumCacheNodes` is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

    If you are removing cache nodes, you must use the ‘CacheNodeIdsToRemove` parameter to provide the IDs of the specific cache nodes to remove.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    <note markdown=“1”> Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ‘ApplyImmediately`).

    A pending operation to modify the number of cache nodes in a cluster

    during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer’s latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ‘ModifyCacheCluster` request and set `NumCacheNodes` equal to the number of cache nodes currently in the cluster.

    </note>
  • :cache_node_ids_to_remove (Array<String>) —

    A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when ‘NumCacheNodes` is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of `NumCacheNodes` in the request.

    For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ‘ModifyCacheCluster` call is 5, you must list 2 (7 - 5) cache node IDs to remove.

  • :az_mode (String) —

    Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

    Valid values: ‘single-az` | `cross-az`.

    This option is only supported for Memcached clusters.

    <note markdown=“1”> You cannot specify ‘single-az` if the Memcached cluster already has cache nodes in different Availability Zones. If `cross-az` is specified, existing Memcached nodes remain in their current Availability Zone.

    Only newly created nodes are located in different Availability Zones.

</note>
  • :new_availability_zones (Array<String>) —

    <note markdown=“1”> This option is only supported on Memcached clusters.

    </note>

    The list of Availability Zones where the new Memcached cache nodes are created.

    This parameter is only valid when ‘NumCacheNodes` in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

    Scenarios:

    • **Scenario 1:** You have 3 active nodes and wish to add 2 nodes. Specify ‘NumCacheNodes=5` (3 + 2) and optionally specify two Availability Zones for the two new nodes.

    • **Scenario 2:** You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify ‘NumCacheNodes=6` ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

    • **Scenario 3:** You want to cancel all pending operations. Specify ‘NumCacheNodes=3` to cancel all pending operations.

    The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting ‘NumCacheNodes` to the number of current nodes.

    If ‘cross-az` is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the **Availability Zone Considerations** section of [Cache Node Considerations for Memcached].

    **Impact of new add/remove requests upon pending requests**

    • Scenario-1

      • Pending Action: Delete

      • New Request: Delete

      • Result: The new delete, pending or immediate, replaces the pending delete.

    • Scenario-2

      • Pending Action: Delete

      • New Request: Create

      • Result: The new create, pending or immediate, replaces the pending delete.

    • Scenario-3

      • Pending Action: Create

      • New Request: Delete

      • Result: The new delete, pending or immediate, replaces the pending create.

    • Scenario-4

      • Pending Action: Create

      • New Request: Create

      • Result: The new create is added to the pending create.

        Important: If the new create request is **Apply Immediately - Yes**, all creates are performed immediately. If the new create request is **Apply Immediately - No**, all creates are pending.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html

  • :cache_security_group_names (Array<String>) —

    A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

    You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be “Default”.

  • :security_group_ids (Array<String>) —

    Specifies the VPC Security Groups associated with the cluster.

    This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • :preferred_maintenance_window (String) —

    Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30`

  • :notification_topic_arn (String) —

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

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

    </note>
  • :cache_parameter_group_name (String) —

    The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ‘ApplyImmediately` parameter is specified as `true` for this request.

  • :notification_topic_status (String) —

    The status of the Amazon SNS notification topic. Notifications are sent only if the status is ‘active`.

    Valid values: ‘active` | `inactive`

  • :apply_immediately (Boolean) —

    If ‘true`, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the cluster.

    If ‘false`, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    If you perform a ‘ModifyCacheCluster` before a pending modification is applied, the pending modification is replaced by the newer modification.

    Valid values: ‘true` | `false`

    Default: ‘false`

  • :engine (String) —

    Modifies the engine listed in a cluster message. The options are redis, memcached or valkey.

  • :engine_version (String) —

    The upgraded version of the cache engine to be run on the cache nodes.

    Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement

  • :auto_minor_version_upgrade (Boolean) —

     If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

  • :snapshot_retention_limit (Integer) —

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set ‘SnapshotRetentionLimit` to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    <note markdown=“1”> If the value of ‘SnapshotRetentionLimit` is set to zero (0), backups are turned off.

    </note>
  • :snapshot_window (String) —

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

  • :cache_node_type (String) —

    A valid cache node type that you want to scale this cluster up to.

  • :auth_token (String) —

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the ‘auth-token-update` parameter. Password constraints:

    • Must be only printable ASCII characters

    • Must be at least 16 characters and no more than 128 characters in length

    • Cannot contain any of the following characters: ‘/’, ‘“’, or ‘@’, ‘%’

    For more information, see AUTH password at [AUTH].

    [1]: redis.io/commands/AUTH

  • :auth_token_update_strategy (String) —

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the ‘auth-token` parameter. Possible values:

    • ROTATE - default, if no update strategy is provided

    • SET - allowed only after ROTATE

    • DELETE - allowed only when transitioning to RBAC

    For more information, see [Authenticating Users with AUTH]

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth.html

  • :log_delivery_configurations (Array<Types::LogDeliveryConfigurationRequest>) —

    Specifies the destination, format and type of the logs.

  • :ip_discovery (String) —

    The network type you choose when modifying a cluster, either ‘ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

Returns:

See Also:



9387
9388
9389
9390
 
# File 'lib/aws-sdk-elasticache/client.rb', line 9387

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

#modify_cache_parameter_group(params = {}) ⇒ Types::CacheParameterGroupNameMessage

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

Examples:

Example: ModifyCacheParameterGroup


# Modifies one or more parameter values in the specified parameter group. You cannot modify any default parameter group.

resp = client.modify_cache_parameter_group({
  cache_parameter_group_name: "custom-mem1-4", 
  parameter_name_values: [
    {
      parameter_name: "binding_protocol", 
      parameter_value: "ascii", 
    }, 
    {
      parameter_name: "chunk_size", 
      parameter_value: "96", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  cache_parameter_group_name: "custom-mem1-4", 
}

Request syntax with placeholder values


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

Response structure


resp.cache_parameter_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (required, String) —

    The name of the cache parameter group to modify.

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

    An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

Returns:

See Also:



9453
9454
9455
9456
 
# File 'lib/aws-sdk-elasticache/client.rb', line 9453

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

#modify_cache_subnet_group(params = {}) ⇒ Types::ModifyCacheSubnetGroupResult

Modifies an existing cache subnet group.

Examples:

Example: ModifyCacheSubnetGroup


# Modifies an existing ElastiCache subnet group.

resp = client.modify_cache_subnet_group({
  cache_subnet_group_name: "my-sn-grp", 
  subnet_ids: [
    "subnet-bcde2345", 
  ], 
})

resp.to_h outputs the following:
{
  cache_subnet_group: {
    cache_subnet_group_description: "My subnet group.", 
    cache_subnet_group_name: "my-sn-grp", 
    subnets: [
      {
        subnet_availability_zone: {
          name: "us-east-1c", 
        }, 
        subnet_identifier: "subnet-a1b2c3d4", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1e", 
        }, 
        subnet_identifier: "subnet-1a2b3c4d", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1e", 
        }, 
        subnet_identifier: "subnet-bcde2345", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1c", 
        }, 
        subnet_identifier: "subnet-1234abcd", 
      }, 
      {
        subnet_availability_zone: {
          name: "us-east-1b", 
        }, 
        subnet_identifier: "subnet-abcd1234", 
      }, 
    ], 
    vpc_id: "vpc-91280df6", 
  }, 
}

Request syntax with placeholder values


resp = client.modify_cache_subnet_group({
  cache_subnet_group_name: "String", # required
  cache_subnet_group_description: "String",
  subnet_ids: ["String"],
})

Response structure


resp.cache_subnet_group.cache_subnet_group_name #=> String
resp.cache_subnet_group.cache_subnet_group_description #=> String
resp.cache_subnet_group.vpc_id #=> String
resp.cache_subnet_group.subnets #=> Array
resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.cache_subnet_group.subnets[0].subnet_outpost.subnet_outpost_arn #=> String
resp.cache_subnet_group.subnets[0].supported_network_types #=> Array
resp.cache_subnet_group.subnets[0].supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_subnet_group.arn #=> String
resp.cache_subnet_group.supported_network_types #=> Array
resp.cache_subnet_group.supported_network_types[0] #=> String, one of "ipv4", "ipv6", "dual_stack"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_subnet_group_name (required, String) —

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

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: ‘mysubnetgroup`

  • :cache_subnet_group_description (String) —

    A description of the cache subnet group.

  • :subnet_ids (Array<String>) —

    The EC2 subnet IDs for the cache subnet group.

Returns:

See Also:



9559
9560
9561
9562
 
# File 'lib/aws-sdk-elasticache/client.rb', line 9559

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

#modify_global_replication_group(params = {}) ⇒ Types::ModifyGlobalReplicationGroupResult

Modifies the settings for a Global datastore.

Examples:

Request syntax with placeholder values


resp = client.modify_global_replication_group({
  global_replication_group_id: "String", # required
  apply_immediately: false, # required
  cache_node_type: "String",
  engine: "String",
  engine_version: "String",
  cache_parameter_group_name: "String",
  global_replication_group_description: "String",
  automatic_failover_enabled: false,
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :apply_immediately (required, Boolean) —

    This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

  • :cache_node_type (String) —

    A valid cache node type that you want to scale this Global datastore to.

  • :engine (String) —

    Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

  • :engine_version (String) —

    The upgraded version of the cache engine to be run on the clusters in the Global datastore.

  • :cache_parameter_group_name (String) —

    The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

  • :global_replication_group_description (String) —

    A description of the Global datastore

  • :automatic_failover_enabled (Boolean) —

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Returns:

See Also:



9643
9644
9645
9646
 
# File 'lib/aws-sdk-elasticache/client.rb', line 9643

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

#modify_replication_group(params = {}) ⇒ Types::ModifyReplicationGroupResult

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

  • Scaling for Valkey or Redis OSS (cluster mode enabled)][1

    in the

    ElastiCache User Guide

  • ModifyReplicationGroupShardConfiguration][2

    in the ElastiCache API

    Reference

<note markdown=“1”> This operation is valid for Valkey or Redis OSS only.

</note>

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/scaling-redis-cluster-mode-enabled.html [2]: docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html

Examples:

Example: ModifyReplicationGroup


resp = client.modify_replication_group({
  apply_immediately: true, 
  replication_group_description: "Modified replication group", 
  replication_group_id: "my-redis-rg", 
  snapshot_retention_limit: 30, 
  snapshotting_cluster_id: "my-redis-rg-001", 
})

resp.to_h outputs the following:
{
  replication_group: {
    automatic_failover: "enabled", 
    description: "Modified replication group", 
    member_clusters: [
      "my-redis-rg-001", 
      "my-redis-rg-002", 
      "my-redis-rg-003", 
    ], 
    node_groups: [
      {
        node_group_id: "0001", 
        node_group_members: [
          {
            cache_cluster_id: "my-redis-rg-001", 
            cache_node_id: "0001", 
            current_role: "primary", 
            preferred_availability_zone: "us-east-1b", 
            read_endpoint: {
              address: "my-redis-rg-001.abcdef.0001.use1.cache.amazonaws.com", 
              port: 6379, 
            }, 
          }, 
          {
            cache_cluster_id: "my-redis-rg-002", 
            cache_node_id: "0001", 
            current_role: "replica", 
            preferred_availability_zone: "us-east-1a", 
            read_endpoint: {
              address: "my-redis-rg-002.abcdef.0001.use1.cache.amazonaws.com", 
              port: 6379, 
            }, 
          }, 
          {
            cache_cluster_id: "my-redis-rg-003", 
            cache_node_id: "0001", 
            current_role: "replica", 
            preferred_availability_zone: "us-east-1c", 
            read_endpoint: {
              address: "my-redis-rg-003.abcdef.0001.use1.cache.amazonaws.com", 
              port: 6379, 
            }, 
          }, 
        ], 
        primary_endpoint: {
          address: "my-redis-rg.abcdef.ng.0001.use1.cache.amazonaws.com", 
          port: 6379, 
        }, 
        status: "available", 
      }, 
    ], 
    pending_modified_values: {
    }, 
    replication_group_id: "my-redis-rg", 
    snapshotting_cluster_id: "my-redis-rg-002", 
    status: "available", 
  }, 
}

Request syntax with placeholder values


resp = client.modify_replication_group({
  replication_group_id: "String", # required
  replication_group_description: "String",
  primary_cluster_id: "String",
  snapshotting_cluster_id: "String",
  automatic_failover_enabled: false,
  multi_az_enabled: false,
  node_group_id: "String",
  cache_security_group_names: ["String"],
  security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  notification_topic_arn: "String",
  cache_parameter_group_name: "String",
  notification_topic_status: "String",
  apply_immediately: false,
  engine: "String",
  engine_version: "String",
  auto_minor_version_upgrade: false,
  snapshot_retention_limit: 1,
  snapshot_window: "String",
  cache_node_type: "String",
  auth_token: "String",
  auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
  user_group_ids_to_add: ["UserGroupId"],
  user_group_ids_to_remove: ["UserGroupId"],
  remove_user_groups: false,
  log_delivery_configurations: [
    {
      log_type: "slow-log", # accepts slow-log, engine-log
      destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
      destination_details: {
        cloud_watch_logs_details: {
          log_group: "String",
        },
        kinesis_firehose_details: {
          delivery_stream: "String",
        },
      },
      log_format: "text", # accepts text, json
      enabled: false,
    },
  ],
  ip_discovery: "ipv4", # accepts ipv4, ipv6
  transit_encryption_enabled: false,
  transit_encryption_mode: "preferred", # accepts preferred, required
  cluster_mode: "enabled", # accepts enabled, disabled, compatible
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The identifier of the replication group to modify.

  • :replication_group_description (String) —

    A description for the replication group. Maximum length is 255 characters.

  • :primary_cluster_id (String) —

    For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

  • :snapshotting_cluster_id (String) —

    The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

  • :automatic_failover_enabled (Boolean) —

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    Valid values: ‘true` | `false`

  • :multi_az_enabled (Boolean) —

    A flag to indicate MultiAZ is enabled.

  • :node_group_id (String) —

    Deprecated. This parameter is not used.

  • :cache_security_group_names (Array<String>) —

    A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

    This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be ‘Default`.

  • :security_group_ids (Array<String>) —

    Specifies the VPC Security Groups associated with the clusters in the replication group.

    This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

  • :preferred_maintenance_window (String) —

    Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30`

  • :notification_topic_arn (String) —

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

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

    </note>
  • :cache_parameter_group_name (String) —

    The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ‘ApplyImmediately` parameter is specified as `true` for this request.

  • :notification_topic_status (String) —

    The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is ‘active`.

    Valid values: ‘active` | `inactive`

  • :apply_immediately (Boolean) —

    If ‘true`, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the replication group.

    If ‘false`, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    Valid values: ‘true` | `false`

    Default: ‘false`

  • :engine (String) —

    Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

  • :engine_version (String) —

    The upgraded version of the cache engine to be run on the clusters in the replication group.

    Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement

  • :auto_minor_version_upgrade (Boolean) —

     If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

  • :snapshot_retention_limit (Integer) —

    The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set ‘SnapshotRetentionLimit` to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

  • :snapshot_window (String) —

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by ‘SnapshottingClusterId`.

    Example: ‘05:00-09:00`

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

  • :cache_node_type (String) —

    A valid cache node type that you want to scale this replication group to.

  • :auth_token (String) —

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the ‘auth-token-update-strategy ` parameter. Password constraints:

    • Must be only printable ASCII characters

    • Must be at least 16 characters and no more than 128 characters in length

    • Cannot contain any of the following characters: ‘/’, ‘“’, or ‘@’, ‘%’

    For more information, see AUTH password at [AUTH].

    [1]: redis.io/commands/AUTH

  • :auth_token_update_strategy (String) —

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the ‘auth-token` parameter. Possible values:

    • ROTATE - default, if no update strategy is provided

    • SET - allowed only after ROTATE

    • DELETE - allowed only when transitioning to RBAC

    For more information, see [Authenticating Users with AUTH]

    [1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth.html

  • :user_group_ids_to_add (Array<String>) —

    The ID of the user group you are associating with the replication group.

  • :user_group_ids_to_remove (Array<String>) —

    The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.

  • :remove_user_groups (Boolean) —

    Removes the user group associated with this replication group.

  • :log_delivery_configurations (Array<Types::LogDeliveryConfigurationRequest>) —

    Specifies the destination, format and type of the logs.

  • :ip_discovery (String) —

    The network type you choose when modifying a cluster, either ‘ipv4` | `ipv6`. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system].

    [1]: aws.amazon.com/ec2/nitro/

  • :transit_encryption_enabled (Boolean) —

    A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set ‘TransitEncryptionMode` to `preferred`.

  • :transit_encryption_mode (String) —

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    You must set ‘TransitEncryptionEnabled` to `true`, for your existing cluster, and set `TransitEncryptionMode` to `preferred` in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to `required` to allow encrypted connections only.

    Setting ‘TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`.

  • :cluster_mode (String) —

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

Returns:

See Also:



10118
10119
10120
10121
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10118

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

#modify_replication_group_shard_configuration(params = {}) ⇒ Types::ModifyReplicationGroupShardConfigurationResult

Modifies a replication group’s shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Examples:

Request syntax with placeholder values


resp = client.modify_replication_group_shard_configuration({
  replication_group_id: "String", # required
  node_group_count: 1, # required
  apply_immediately: false, # required
  resharding_configuration: [
    {
      node_group_id: "AllowedNodeGroupId",
      preferred_availability_zones: ["String"],
    },
  ],
  node_groups_to_remove: ["AllowedNodeGroupId"],
  node_groups_to_retain: ["AllowedNodeGroupId"],
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

  • :node_group_count (required, Integer) —

    The number of node groups (shards) that results from the modification of the shard configuration.

  • :apply_immediately (required, Boolean) —

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is ‘true`.

    Value: true

  • :resharding_configuration (Array<Types::ReshardingConfiguration>) —

    Specifies the preferred availability zones for each node group in the cluster. If the value of ‘NodeGroupCount` is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster’s shards. If you omit this parameter ElastiCache selects availability zones for you.

    You can specify this parameter only if the value of ‘NodeGroupCount` is greater than the current number of node groups (shards).

  • :node_groups_to_remove (Array<String>) —

    If the value of ‘NodeGroupCount` is less than the current number of node groups (shards), then either `NodeGroupsToRemove` or `NodeGroupsToRetain` is required. `NodeGroupsToRemove` is a list of `NodeGroupId`s to remove from the cluster.

    ElastiCache will attempt to remove all node groups listed by ‘NodeGroupsToRemove` from the cluster.

  • :node_groups_to_retain (Array<String>) —

    If the value of ‘NodeGroupCount` is less than the current number of node groups (shards), then either `NodeGroupsToRemove` or `NodeGroupsToRetain` is required. `NodeGroupsToRetain` is a list of `NodeGroupId`s to retain in the cluster.

    ElastiCache will attempt to remove all node groups except those listed by ‘NodeGroupsToRetain` from the cluster.

Returns:

See Also:



10271
10272
10273
10274
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10271

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

#modify_serverless_cache(params = {}) ⇒ Types::ModifyServerlessCacheResponse

This API modifies the attributes of a serverless cache.

Examples:

Request syntax with placeholder values


resp = client.modify_serverless_cache({
  serverless_cache_name: "String", # required
  description: "String",
  cache_usage_limits: {
    data_storage: {
      maximum: 1,
      minimum: 1,
      unit: "GB", # required, accepts GB
    },
    ecpu_per_second: {
      maximum: 1,
      minimum: 1,
    },
  },
  remove_user_group: false,
  user_group_id: "String",
  security_group_ids: ["String"],
  snapshot_retention_limit: 1,
  daily_snapshot_time: "String",
  engine: "String",
  major_engine_version: "String",
})

Response structure


resp.serverless_cache.serverless_cache_name #=> String
resp.serverless_cache.description #=> String
resp.serverless_cache.create_time #=> Time
resp.serverless_cache.status #=> String
resp.serverless_cache.engine #=> String
resp.serverless_cache.major_engine_version #=> String
resp.serverless_cache.full_engine_version #=> String
resp.serverless_cache.cache_usage_limits.data_storage.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.minimum #=> Integer
resp.serverless_cache.cache_usage_limits.data_storage.unit #=> String, one of "GB"
resp.serverless_cache.cache_usage_limits.ecpu_per_second.maximum #=> Integer
resp.serverless_cache.cache_usage_limits.ecpu_per_second.minimum #=> Integer
resp.serverless_cache.kms_key_id #=> String
resp.serverless_cache.security_group_ids #=> Array
resp.serverless_cache.security_group_ids[0] #=> String
resp.serverless_cache.endpoint.address #=> String
resp.serverless_cache.endpoint.port #=> Integer
resp.serverless_cache.reader_endpoint.address #=> String
resp.serverless_cache.reader_endpoint.port #=> Integer
resp.serverless_cache.arn #=> String
resp.serverless_cache.user_group_id #=> String
resp.serverless_cache.subnet_ids #=> Array
resp.serverless_cache.subnet_ids[0] #=> String
resp.serverless_cache.snapshot_retention_limit #=> Integer
resp.serverless_cache.daily_snapshot_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :serverless_cache_name (required, String) —

    User-provided identifier for the serverless cache to be modified.

  • :description (String) —

    User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

  • :cache_usage_limits (Types::CacheUsageLimits) —

    Modify the cache usage limit for the serverless cache.

  • :remove_user_group (Boolean) —

    The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

  • :user_group_id (String) —

    The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.

  • :security_group_ids (Array<String>) —

    The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

  • :snapshot_retention_limit (Integer) —

    The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

  • :daily_snapshot_time (String) —

    The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

  • :engine (String) —

    Modifies the engine listed in a serverless cache request. The options are redis, memcached or valkey.

  • :major_engine_version (String) —

    Modifies the engine vesion listed in a serverless cache request.

Returns:

See Also:



10387
10388
10389
10390
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10387

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

#modify_user(params = {}) ⇒ Types::User

Changes user password(s) and/or access string.

Examples:

Request syntax with placeholder values


resp = client.modify_user({
  user_id: "UserId", # required
  access_string: "AccessString",
  append_access_string: "AccessString",
  passwords: ["String"],
  no_password_required: false,
  authentication_mode: {
    type: "password", # accepts password, no-password-required, iam
    passwords: ["String"],
  },
  engine: "EngineType",
})

Response structure


resp.user_id #=> String
resp.user_name #=> String
resp.status #=> String
resp.engine #=> String
resp.minimum_engine_version #=> String
resp.access_string #=> String
resp.user_group_ids #=> Array
resp.user_group_ids[0] #=> String
resp.authentication.type #=> String, one of "password", "no-password", "iam"
resp.authentication.password_count #=> Integer
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_id (required, String) —

    The ID of the user.

  • :access_string (String) —

    Access permissions string used for this user.

  • :append_access_string (String) —

    Adds additional user permissions to the access string.

  • :passwords (Array<String>) —

    The passwords belonging to the user. You are allowed up to two.

  • :no_password_required (Boolean) —

    Indicates no password is required for the user.

  • :authentication_mode (Types::AuthenticationMode) —

    Specifies how to authenticate the user.

  • :engine (String) —

    Modifies the engine listed for a user. The options are valkey or redis.

Returns:

See Also:



10461
10462
10463
10464
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10461

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

#modify_user_group(params = {}) ⇒ Types::UserGroup

Changes the list of users that belong to the user group.

Examples:

Request syntax with placeholder values


resp = client.modify_user_group({
  user_group_id: "String", # required
  user_ids_to_add: ["UserId"],
  user_ids_to_remove: ["UserId"],
  engine: "EngineType",
})

Response structure


resp.user_group_id #=> String
resp.status #=> String
resp.engine #=> String
resp.user_ids #=> Array
resp.user_ids[0] #=> String
resp.minimum_engine_version #=> String
resp.pending_changes.user_ids_to_remove #=> Array
resp.pending_changes.user_ids_to_remove[0] #=> String
resp.pending_changes.user_ids_to_add #=> Array
resp.pending_changes.user_ids_to_add[0] #=> String
resp.replication_groups #=> Array
resp.replication_groups[0] #=> String
resp.serverless_caches #=> Array
resp.serverless_caches[0] #=> String
resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_group_id (required, String) —

    The ID of the user group.

  • :user_ids_to_add (Array<String>) —

    The list of user IDs to add to the user group.

  • :user_ids_to_remove (Array<String>) —

    The list of user IDs to remove from the user group.

  • :engine (String) —

    Modifies the engine listed in a user group. The options are valkey or redis.

Returns:

See Also:



10524
10525
10526
10527
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10524

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

#purchase_reserved_cache_nodes_offering(params = {}) ⇒ Types::PurchaseReservedCacheNodesOfferingResult

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see [Managing Costs with Reserved Nodes].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/reserved-nodes.html

Examples:

Example: PurchaseReservedCacheNodesOfferings


# Allows you to purchase a reserved cache node offering.

resp = client.purchase_reserved_cache_nodes_offering({
  reserved_cache_nodes_offering_id: "1ef01f5b-94ff-433f-a530-61a56bfc8e7a", 
})

Request syntax with placeholder values


resp = client.purchase_reserved_cache_nodes_offering({
  reserved_cache_nodes_offering_id: "String", # required
  reserved_cache_node_id: "String",
  cache_node_count: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.reserved_cache_node.reserved_cache_node_id #=> String
resp.reserved_cache_node.reserved_cache_nodes_offering_id #=> String
resp.reserved_cache_node.cache_node_type #=> String
resp.reserved_cache_node.start_time #=> Time
resp.reserved_cache_node.duration #=> Integer
resp.reserved_cache_node.fixed_price #=> Float
resp.reserved_cache_node.usage_price #=> Float
resp.reserved_cache_node.cache_node_count #=> Integer
resp.reserved_cache_node.product_description #=> String
resp.reserved_cache_node.offering_type #=> String
resp.reserved_cache_node.state #=> String
resp.reserved_cache_node.recurring_charges #=> Array
resp.reserved_cache_node.recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_cache_node.recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_cache_node.reservation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_cache_nodes_offering_id (required, String) —

    The ID of the reserved cache node offering to purchase.

    Example: ‘438012d3-4052-4cc7-b2e3-8d3372e0e706`

  • :reserved_cache_node_id (String) —

    A customer-specified identifier to track this reservation.

    <note markdown=“1”> The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

    </note>

    Example: myreservationID

  • :cache_node_count (Integer) —

    The number of cache node instances to reserve.

    Default: ‘1`

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

See Also:



10612
10613
10614
10615
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10612

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

#rebalance_slots_in_global_replication_group(params = {}) ⇒ Types::RebalanceSlotsInGlobalReplicationGroupResult

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

Examples:

Request syntax with placeholder values


resp = client.rebalance_slots_in_global_replication_group({
  global_replication_group_id: "String", # required
  apply_immediately: false, # required
})

Response structure


resp.global_replication_group.global_replication_group_id #=> String
resp.global_replication_group.global_replication_group_description #=> String
resp.global_replication_group.status #=> String
resp.global_replication_group.cache_node_type #=> String
resp.global_replication_group.engine #=> String
resp.global_replication_group.engine_version #=> String
resp.global_replication_group.members #=> Array
resp.global_replication_group.members[0].replication_group_id #=> String
resp.global_replication_group.members[0].replication_group_region #=> String
resp.global_replication_group.members[0].role #=> String
resp.global_replication_group.members[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.global_replication_group.members[0].status #=> String
resp.global_replication_group.cluster_enabled #=> Boolean
resp.global_replication_group.global_node_groups #=> Array
resp.global_replication_group.global_node_groups[0].global_node_group_id #=> String
resp.global_replication_group.global_node_groups[0].slots #=> String
resp.global_replication_group.auth_token_enabled #=> Boolean
resp.global_replication_group.transit_encryption_enabled #=> Boolean
resp.global_replication_group.at_rest_encryption_enabled #=> Boolean
resp.global_replication_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_replication_group_id (required, String) —

    The name of the Global datastore

  • :apply_immediately (required, Boolean) —

    If ‘True`, redistribution is applied immediately.

Returns:

See Also:



10664
10665
10666
10667
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10664

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

#reboot_cache_cluster(params = {}) ⇒ Types::RebootCacheClusterResult

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.

If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see [Rebooting a Cluster] for an alternate process.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/nodes.rebooting.html

Examples:

Example: RebootCacheCluster


# Reboots the specified nodes in the names cluster.

resp = client.reboot_cache_cluster({
  cache_cluster_id: "custom-mem1-4  ", 
  cache_node_ids_to_reboot: [
    "0001", 
    "0002", 
  ], 
})

resp.to_h outputs the following:
{
  cache_cluster: {
    auto_minor_version_upgrade: true, 
    cache_cluster_create_time: Time.parse("2016-12-21T21:59:43.794Z"), 
    cache_cluster_id: "my-mem-cluster", 
    cache_cluster_status: "rebooting cache cluster nodes", 
    cache_node_type: "cache.t2.medium", 
    cache_parameter_group: {
      cache_node_ids_to_reboot: [
      ], 
      cache_parameter_group_name: "default.memcached1.4", 
      parameter_apply_status: "in-sync", 
    }, 
    cache_security_groups: [
    ], 
    cache_subnet_group_name: "default", 
    client_download_landing_page: "https://console.aws.amazon.com/elasticache/home#client-download:", 
    configuration_endpoint: {
      address: "my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com", 
      port: 11211, 
    }, 
    engine: "memcached", 
    engine_version: "1.4.24", 
    num_cache_nodes: 2, 
    pending_modified_values: {
    }, 
    preferred_availability_zone: "Multiple", 
    preferred_maintenance_window: "wed:06:00-wed:07:00", 
  }, 
}

Request syntax with placeholder values


resp = client.reboot_cache_cluster({
  cache_cluster_id: "String", # required
  cache_node_ids_to_reboot: ["String"], # required
})

Response structure


resp.cache_cluster.cache_cluster_id #=> String
resp.cache_cluster.configuration_endpoint.address #=> String
resp.cache_cluster.configuration_endpoint.port #=> Integer
resp.cache_cluster.client_download_landing_page #=> String
resp.cache_cluster.cache_node_type #=> String
resp.cache_cluster.engine #=> String
resp.cache_cluster.engine_version #=> String
resp.cache_cluster.cache_cluster_status #=> String
resp.cache_cluster.num_cache_nodes #=> Integer
resp.cache_cluster.preferred_availability_zone #=> String
resp.cache_cluster.preferred_outpost_arn #=> String
resp.cache_cluster.cache_cluster_create_time #=> Time
resp.cache_cluster.preferred_maintenance_window #=> String
resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove #=> Array
resp.cache_cluster.pending_modified_values.cache_node_ids_to_remove[0] #=> String
resp.cache_cluster.pending_modified_values.engine_version #=> String
resp.cache_cluster.pending_modified_values.cache_node_type #=> String
resp.cache_cluster.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.cache_cluster.pending_modified_values.log_delivery_configurations #=> Array
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.cache_cluster.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.cache_cluster.notification_configuration.topic_arn #=> String
resp.cache_cluster.notification_configuration.topic_status #=> String
resp.cache_cluster.cache_security_groups #=> Array
resp.cache_cluster.cache_security_groups[0].cache_security_group_name #=> String
resp.cache_cluster.cache_security_groups[0].status #=> String
resp.cache_cluster.cache_parameter_group.cache_parameter_group_name #=> String
resp.cache_cluster.cache_parameter_group.parameter_apply_status #=> String
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot #=> Array
resp.cache_cluster.cache_parameter_group.cache_node_ids_to_reboot[0] #=> String
resp.cache_cluster.cache_subnet_group_name #=> String
resp.cache_cluster.cache_nodes #=> Array
resp.cache_cluster.cache_nodes[0].cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].cache_node_status #=> String
resp.cache_cluster.cache_nodes[0].cache_node_create_time #=> Time
resp.cache_cluster.cache_nodes[0].endpoint.address #=> String
resp.cache_cluster.cache_nodes[0].endpoint.port #=> Integer
resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
resp.cache_cluster.security_groups #=> Array
resp.cache_cluster.security_groups[0].security_group_id #=> String
resp.cache_cluster.security_groups[0].status #=> String
resp.cache_cluster.replication_group_id #=> String
resp.cache_cluster.snapshot_retention_limit #=> Integer
resp.cache_cluster.snapshot_window #=> String
resp.cache_cluster.auth_token_enabled #=> Boolean
resp.cache_cluster.auth_token_last_modified_date #=> Time
resp.cache_cluster.transit_encryption_enabled #=> Boolean
resp.cache_cluster.at_rest_encryption_enabled #=> Boolean
resp.cache_cluster.arn #=> String
resp.cache_cluster.replication_group_log_delivery_enabled #=> Boolean
resp.cache_cluster.log_delivery_configurations #=> Array
resp.cache_cluster.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.cache_cluster.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.cache_cluster.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.cache_cluster.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.cache_cluster.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.cache_cluster.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.cache_cluster.log_delivery_configurations[0].message #=> String
resp.cache_cluster.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.cache_cluster.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.cache_cluster.transit_encryption_mode #=> String, one of "preferred", "required"

Parameters:

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

    ({})

Options Hash (params):

  • :cache_cluster_id (required, String) —

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

  • :cache_node_ids_to_reboot (required, Array<String>) —

    A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

Returns:

See Also:



10835
10836
10837
10838
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10835

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

#remove_tags_from_resource(params = {}) ⇒ Types::TagListMessage

Removes the tags identified by the ‘TagKeys` list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see [Resource-level permissions].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/IAM.ResourceLevelPermissions.html

Examples:

Example: RemoveTagsFromResource


# Removes tags identified by a list of tag keys from the list of tags on the specified resource.

resp = client.remove_tags_from_resource({
  resource_name: "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster", 
  tag_keys: [
    "A", 
    "C", 
    "E", 
  ], 
})

resp.to_h outputs the following:
{
  tag_list: [
    {
      key: "B", 
      value: "Banana", 
    }, 
    {
      key: "D", 
      value: "Dog", 
    }, 
    {
      key: "F", 
      value: "Fox", 
    }, 
    {
      key: "I", 
      value: "", 
    }, 
    {
      key: "K", 
      value: "Kite", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_name (required, String) —

    The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example ‘arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.

    For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces].

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :tag_keys (required, Array<String>) —

    A list of ‘TagKeys` identifying the tags you want removed from the named resource.

Returns:

See Also:



10930
10931
10932
10933
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10930

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

#reset_cache_parameter_group(params = {}) ⇒ Types::CacheParameterGroupNameMessage

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ‘ResetAllParameters` and `CacheParameterGroupName` parameters.

Examples:

Example: ResetCacheParameterGroup


# Modifies the parameters of a cache parameter group to the engine or system default value.

resp = client.reset_cache_parameter_group({
  cache_parameter_group_name: "custom-mem1-4", 
  reset_all_parameters: true, 
})

resp.to_h outputs the following:
{
  cache_parameter_group_name: "custom-mem1-4", 
}

Request syntax with placeholder values


resp = client.reset_cache_parameter_group({
  cache_parameter_group_name: "String", # required
  reset_all_parameters: false,
  parameter_name_values: [
    {
      parameter_name: "String",
      parameter_value: "String",
    },
  ],
})

Response structure


resp.cache_parameter_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_parameter_group_name (required, String) —

    The name of the cache parameter group to reset.

  • :reset_all_parameters (Boolean) —

    If ‘true`, all parameters in the cache parameter group are reset to their default values. If `false`, only the parameters listed by `ParameterNameValues` are reset to their default values.

    Valid values: ‘true` | `false`

  • :parameter_name_values (Array<Types::ParameterNameValue>) —

    An array of parameter names to reset to their default values. If ‘ResetAllParameters` is `true`, do not use `ParameterNameValues`. If `ResetAllParameters` is `false`, you must specify the name of at least one parameter to reset.

Returns:

See Also:



10997
10998
10999
11000
 
# File 'lib/aws-sdk-elasticache/client.rb', line 10997

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

#revoke_cache_security_group_ingress(params = {}) ⇒ Types::RevokeCacheSecurityGroupIngressResult

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

Examples:

Example: DescribeCacheSecurityGroups


# Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only
# the description of that group.

resp = client.revoke_cache_security_group_ingress({
  cache_security_group_name: "my-sec-grp", 
  ec2_security_group_name: "my-ec2-sec-grp", 
  ec2_security_group_owner_id: "1234567890", 
})

Request syntax with placeholder values


resp = client.revoke_cache_security_group_ingress({
  cache_security_group_name: "String", # required
  ec2_security_group_name: "String", # required
  ec2_security_group_owner_id: "String", # required
})

Response structure


resp.cache_security_group.owner_id #=> String
resp.cache_security_group.cache_security_group_name #=> String
resp.cache_security_group.description #=> String
resp.cache_security_group.ec2_security_groups #=> Array
resp.cache_security_group.ec2_security_groups[0].status #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cache_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cache_security_group.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cache_security_group_name (required, String) —

    The name of the cache security group to revoke ingress from.

  • :ec2_security_group_name (required, String) —

    The name of the Amazon EC2 security group to revoke access from.

  • :ec2_security_group_owner_id (required, String) —

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

Returns:

See Also:



11056
11057
11058
11059
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11056

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

#start_migration(params = {}) ⇒ Types::StartMigrationResponse

Start the migration of data.

Examples:

Request syntax with placeholder values


resp = client.start_migration({
  replication_group_id: "String", # required
  customer_node_endpoint_list: [ # required
    {
      address: "String",
      port: 1,
    },
  ],
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The ID of the replication group to which data should be migrated.

  • :customer_node_endpoint_list (required, Array<Types::CustomerNodeEndpoint>) —

    List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.

Returns:

See Also:



11169
11170
11171
11172
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11169

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

#test_failover(params = {}) ⇒ Types::TestFailoverResult

Represents the input of a ‘TestFailover` operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

**Note the following**

  • A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: ‘Test Failover API called for node group <node-group-id>`

    2. Cache cluster message: ‘Failover from primary node <primary-node-id> to replica node <node-id> completed`

    3. Replication group message: ‘Failover from primary node <primary-node-id> to replica node <node-id> completed`

    4. Cache cluster message: ‘Recovering cache nodes <node-id>`

    5. Cache cluster message: ‘Finished recovery for cache nodes <node-id>`

    For more information see:

    • Viewing ElastiCache Events][1

      in the *ElastiCache User Guide*

    • DescribeEvents][2

      in the ElastiCache API Reference

Also see, [Testing Multi-AZ ][3] in the *ElastiCache User Guide*.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/ECEvents.Viewing.html [2]: docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html [3]: docs.aws.amazon.com/AmazonElastiCache/latest/dg/AutoFailover.html#auto-failover-test

Examples:

Request syntax with placeholder values


resp = client.test_failover({
  replication_group_id: "String", # required
  node_group_id: "AllowedNodeGroupId", # required
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

  • :node_group_id (required, String) —

    The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 15 node groups in any rolling 24-hour period.

Returns:

See Also:



11336
11337
11338
11339
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11336

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

#test_migration(params = {}) ⇒ Types::TestMigrationResponse

Async API to test connection between source and target replication group.

Examples:

Request syntax with placeholder values


resp = client.test_migration({
  replication_group_id: "String", # required
  customer_node_endpoint_list: [ # required
    {
      address: "String",
      port: 1,
    },
  ],
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> String
resp.replication_group.global_replication_group_info.global_replication_group_id #=> String
resp.replication_group.global_replication_group_info.global_replication_group_member_role #=> String
resp.replication_group.status #=> String
resp.replication_group.pending_modified_values.primary_cluster_id #=> String
resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations #=> Array
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.pending_modified_values.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.pending_modified_values.transit_encryption_enabled #=> Boolean
resp.replication_group.pending_modified_values.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.pending_modified_values.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].node_group_id #=> String
resp.replication_group.node_groups[0].status #=> String
resp.replication_group.node_groups[0].primary_endpoint.address #=> String
resp.replication_group.node_groups[0].primary_endpoint.port #=> Integer
resp.replication_group.node_groups[0].reader_endpoint.address #=> String
resp.replication_group.node_groups[0].reader_endpoint.port #=> Integer
resp.replication_group.node_groups[0].slots #=> String
resp.replication_group.node_groups[0].node_group_members #=> Array
resp.replication_group.node_groups[0].node_group_members[0].cache_cluster_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].cache_node_id #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
resp.replication_group.snapshotting_cluster_id #=> String
resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
resp.replication_group.multi_az #=> String, one of "enabled", "disabled"
resp.replication_group.configuration_endpoint.address #=> String
resp.replication_group.configuration_endpoint.port #=> Integer
resp.replication_group.snapshot_retention_limit #=> Integer
resp.replication_group.snapshot_window #=> String
resp.replication_group.cluster_enabled #=> Boolean
resp.replication_group.cache_node_type #=> String
resp.replication_group.auth_token_enabled #=> Boolean
resp.replication_group.auth_token_last_modified_date #=> Time
resp.replication_group.transit_encryption_enabled #=> Boolean
resp.replication_group.at_rest_encryption_enabled #=> Boolean
resp.replication_group.member_clusters_outpost_arns #=> Array
resp.replication_group.member_clusters_outpost_arns[0] #=> String
resp.replication_group.kms_key_id #=> String
resp.replication_group.arn #=> String
resp.replication_group.user_group_ids #=> Array
resp.replication_group.user_group_ids[0] #=> String
resp.replication_group.log_delivery_configurations #=> Array
resp.replication_group.log_delivery_configurations[0].log_type #=> String, one of "slow-log", "engine-log"
resp.replication_group.log_delivery_configurations[0].destination_type #=> String, one of "cloudwatch-logs", "kinesis-firehose"
resp.replication_group.log_delivery_configurations[0].destination_details.cloud_watch_logs_details.log_group #=> String
resp.replication_group.log_delivery_configurations[0].destination_details.kinesis_firehose_details.delivery_stream #=> String
resp.replication_group.log_delivery_configurations[0].log_format #=> String, one of "text", "json"
resp.replication_group.log_delivery_configurations[0].status #=> String, one of "active", "enabling", "modifying", "disabling", "error"
resp.replication_group.log_delivery_configurations[0].message #=> String
resp.replication_group.replication_group_create_time #=> Time
resp.replication_group.data_tiering #=> String, one of "enabled", "disabled"
resp.replication_group.auto_minor_version_upgrade #=> Boolean
resp.replication_group.network_type #=> String, one of "ipv4", "ipv6", "dual_stack"
resp.replication_group.ip_discovery #=> String, one of "ipv4", "ipv6"
resp.replication_group.transit_encryption_mode #=> String, one of "preferred", "required"
resp.replication_group.cluster_mode #=> String, one of "enabled", "disabled", "compatible"
resp.replication_group.engine #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :replication_group_id (required, String) —

    The ID of the replication group to which data is to be migrated.

  • :customer_node_endpoint_list (required, Array<Types::CustomerNodeEndpoint>) —

    List of endpoints from which data should be migrated. List should have only one element.

Returns:

See Also:



11449
11450
11451
11452
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11449

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

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

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

  • It is successful

  • It enters a terminal state

  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

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

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## 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(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

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

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

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

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.

| waiter_name | params | :delay | :max_attempts | | ————————— | ———————————— | ——– | ————- | | cache_cluster_available | #describe_cache_clusters | 15 | 40 | | cache_cluster_deleted | #describe_cache_clusters | 15 | 40 | | replication_group_available | #describe_replication_groups | 15 | 40 | | replication_group_deleted | #describe_replication_groups | 15 | 40 |

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

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.



11567
11568
11569
11570
11571
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11567

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
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. 


11575
11576
11577
 
# File 'lib/aws-sdk-elasticache/client.rb', line 11575

def waiter_names
  waiters.keys
end