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

Class: Aws::ElastiCache::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_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.

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @see https://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 and auth errors from expired credentials.

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :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 yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



251
252
253
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

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

Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS 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.

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 AWS Service Namespaces.

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

    A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Returns:

See Also:



351
352
353
354
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 351

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.

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

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

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 AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

Returns:

See Also:



415
416
417
418
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 415

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.

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



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

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.

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



519
520
521
522
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 519

def batch_stop_update_action(params = {}, options = {})
  req = build_request(:batch_stop_update_action, params)
  req.send_request(options)
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.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.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].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.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.kms_key_id #=> 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:



590
591
592
593
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 590

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

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

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

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 & 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.

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",
})

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.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].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

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.

  • :kms_key_id (String) —

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

Returns:

See Also:



801
802
803
804
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 801

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 or Redis.

This operation is not supported for Redis (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",
})

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

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.

    This parameter is only valid if the Engine parameter is redis.

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

    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.

    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 Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

    If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://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:

        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

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended)

        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)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        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)

        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.

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

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

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

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

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

  • :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 cost allocation 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 Redis 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.

    This parameter is only valid if the Engine parameter is redis.

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

  • :snapshot_name (String) —

    The name of a Redis 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.

    This parameter is only valid if the Engine parameter is redis.

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

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

    The Amazon SNS topic owner must be the same as the cluster owner.

  • :auto_minor_version_upgrade (Boolean) —

    This parameter is currently disabled.

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

    This parameter is only valid if the Engine parameter is redis.

    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.

    This parameter is only valid if the Engine parameter is redis.

  • :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 !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

Returns:

See Also:



1314
1315
1316
1317
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 1314

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:

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
})

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

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: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

  • :description (required, String) —

    A user-specified description for the cache parameter group.

Returns:

See Also:



1393
1394
1395
1396
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 1393

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.

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
})

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

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.

Returns:

See Also:



1457
1458
1459
1460
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 1457

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
})

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

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.

Returns:

See Also:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 1551

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

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

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

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

A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (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. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

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
  primary_cluster_id: "String",
  automatic_failover_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"],
    },
  ],
  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",
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> 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.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].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.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.kms_key_id #=> 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.

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

    If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

    AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

    Default: false

    Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

    • Redis versions earlier than 2.8.6.

    • Redis (cluster mode disabled): T1 node types.

    • Redis (cluster mode enabled): T1 node types.

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

    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.

    Default: system chosen Availability Zones.

  • :num_node_groups (Integer) —

    An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (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 Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (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:

        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

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended)

        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)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        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)

        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.

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

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

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

  • :engine (String) —

    The name of the cache engine to be used for the clusters in this replication group.

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

  • :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 restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

    If you are running Redis 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 Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

    • To create a Redis (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.

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

  • :snapshot_arns (Array<String>) —

    A list of Amazon Resource Names (ARN) that uniquely identify the Redis 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:

    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.

    The Amazon SNS topic owner must be the same as the cluster owner.

  • :auto_minor_version_upgrade (Boolean) —

    This parameter is currently disabled.

  • :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 !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

  • :transit_encryption_enabled (Boolean) —

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

    You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

    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 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 redis version 3.2.6, 4.x or later.

    Default: false

  • :kms_key_id (String) —

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

Returns:

See Also:



2166
2167
2168
2169
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2166

def create_replication_group(params = {}, options = {})
  req = build_request(:create_replication_group, 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.

This operation is valid for Redis only.

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",
})

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.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].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

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.

Returns:

See Also:



2374
2375
2376
2377
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2374

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

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

Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (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"],
    },
  ],
  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.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.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].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.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.kms_key_id #=> 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 Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (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:

    • Redis (cluster mode disabled)

      • If Multi-AZ with Automatic Failover is enabled: 1

      • If Multi-AZ with Automatic Failover is not enabled: 0

    • Redis (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 Redis (cluster mode enabled) 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:



2485
2486
2487
2488
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2485

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:

  • Redis (cluster mode enabled) clusters

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

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

  • A cluster from a Redis (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.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.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.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

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:



2624
2625
2626
2627
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2624

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.

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.

    The specified cache security group must not be associated with any clusters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2661
2662
2663
2664
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2661

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.

You cannot delete a cache security group if it is associated with any clusters.

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.

    You cannot delete the default security group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2701
2702
2703
2704
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2701

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.

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

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:



2740
2741
2742
2743
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2740

def delete_cache_subnet_group(params = {}, options = {})
  req = build_request(:delete_cache_subnet_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.

This operation is valid for Redis only.

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.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.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].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.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.kms_key_id #=> 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:



2852
2853
2854
2855
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2852

def delete_replication_group(params = {}, options = {})
  req = build_request(:delete_replication_group, 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.

This operation is valid for Redis only.

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.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].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

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_name (required, String) —

    The name of the snapshot to be deleted.

Returns:

See Also:



2963
2964
2965
2966
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 2963

def delete_snapshot(params = {}, options = {})
  req = build_request(:delete_snapshot, 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.

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].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].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].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

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 mean Memcached and single node Redis clusters.

Returns:

See Also:



3205
3206
3207
3208
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 3205

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.

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 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

    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:



3456
3457
3458
3459
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 3456

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.

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

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:



3530
3531
3532
3533
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 3530

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.

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:



4008
4009
4010
4011
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 4008

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

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

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:



4076
4077
4078
4079
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 4076

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.

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

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:



4180
4181
4182
4183
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 4180

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.

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 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

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



4865
4866
4867
4868
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 4865

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.

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



5046
5047
5048
5049
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 5046

def describe_events(params = {}, options = {})
  req = build_request(:describe_events, 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.

This operation is valid for Redis only.

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].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].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].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].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].kms_key_id #=> 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:



5204
5205
5206
5207
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 5204

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.

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:

        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

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended)

        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)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        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)

        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.

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

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

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

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

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



5378
5379
5380
5381
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 5378

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.

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:

        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

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended)

        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)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        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)

        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.

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

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

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

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

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



5854
5855
5856
5857
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 5854

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

#describe_service_updates(params = {}) ⇒ Types::ServiceUpdatesMessage

Returns details of the service updates

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:



5911
5912
5913
5914
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 5911

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.

This operation is valid for Redis only.

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].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].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

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:



6071
6072
6073
6074
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 6071

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

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
  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"
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 Redis 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:



6181
6182
6183
6184
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/client.rb', line 6181

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

#increase_replica_count(params = {}) ⇒ Types::IncreaseReplicaCountResult

Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (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"],
    },
  ],
  apply_immediately: false, # required
})

Response structure


resp.replication_group.replication_group_id #=> String
resp.replication_group.description #=> 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.member_clusters #=> Array
resp.replication_group.member_clusters[0] #=> String
resp.replication_group.node_groups #=> Array
resp.replication_group.node_groups[0].