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

Class: AWS::ElastiCache::Client

Inherits:
Core::QueryClient show all
Defined in:
lib/aws/elasticache/client.rb

Overview

Client class for Amazon ElastiCache.

Direct Known Subclasses

V20130615, V20140324, V20140715, V20140930

Defined Under Namespace

Classes: V20130615, V20140324, V20140715, V20140930

Constant Summary

API_VERSION =
'2014-09-30'

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#authorize_cache_security_group_ingress(options = {}) ⇒ Core::Response

Calls the AuthorizeCacheSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_security_group_name - required - (String) The cache security group which will allow 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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :owner_id - (String)
    • :cache_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)

#copy_snapshot(options = {}) ⇒ Core::Response

Calls the CopySnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :source_snapshot_name - required - (String) The name of an existing snapshot from which to copy.
    • :target_snapshot_name - required - (String) A name for the copied snapshot.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_name - (String)
    • :cache_cluster_id - (String)
    • :snapshot_status - (String)
    • :snapshot_source - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :topic_arn - (String)
    • :port - (Integer)
    • :cache_parameter_group_name - (String)
    • :cache_subnet_group_name - (String)
    • :vpc_id - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)
    • :node_snapshots - (Array)
      • :cache_node_id - (String)
      • :cache_size - (String)
      • :cache_node_create_time - (Time)
      • :snapshot_create_time - (Time)

#create_cache_cluster(options = {}) ⇒ Core::Response

Calls the CreateCacheCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - required - (String) The node group identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
    • :replication_group_id - (String) The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group. If the specified replication group is Automatic Failover enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones. Note: This parameter is only valid if the Engine parameter is redis.
    • :az_mode - (String) Specifies whether the nodes in this Memcached node group 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 cache clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode. Valid values include:
      • single-az
      • cross-az
    • :preferred_availability_zone - (String) The EC2 Availability Zone in which the cache cluster will be created. All nodes belonging to this Memcached cache 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<) A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cache 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. Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
    • :num_cache_nodes - (Integer) The initial number of cache nodes that the cache cluster will have. For Memcached, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/. For Redis, only single-node cache cluster are supported at this time, so the value for this parameter must be 1.
    • :cache_node_type - (String) The compute and memory capacity of the nodes in the node group. Valid node types are as follows: General purpose: Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: cache.c1.xlarge Memory optimized Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All t2 instances are created in an Amazon Virtual Private Cloud (VPC). Redis backup/restore is not supported for t2 instances. Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances. For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
    • :engine - (String) The name of the cache engine to be used for this cache cluster. Valid values for this parameter are: memcached | redis
    • :engine_version - (String) The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    • :cache_parameter_group_name - (String) The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
    • :cache_subnet_group_name - (String) The name of the subnet group to be used for the cache cluster. Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
    • :cache_security_group_names - (Array<) A list of security group names to associate with this cache cluster. Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
    • :security_group_ids - (Array<) One or more VPC security groups associated with the cache cluster. Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
    • :snapshot_arns - (Array<) 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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas. Note: 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 snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created. Note: This parameter is only valid if the Engine parameter is redis.
    • :preferred_maintenance_window - (String) The weekly time range (in UTC) during which system maintenance can occur. Example: sun:05:00-sun:09:00
    • :port - (Integer) The port number on which each of the cache nodes will accept connections.
    • :notification_topic_arn - (String) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.
    • :auto_minor_version_upgrade - (Boolean) Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades. Default: true
    • :snapshot_retention_limit - (Integer) The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. Note: 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 will begin taking a daily snapshot of your node group. Example: 05:00-09:00 If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range. Note: This parameter is only valid if the Engine parameter is redis.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_cluster_id - (String)
    • :configuration_endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :client_download_landing_page - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :cache_cluster_status - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :num_cache_nodes - (Integer)
      • :cache_node_ids_to_remove - (Array)
      • :engine_version - (String)
    • :notification_configuration - (Hash)
      • :topic_arn - (String)
      • :topic_status - (String)
    • :cache_security_groups - (Array)
      • :cache_security_group_name - (String)
      • :status - (String)
    • :cache_parameter_group - (Hash)
      • :cache_parameter_group_name - (String)
      • :parameter_apply_status - (String)
      • :cache_node_ids_to_reboot - (Array)
    • :cache_subnet_group_name - (String)
    • :cache_nodes - (Array)
      • :cache_node_id - (String)
      • :cache_node_status - (String)
      • :cache_node_create_time - (Time)
      • :endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :parameter_group_status - (String)
      • :source_cache_node_id - (String)
      • :customer_availability_zone - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :security_groups - (Array)
      • :security_group_id - (String)
      • :status - (String)
    • :replication_group_id - (String)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)

#create_cache_parameter_group(options = {}) ⇒ Core::Response

Calls the CreateCacheParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 the cache parameter group can be used with. Valid values are: memcached1.4 | redis2.6 | redis2.8
    • :description - required - (String) A user-specified description for the cache parameter group.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_parameter_group_name - (String)
    • :cache_parameter_group_family - (String)
    • :description - (String)

#create_cache_security_group(options = {}) ⇒ Core::Response

Calls the CreateCacheSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :owner_id - (String)
    • :cache_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)

#create_cache_subnet_group(options = {}) ⇒ Core::Response

Calls the CreateCacheSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) A list of VPC subnet IDs for the cache subnet group.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_subnet_group_name - (String)
    • :cache_subnet_group_description - (String)
    • :vpc_id - (String)
    • :subnets - (Array)
      • :subnet_identifier - (String)
      • :subnet_availability_zone - (Hash)
        • :name - (String)

#create_replication_group(options = {}) ⇒ Core::Response

Calls the CreateReplicationGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 20 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 cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available. This parameter is not required if NumCacheClusters is specified.
    • :automatic_failover_enabled - (Boolean) Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true , automatic failover is enabled for this replication group. If false , automatic failover is disabled for this replication group. Default: false ElastiCache Multi-AZ replication groups is not supported on: Redis version 2.6. T1 and T2 cache node types.
    • :num_cache_clusters - (Integer) The number of cache clusters this replication group will initially have. If AutomaticFailover is enabled, the value of this parameter must be at least 2. The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request forrm at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
    • :preferred_cache_cluster_a_zs - (Array<) A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important. If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache 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. Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-east-1a PreferredAvailabilityZones.member.2=us-east-1c PreferredAvailabilityZones.member.3=us-east-1d
    • :cache_node_type - (String) The compute and memory capacity of the nodes in the node group. Valid node types are as follows: General purpose: Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge Compute optimized: cache.c1.xlarge Memory optimized Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge Notes: All t2 instances are created in an Amazon Virtual Private Cloud (VPC). Redis backup/restore is not supported for t2 instances. Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances. For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
    • :engine - (String) The name of the cache engine to be used for the cache clusters in this replication group. Default: redis
    • :engine_version - (String) The version number of the cach engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    • :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.
    • :cache_subnet_group_name - (String) The name of the cache subnet group to be used for the replication group.
    • :cache_security_group_names - (Array<) A list of cache security group names to associate with this replication group.
    • :security_group_ids - (Array<) 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 (VPC).
    • :snapshot_arns - (Array<) 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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas. Note: 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 snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created. Note: This parameter is only valid if the Engine parameter is redis.
    • :preferred_maintenance_window - (String) The weekly time range (in UTC) during which system maintenance can occur. Example: sun:05:00-sun:09:00
    • :port - (Integer) The port number on which each member of the replication group will accept connections.
    • :notification_topic_arn - (String) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.
    • :auto_minor_version_upgrade - (Boolean) Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades. Default: true
    • :snapshot_retention_limit - (Integer) The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. Note: 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 will begin taking a daily snapshot of your node group. Example: 05:00-09:00 If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range. Note: This parameter is only valid if the Engine parameter is redis.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :replication_group_id - (String)
    • :description - (String)
    • :status - (String)
    • :pending_modified_values - (Hash)
      • :primary_cluster_id - (String)
      • :automatic_failover_status - (String)
    • :member_clusters - (Array)
    • :node_groups - (Array)
      • :node_group_id - (String)
      • :status - (String)
      • :primary_endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :node_group_members - (Array)
        • :cache_cluster_id - (String)
        • :cache_node_id - (String)
        • :read_endpoint - (Hash)
          • :address - (String)
          • :port - (Integer)
        • :preferred_availability_zone - (String)
        • :current_role - (String)
    • :snapshotting_cluster_id - (String)
    • :automatic_failover - (String)

#create_snapshot(options = {}) ⇒ Core::Response

Calls the CreateSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - required - (String) The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.
    • :snapshot_name - required - (String) A name for the snapshot being created.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_name - (String)
    • :cache_cluster_id - (String)
    • :snapshot_status - (String)
    • :snapshot_source - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :topic_arn - (String)
    • :port - (Integer)
    • :cache_parameter_group_name - (String)
    • :cache_subnet_group_name - (String)
    • :vpc_id - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)
    • :node_snapshots - (Array)
      • :cache_node_id - (String)
      • :cache_size - (String)
      • :cache_node_create_time - (Time)
      • :snapshot_create_time - (Time)

#delete_cache_cluster(options = {}) ⇒ Core::Response

Calls the DeleteCacheCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - required - (String) The cache 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 cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_cluster_id - (String)
    • :configuration_endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :client_download_landing_page - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :cache_cluster_status - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :num_cache_nodes - (Integer)
      • :cache_node_ids_to_remove - (Array)
      • :engine_version - (String)
    • :notification_configuration - (Hash)
      • :topic_arn - (String)
      • :topic_status - (String)
    • :cache_security_groups - (Array)
      • :cache_security_group_name - (String)
      • :status - (String)
    • :cache_parameter_group - (Hash)
      • :cache_parameter_group_name - (String)
      • :parameter_apply_status - (String)
      • :cache_node_ids_to_reboot - (Array)
    • :cache_subnet_group_name - (String)
    • :cache_nodes - (Array)
      • :cache_node_id - (String)
      • :cache_node_status - (String)
      • :cache_node_create_time - (Time)
      • :endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :parameter_group_status - (String)
      • :source_cache_node_id - (String)
      • :customer_availability_zone - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :security_groups - (Array)
      • :security_group_id - (String)
      • :status - (String)
    • :replication_group_id - (String)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)

#delete_cache_parameter_group(options = {}) ⇒ Core::Response

Calls the DeleteCacheParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 cache clusters.

Returns:

#delete_cache_security_group(options = {}) ⇒ Core::Response

Calls the DeleteCacheSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_security_group_name - required - (String) The name of the cache security group to delete. You cannot delete the default security group.

Returns:

#delete_cache_subnet_group(options = {}) ⇒ Core::Response

Calls the DeleteCacheSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

#delete_replication_group(options = {}) ⇒ Core::Response

Calls the DeleteReplicationGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 will be deleted, but the primary node will be retained.
    • :final_snapshot_identifier - (String) The name of a final node group 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 cluster is immediately deleted.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :replication_group_id - (String)
    • :description - (String)
    • :status - (String)
    • :pending_modified_values - (Hash)
      • :primary_cluster_id - (String)
      • :automatic_failover_status - (String)
    • :member_clusters - (Array)
    • :node_groups - (Array)
      • :node_group_id - (String)
      • :status - (String)
      • :primary_endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :node_group_members - (Array)
        • :cache_cluster_id - (String)
        • :cache_node_id - (String)
        • :read_endpoint - (Hash)
          • :address - (String)
          • :port - (Integer)
        • :preferred_availability_zone - (String)
        • :current_role - (String)
    • :snapshotting_cluster_id - (String)
    • :automatic_failover - (String)

#delete_snapshot(options = {}) ⇒ Core::Response

Calls the DeleteSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :snapshot_name - required - (String) The name of the snapshot to be deleted.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_name - (String)
    • :cache_cluster_id - (String)
    • :snapshot_status - (String)
    • :snapshot_source - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :topic_arn - (String)
    • :port - (Integer)
    • :cache_parameter_group_name - (String)
    • :cache_subnet_group_name - (String)
    • :vpc_id - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)
    • :node_snapshots - (Array)
      • :cache_node_id - (String)
      • :cache_size - (String)
      • :cache_node_create_time - (Time)
      • :snapshot_create_time - (Time)

#describe_cache_clusters(options = {}) ⇒ Core::Response

Calls the DescribeCacheClusters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - (String) The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache 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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cache_clusters - (Array)
      • :cache_cluster_id - (String)
      • :configuration_endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :client_download_landing_page - (String)
      • :cache_node_type - (String)
      • :engine - (String)
      • :engine_version - (String)
      • :cache_cluster_status - (String)
      • :num_cache_nodes - (Integer)
      • :preferred_availability_zone - (String)
      • :cache_cluster_create_time - (Time)
      • :preferred_maintenance_window - (String)
      • :pending_modified_values - (Hash)
        • :num_cache_nodes - (Integer)
        • :cache_node_ids_to_remove - (Array)
        • :engine_version - (String)
      • :notification_configuration - (Hash)
        • :topic_arn - (String)
        • :topic_status - (String)
      • :cache_security_groups - (Array)
        • :cache_security_group_name - (String)
        • :status - (String)
      • :cache_parameter_group - (Hash)
        • :cache_parameter_group_name - (String)
        • :parameter_apply_status - (String)
        • :cache_node_ids_to_reboot - (Array)
      • :cache_subnet_group_name - (String)
      • :cache_nodes - (Array)
        • :cache_node_id - (String)
        • :cache_node_status - (String)
        • :cache_node_create_time - (Time)
        • :endpoint - (Hash)
          • :address - (String)
          • :port - (Integer)
        • :parameter_group_status - (String)
        • :source_cache_node_id - (String)
        • :customer_availability_zone - (String)
      • :auto_minor_version_upgrade - (Boolean)
      • :security_groups - (Array)
        • :security_group_id - (String)
        • :status - (String)
      • :replication_group_id - (String)
      • :snapshot_retention_limit - (Integer)
      • :snapshot_window - (String)

#describe_cache_engine_versions(options = {}) ⇒ Core::Response

Calls the DescribeCacheEngineVersions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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. 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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cache_engine_versions - (Array)
      • :engine - (String)
      • :engine_version - (String)
      • :cache_parameter_group_family - (String)
      • :cache_engine_description - (String)
      • :cache_engine_version_description - (String)

#describe_cache_parameter_groups(options = {}) ⇒ Core::Response

Calls the DescribeCacheParameterGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cache_parameter_groups - (Array)
      • :cache_parameter_group_name - (String)
      • :cache_parameter_group_family - (String)
      • :description - (String)

#describe_cache_parameters(options = {}) ⇒ Core::Response

Calls the DescribeCacheParameters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :parameters - (Array)
      • :parameter_name - (String)
      • :parameter_value - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)
    • :cache_node_type_specific_parameters - (Array)
      • :parameter_name - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)
      • :cache_node_type_specific_values - (Array)
        • :cache_node_type - (String)
        • :value - (String)

#describe_cache_security_groups(options = {}) ⇒ Core::Response

Calls the DescribeCacheSecurityGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cache_security_groups - (Array)
      • :owner_id - (String)
      • :cache_security_group_name - (String)
      • :description - (String)
      • :ec_2_security_groups - (Array)
        • :status - (String)
        • :ec2_security_group_name - (String)
        • :ec2_security_group_owner_id - (String)

#describe_cache_subnet_groups(options = {}) ⇒ Core::Response

Calls the DescribeCacheSubnetGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cache_subnet_groups - (Array)
      • :cache_subnet_group_name - (String)
      • :cache_subnet_group_description - (String)
      • :vpc_id - (String)
      • :subnets - (Array)
        • :subnet_identifier - (String)
        • :subnet_availability_zone - (Hash)
          • :name - (String)

#describe_engine_default_parameters(options = {}) ⇒ Core::Response

Calls the DescribeEngineDefaultParameters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_parameter_group_family - required - (String) The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_parameter_group_family - (String)
    • :marker - (String)
    • :parameters - (Array)
      • :parameter_name - (String)
      • :parameter_value - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)
    • :cache_node_type_specific_parameters - (Array)
      • :parameter_name - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)
      • :cache_node_type_specific_values - (Array)
        • :cache_node_type - (String)
        • :value - (String)

#describe_events(options = {}) ⇒ Core::Response

Calls the DescribeEvents API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :source_identifier - (String) The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
    • :source_type - (String) The event source to retrieve events for. If no value is specified, all events are returned. Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group Valid values include:
      • cache-cluster
      • cache-parameter-group
      • cache-security-group
      • cache-subnet-group
    • :start_time - (String<) The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    • :end_time - (String<) The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    • :duration - (Integer) The number of minutes' worth of events to retrieve.
    • :max_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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :events - (Array)
      • :source_identifier - (String)
      • :source_type - (String)
      • :message - (String)
      • :date - (Time)

#describe_replication_groups(options = {}) ⇒ Core::Response

Calls the DescribeReplicationGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :replication_groups - (Array)
      • :replication_group_id - (String)
      • :description - (String)
      • :status - (String)
      • :pending_modified_values - (Hash)
        • :primary_cluster_id - (String)
        • :automatic_failover_status - (String)
      • :member_clusters - (Array)
      • :node_groups - (Array)
        • :node_group_id - (String)
        • :status - (String)
        • :primary_endpoint - (Hash)
          • :address - (String)
          • :port - (Integer)
        • :node_group_members - (Array)
          • :cache_cluster_id - (String)
          • :cache_node_id - (String)
          • :read_endpoint - (Hash)
            • :address - (String)
            • :port - (Integer)
          • :preferred_availability_zone - (String)
          • :current_role - (String)
      • :snapshotting_cluster_id - (String)
      • :automatic_failover - (String)

#describe_reserved_cache_nodes(options = {}) ⇒ Core::Response

Calls the DescribeReservedCacheNodes API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :reserved_cache_nodes - (Array)
      • :reserved_cache_node_id - (String)
      • :reserved_cache_nodes_offering_id - (String)
      • :cache_node_type - (String)
      • :start_time - (Time)
      • :duration - (Integer)
      • :fixed_price - (Numeric)
      • :usage_price - (Numeric)
      • :cache_node_count - (Integer)
      • :product_description - (String)
      • :offering_type - (String)
      • :state - (String)
      • :recurring_charges - (Array)
        • :recurring_charge_amount - (Numeric)
        • :recurring_charge_frequency - (String)

#describe_reserved_cache_nodes_offerings(options = {}) ⇒ Core::Response

Calls the DescribeReservedCacheNodesOfferings API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.
    • :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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :reserved_cache_nodes_offerings - (Array)
      • :reserved_cache_nodes_offering_id - (String)
      • :cache_node_type - (String)
      • :duration - (Integer)
      • :fixed_price - (Numeric)
      • :usage_price - (Numeric)
      • :product_description - (String)
      • :offering_type - (String)
      • :recurring_charges - (Array)
        • :recurring_charge_amount - (Numeric)
        • :recurring_charge_frequency - (String)

#describe_snapshots(options = {}) ⇒ Core::Response

Calls the DescribeSnapshots API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - (String) A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
    • :snapshot_name - (String) A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be 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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :snapshots - (Array)
      • :snapshot_name - (String)
      • :cache_cluster_id - (String)
      • :snapshot_status - (String)
      • :snapshot_source - (String)
      • :cache_node_type - (String)
      • :engine - (String)
      • :engine_version - (String)
      • :num_cache_nodes - (Integer)
      • :preferred_availability_zone - (String)
      • :cache_cluster_create_time - (Time)
      • :preferred_maintenance_window - (String)
      • :topic_arn - (String)
      • :port - (Integer)
      • :cache_parameter_group_name - (String)
      • :cache_subnet_group_name - (String)
      • :vpc_id - (String)
      • :auto_minor_version_upgrade - (Boolean)
      • :snapshot_retention_limit - (Integer)
      • :snapshot_window - (String)
      • :node_snapshots - (Array)
        • :cache_node_id - (String)
        • :cache_size - (String)
        • :cache_node_create_time - (Time)
        • :snapshot_create_time - (Time)

#modify_cache_cluster(options = {}) ⇒ Core::Response

Calls the ModifyCacheCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - required - (String) The cache cluster identifier. This value is stored as a lowercase string.
    • :num_cache_nodes - (Integer) The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For cache clusters running Redis, the value of NumCacheNodesmust be 1. Note:Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately. A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
    • :cache_node_ids_to_remove - (Array<) A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
    • :az_mode - (String) Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az. This option is only supported for Memcached cache clusters. You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Valid values include:
      • single-az
      • cross-az
    • :new_availability_zones - (Array<) The list of Availability Zones where the new Memcached cache nodes will be created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel all pending actions. Specify NumCacheNodes=3 to cancel all pending actions. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Impact of new add/remove requests upon pending requests Scenarios Pending Operation New Request Results Scenario-1 Delete Delete The new delete, pending or immediate, replaces the pending delete. Scenario-2 Delete Create The new create, pending or immediate, replaces the pending delete. Scenario-3 Create Delete The new delete, pending or immediate, replaces the pending create. Scenario-4 Create Create The new create is added to the pending create. Important:If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
    • :cache_security_group_names - (Array<) A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible. This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
    • :security_group_ids - (Array<) Specifies the VPC Security Groups associated with the cache cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
    • :preferred_maintenance_window - (String) The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
    • :notification_topic_arn - (String) The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon SNS topic owner must be same as the cache cluster owner.
    • :cache_parameter_group_name - (String) The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
    • :notification_topic_status - (String) The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive
    • :apply_immediately - (Boolean) If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster. If false , then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false
    • :engine_version - (String) The upgraded version of the cache engine to be run on the cache nodes.
    • :auto_minor_version_upgrade - (Boolean) If true , then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. Valid values: true | false Default: true
    • :snapshot_retention_limit - (Integer) The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. ImportantIf the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
    • :snapshot_window - (String) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_cluster_id - (String)
    • :configuration_endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :client_download_landing_page - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :cache_cluster_status - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :num_cache_nodes - (Integer)
      • :cache_node_ids_to_remove - (Array)
      • :engine_version - (String)
    • :notification_configuration - (Hash)
      • :topic_arn - (String)
      • :topic_status - (String)
    • :cache_security_groups - (Array)
      • :cache_security_group_name - (String)
      • :status - (String)
    • :cache_parameter_group - (Hash)
      • :cache_parameter_group_name - (String)
      • :parameter_apply_status - (String)
      • :cache_node_ids_to_reboot - (Array)
    • :cache_subnet_group_name - (String)
    • :cache_nodes - (Array)
      • :cache_node_id - (String)
      • :cache_node_status - (String)
      • :cache_node_create_time - (Time)
      • :endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :parameter_group_status - (String)
      • :source_cache_node_id - (String)
      • :customer_availability_zone - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :security_groups - (Array)
      • :security_group_id - (String)
      • :status - (String)
    • :replication_group_id - (String)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)

#modify_cache_parameter_group(options = {}) ⇒ Core::Response

Calls the ModifyCacheParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_parameter_group_name - required - (String) The name of the cache parameter group to modify.
    • :parameter_name_values - required - (Array<) An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
      • :parameter_name - (String) The name of the parameter.
      • :parameter_value - (String) The value of the parameter.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_parameter_group_name - (String)

#modify_cache_subnet_group(options = {}) ⇒ Core::Response

Calls the ModifyCacheSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_subnet_group_name - required - (String) The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup
    • :cache_subnet_group_description - (String) A description for the cache subnet group.
    • :subnet_ids - (Array<) The EC2 subnet IDs for the cache subnet group.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_subnet_group_name - (String)
    • :cache_subnet_group_description - (String)
    • :vpc_id - (String)
    • :subnets - (Array)
      • :subnet_identifier - (String)
      • :subnet_availability_zone - (Hash)
        • :name - (String)

#modify_replication_group(options = {}) ⇒ Core::Response

Calls the ModifyReplicationGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :replication_group_id - required - (String) The identifier of the replication group to modify.
    • :replication_group_description - (String) A description for the replication group. Maximum length is 255 characters.
    • :primary_cluster_id - (String) If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.
    • :snapshotting_cluster_id - (String) The cache cluster ID that will be used as the daily snapshot source for the replication group.
    • :automatic_failover_enabled - (Boolean) Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false ElastiCache Multi-AZ replication groups is not supported on: Redis version 2.6. T1 and T2 cache node types.
    • :cache_security_group_names - (Array<) A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
    • :security_group_ids - (Array<) Specifies the VPC Security Groups associated with the cache clusters in the replication group. This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
    • :preferred_maintenance_window - (String) The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
    • :notification_topic_arn - (String) The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. The Amazon SNS topic owner must be same as the replication group owner.
    • :cache_parameter_group_name - (String) The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
    • :notification_topic_status - (String) The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active | inactive
    • :apply_immediately - (Boolean) If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false , then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true | false Default: false
    • :engine_version - (String) The upgraded version of the cache engine to be run on the cache clusters in the replication group.
    • :auto_minor_version_upgrade - (Boolean) Determines whether minor engine upgrades will be applied automatically to all of the clusters in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
    • :snapshot_retention_limit - (Integer) The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. ImportantIf the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
    • :snapshot_window - (String) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId. Example: 05:00-09:00 If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :replication_group_id - (String)
    • :description - (String)
    • :status - (String)
    • :pending_modified_values - (Hash)
      • :primary_cluster_id - (String)
      • :automatic_failover_status - (String)
    • :member_clusters - (Array)
    • :node_groups - (Array)
      • :node_group_id - (String)
      • :status - (String)
      • :primary_endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :node_group_members - (Array)
        • :cache_cluster_id - (String)
        • :cache_node_id - (String)
        • :read_endpoint - (Hash)
          • :address - (String)
          • :port - (Integer)
        • :preferred_availability_zone - (String)
        • :current_role - (String)
    • :snapshotting_cluster_id - (String)
    • :automatic_failover - (String)

#purchase_reserved_cache_nodes_offering(options = {}) ⇒ Core::Response

Calls the PurchaseReservedCacheNodesOffering API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :reserved_cache_nodes_offering_id - required - (String) The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
    • :reserved_cache_node_id - (String) A customer-specified identifier to track this reservation. Example: myreservationID
    • :cache_node_count - (Integer) The number of cache node instances to reserve. Default: 1

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :reserved_cache_node_id - (String)
    • :reserved_cache_nodes_offering_id - (String)
    • :cache_node_type - (String)
    • :start_time - (Time)
    • :duration - (Integer)
    • :fixed_price - (Numeric)
    • :usage_price - (Numeric)
    • :cache_node_count - (Integer)
    • :product_description - (String)
    • :offering_type - (String)
    • :state - (String)
    • :recurring_charges - (Array)
      • :recurring_charge_amount - (Numeric)
      • :recurring_charge_frequency - (String)

#reboot_cache_cluster(options = {}) ⇒ Core::Response

Calls the RebootCacheCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_cluster_id - required - (String) The cache cluster identifier. This parameter is stored as a lowercase string.
    • :cache_node_ids_to_reboot - required - (Array<) A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_cluster_id - (String)
    • :configuration_endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :client_download_landing_page - (String)
    • :cache_node_type - (String)
    • :engine - (String)
    • :engine_version - (String)
    • :cache_cluster_status - (String)
    • :num_cache_nodes - (Integer)
    • :preferred_availability_zone - (String)
    • :cache_cluster_create_time - (Time)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :num_cache_nodes - (Integer)
      • :cache_node_ids_to_remove - (Array)
      • :engine_version - (String)
    • :notification_configuration - (Hash)
      • :topic_arn - (String)
      • :topic_status - (String)
    • :cache_security_groups - (Array)
      • :cache_security_group_name - (String)
      • :status - (String)
    • :cache_parameter_group - (Hash)
      • :cache_parameter_group_name - (String)
      • :parameter_apply_status - (String)
      • :cache_node_ids_to_reboot - (Array)
    • :cache_subnet_group_name - (String)
    • :cache_nodes - (Array)
      • :cache_node_id - (String)
      • :cache_node_status - (String)
      • :cache_node_create_time - (Time)
      • :endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :parameter_group_status - (String)
      • :source_cache_node_id - (String)
      • :customer_availability_zone - (String)
    • :auto_minor_version_upgrade - (Boolean)
    • :security_groups - (Array)
      • :security_group_id - (String)
      • :status - (String)
    • :replication_group_id - (String)
    • :snapshot_retention_limit - (Integer)
    • :snapshot_window - (String)

#reset_cache_parameter_group(options = {}) ⇒ Core::Response

Calls the ResetCacheParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_parameter_group_name - required - (String) The name of the cache parameter group to reset.
    • :reset_all_parameters - (Boolean) If true , all parameters in the cache parameter group will be reset to default values. If false , no such action occurs. Valid values: true | false
    • :parameter_name_values - required - (Array<) An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.
      • :parameter_name - (String) The name of the parameter.
      • :parameter_value - (String) The value of the parameter.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cache_parameter_group_name - (String)

#revoke_cache_security_group_ingress(options = {}) ⇒ Core::Response

Calls the RevokeCacheSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cache_security_group_name - required - (String) The name of the cache security group to revoke ingress from.
    • :ec2_security_group_name - required - (String) The name of the Amazon EC2 security group to revoke access from.
    • :ec2_security_group_owner_id - required - (String) The 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:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :owner_id - (String)
    • :cache_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)