{
"api_version": "2014-03-24",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"service_full_name": "Amazon ElastiCache",
"endpoint_prefix": "elasticache",
"xmlnamespace": "http://elasticache.amazonaws.com/doc/2014-03-24/",
"documentation": "\n
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a\n distributed cache in the cloud.
\nWith ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache\n with far less of the administrative burden of launching and managing a distributed\n cache. The service makes set-up, scaling, and cluster failure handling much simpler than\n in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.
\n ", "operations": { "AuthorizeCacheSecurityGroupIngress": { "name": "AuthorizeCacheSecurityGroupIngress", "input": { "shape_name": "AuthorizeCacheSecurityGroupIngressMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe cache security group which will allow network ingress.
\n ", "required": true }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon EC2 security group to be authorized for ingress to the cache security\n group.
\n ", "required": true }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.
\n ", "required": true } }, "documentation": "\nRepresents the input of an AuthorizeCacheSecurityGroupIngress operation.
\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the cache security group owner.
\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache security group.
\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " } }, "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " }, { "shape_name": "AuthorizationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nThe specified Amazon EC2 security group is already authorized for the specified cache\n security group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2\n security groups are used as the authorization mechanism.
\nThe name of an existing snapshot from which to copy.
\n ", "required": true }, "TargetSnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nA name for the copied snapshot.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CopySnapshotMessage operation.
\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " }, "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " }, "SnapshotStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the snapshot. Valid values: creating
| available
\n | restoring
| deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
The name of the compute and memory capacity node type for the source cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " }, "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true
) or not (false
).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " }, "NodeSnapshots": { "shape_name": "NodeSnapshotList", "type": "list", "members": { "shape_name": "NodeSnapshot", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " }, "CacheSize": { "shape_name": "String", "type": "string", "documentation": "\nThe size of the cache on the source cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " } }, "wrapper": true, "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", "xmlname": "NodeSnapshot" }, "documentation": "\nA list of the cache cluster nodes in the source cache cluster.
\n " } }, "wrapper": true, "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " } } }, "errors": [ { "shape_name": "SnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a snapshot with the given name.
\n " }, { "shape_name": "SnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " }, { "shape_name": "InvalidSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the snapshot does not allow the requested action to occur.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe CopySnapshot operation makes a copy of an existing snapshot.
\n " }, "CreateCacheCluster": { "name": "CreateCacheCluster", "input": { "shape_name": "CreateCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster identifier. This parameter is stored as a lowercase string.
\n \nConstraints:
\nThe replication group to which this cache cluster should belong. If this parameter is\n specified, the cache cluster will be added to the specified replication group as a read\n replica; otherwise, the cache cluster will be a standalone primary that is not part of\n any replication group.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe initial number of cache nodes that the cache cluster will have.
\nFor a Memcached cluster, valid values are between 1 and 20. If you need to exceed this\n limit, please fill out the ElastiCache Limit Increase Request form at .
\nFor Redis, only single-node cache clusters are supported at this time, so the value for\n this parameter must be 1.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe compute and memory capacity of the nodes in the cache cluster.
\n \nValid values for Memcached:
\n\n cache.t1.micro
| \n cache.m1.small
| \n cache.m1.medium
|\n cache.m1.large
| \n cache.m1.xlarge
| \n cache.m3.xlarge
| \n cache.m3.2xlarge
| \n cache.m2.xlarge
| \n cache.m2.2xlarge
|\n cache.m2.4xlarge
| \n cache.c1.xlarge
\n
Valid values for Redis:
\n\n cache.t1.micro
| \n cache.m1.small
| \n cache.m1.medium
|\n cache.m1.large
| \n cache.m1.xlarge
| \n cache.m2.xlarge
| \n cache.m2.2xlarge
| \n cache.m2.4xlarge
| \n cache.c1.xlarge
\n
For a complete listing of cache node types and specifications, see .
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine to be used for this cache cluster.
\nValid values for this parameter are:
\nmemcached
| redis
The version number of the cache engine to be used for this cluster. To view the supported\n cache engine versions, use the DescribeCacheEngineVersions operation.
\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group to associate with this cache cluster. If this\n argument is omitted, the default cache parameter group for the specified engine will be\n used.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group to be used for the cache cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\nA list of cache security group names to associate with this cache cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (VPC).
\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\nOne or more VPC security groups associated with the cache cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\n " }, "SnapshotArns": { "shape_name": "SnapshotArnsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SnapshotArn" }, "documentation": "\nA single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used\n to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the\n ARN cannot contain any commas.
\n\nHere is an example of an Amazon S3 ARN:\n arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This parameter is only valid if the Engine
parameter is\n redis
.
The name of a snapshot from which to restore data into the new cache cluster. The\n snapshot's status changes to restoring
while the new cache cluster is being\n created.
The EC2 Availability Zone in which the cache cluster will be created.
\nAll cache nodes belonging to a cache cluster are placed in the preferred availability\n zone.
\nDefault: System chosen availability zone.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe weekly time range (in UTC) during which system maintenance can occur.
\nExample: sun:05:00-sun:09:00
\n
The port number on which each of the cache nodes will accept connections.
\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to\n which notifications will be sent.
\nDetermines whether minor engine upgrades will be applied automatically to the cache\n cluster during the maintenance window. A value of true
allows these\n upgrades to occur; false
disables automatic upgrades.
Default: true
The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nIf you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
\n " } }, "documentation": "\nRepresents the input of a CreateCacheCluster operation.
\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " } }, "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of the topic.
\n " } }, "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of parameter updates.
\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " } }, "documentation": "\nThe status of the cache parameter group.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created.
\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the parameter group applied to this cache node.
\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " } }, "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", "xmlname": "CacheNode" }, "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true
, then minor version patches are applied automatically; if\n false
, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a single cache security group and its status..
\n " }, "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe specified replication group does not exist.
\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested replication group is not in the available state.
\n " }, { "shape_name": "CacheClusterAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a cache cluster with the given identifier.
\n " }, { "shape_name": "InsufficientCacheClusterCapacityFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache node type is not available in the specified Availability Zone.
\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " }, { "shape_name": "ClusterQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n clusters per customer.
\n " }, { "shape_name": "NodeQuotaForClusterExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.
\n " }, { "shape_name": "NodeQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n per customer.
\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\nThe VPC network is in an invalid state.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe CreateCacheCluster operation creates a new cache cluster. All nodes in the\n cache cluster run the same protocol-compliant cache engine software - either Memcached\n or Redis.
\nA user-specified name for the cache parameter group.
\n ", "required": true }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group family the cache parameter group can be used\n with.
\nValid values are: memcached1.4
| redis2.6
|\n redis2.8
A user-specified description for the cache parameter group.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateCacheParameterGroup operation.
\n " }, "output": { "shape_name": "CacheParameterGroupWrapper", "type": "structure", "members": { "CacheParameterGroup": { "shape_name": "CacheParameterGroup", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group family that this cache parameter group is\n compatible with.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description for this cache parameter group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of a CreateCacheParameterGroup operation.
\n " } } }, "errors": [ { "shape_name": "CacheParameterGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the maximum number of cache\n security groups.
\n " }, { "shape_name": "CacheParameterGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nA cache parameter group with the requested name already exists.
\n " }, { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe CreateCacheParameterGroup operation creates a new cache parameter group. A\n cache parameter group is a collection of parameters that you apply to all of the nodes\n in a cache cluster.
\nA name for the cache security group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be the word\n \"Default\".
\nExample: mysecuritygroup
A description for the cache security group.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateCacheSecurityGroup operation.
\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the cache security group owner.
\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache security group.
\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " } }, "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nA cache security group with the specified name already exists.
\n " }, { "shape_name": "CacheSecurityGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n security groups.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe CreateCacheSecurityGroup operation creates a new cache security group. Use a\n cache security group to control access to one or more cache clusters.
\nCache security groups are only used when you are creating a cluster outside of an Amazon\n Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache\n subnet group instead. For more information, see CreateCacheSubnetGroup.
\nA name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
A description for the cache subnet group.
\n ", "required": true }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\nA list of VPC subnet IDs for the cache subnet group.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateCacheSubnetGroup operation.
\n " }, "output": { "shape_name": "CacheSubnetGroupWrapper", "type": "structure", "members": { "CacheSubnetGroup": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group.
\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache subnet group.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identifier for the subnet
\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the availability zone.
\n " } }, "wrapper": true, "documentation": "\nThe Availability Zone associated with the subnet
\n " } }, "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", "xmlname": "Subnet" }, "documentation": "\nA list of subnets associated with the cache subnet group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache subnet group name is already in use by an existing cache subnet\n group.
\n " }, { "shape_name": "CacheSubnetGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n subnet groups.
\n " }, { "shape_name": "CacheSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.
\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\nAn invalid subnet identifier was specified.
\n " } ], "documentation": "\nThe CreateCacheSubnetGroup operation creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\nThe replication group identifier. This parameter is stored as a lowercase string.
\n \nConstraints:
\nThe identifier of the cache cluster that will serve as the primary for this replication\n group. This cache cluster must already exist and have a status of available.
\n ", "required": true }, "ReplicationGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\nA user-specified description for the replication group.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateReplicationGroup operation.
\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the replication group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the replication group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately
was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " } }, "documentation": "\nRepresents a single node within a node group.
\n ", "xmlname": "NodeGroupMember" }, "documentation": "\nA list containing information about individual nodes within the node group.
\n " } }, "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", "xmlname": "NodeGroup" }, "documentation": "\nA single element list with information about the nodes in the replication group.
\n " }, "SnapshottingClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " } }, "wrapper": true, "documentation": "\nContains all of the attributes of a specific replication group.
\n " } } }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "ReplicationGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nThe specified replication group already exists.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe CreateReplicationGroup operation creates a replication group. A replication\n group is a collection of cache clusters, where one of the clusters is a read/write\n primary and the other clusters are read-only replicas. Writes to the primary are\n automatically propagated to the replicas.
\nWhen you create a replication group, you must specify an existing cache cluster that is\n in the primary role. When the replication group has been successfully created, you can\n add one or more read replica replicas to it, up to a total of five read replicas.
\n " }, "CreateSnapshot": { "name": "CreateSnapshot", "input": { "shape_name": "CreateSnapshotMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier of an existing cache cluster. The snapshot will be created from this cache\n cluster.
\n ", "required": true }, "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nA name for the snapshot being created.
\n ", "required": true } }, "documentation": "\nRepresents the input of a CreateSnapshotMessage operation.
\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " }, "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " }, "SnapshotStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the snapshot. Valid values: creating
| available
\n | restoring
| deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
The name of the compute and memory capacity node type for the source cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " }, "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true
) or not (false
).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " }, "NodeSnapshots": { "shape_name": "NodeSnapshotList", "type": "list", "members": { "shape_name": "NodeSnapshot", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " }, "CacheSize": { "shape_name": "String", "type": "string", "documentation": "\nThe size of the cache on the source cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " } }, "wrapper": true, "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", "xmlname": "NodeSnapshot" }, "documentation": "\nA list of the cache cluster nodes in the source cache cluster.
\n " } }, "wrapper": true, "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " } } }, "errors": [ { "shape_name": "SnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a snapshot with the given name.
\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " }, { "shape_name": "SnapshotFeatureNotSupportedFault", "type": "structure", "members": {}, "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " } ], "documentation": "\nThe CreateSnapshot operation creates a copy of an entire cache cluster at a\n specific moment in time.
\n " }, "DeleteCacheCluster": { "name": "DeleteCacheCluster", "input": { "shape_name": "DeleteCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.
\n ", "required": true }, "FinalSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes\n the cache cluster immediately afterward.
\n " } }, "documentation": "\nRepresents the input of a DeleteCacheCluster operation.
\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " } }, "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of the topic.
\n " } }, "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of parameter updates.
\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " } }, "documentation": "\nThe status of the cache parameter group.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created.
\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the parameter group applied to this cache node.
\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " } }, "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", "xmlname": "CacheNode" }, "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true
, then minor version patches are applied automatically; if\n false
, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a single cache security group and its status..
\n " }, "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " } } }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "SnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a snapshot with the given name.
\n " }, { "shape_name": "SnapshotFeatureNotSupportedFault", "type": "structure", "members": {}, "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DeleteCacheCluster operation deletes a previously provisioned cache cluster.\n DeleteCacheCluster deletes all associated cache nodes, node endpoints and the\n cache cluster itself. When you receive a successful response from this operation,\n Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert\n this operation.
\nThe name of the cache parameter group to delete.
\nRepresents the input of a DeleteCacheParameterGroup operation.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DeleteCacheParameterGroup operation deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters.
\nThe name of the cache security group to delete.
\nRepresents the input of a DeleteCacheSecurityGroup operation.
\n " }, "output": null, "errors": [ { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DeleteCacheSecurityGroup operation deletes a cache security group.
\nThe name of the cache subnet group to delete.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\n ", "required": true } }, "documentation": "\nRepresents the input of a DeleteCacheSubnetGroup operation.
\n " }, "output": null, "errors": [ { "shape_name": "CacheSubnetGroupInUse", "type": "structure", "members": {}, "documentation": "\nThe requested cache subnet group is currently in use.
\n " }, { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " } ], "documentation": "\nThe DeleteCacheSubnetGroup operation deletes a cache subnet group.
\nThe identifier for the replication group to be deleted. This parameter is not case\n sensitive.
\n ", "required": true }, "RetainPrimaryCluster": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\nIf set to true, all of the read replicas will be deleted, but the primary cache\n cluster will be retained.
\n " }, "FinalSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a final cache cluster snapshot. ElastiCache creates the snapshot from the primary cluster in the replication group, 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 deleted immediately afterward.
\n " } }, "documentation": "\nRepresents the input of a DeleteReplicationGroup operation.
\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the replication group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the replication group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately
was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " } }, "documentation": "\nRepresents a single node within a node group.
\n ", "xmlname": "NodeGroupMember" }, "documentation": "\nA list containing information about individual nodes within the node group.
\n " } }, "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", "xmlname": "NodeGroup" }, "documentation": "\nA single element list with information about the nodes in the replication group.
\n " }, "SnapshottingClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " } }, "wrapper": true, "documentation": "\nContains all of the attributes of a specific replication group.
\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe specified replication group does not exist.
\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested replication group is not in the available state.
\n " }, { "shape_name": "SnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a snapshot with the given name.
\n " }, { "shape_name": "SnapshotFeatureNotSupportedFault", "type": "structure", "members": {}, "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DeleteReplicationGroup operation deletes an existing replication group. By\n default, this operation deletes the entire replication group, including the primary\n cache cluster and all of the read replicas. You can optionally delete only the read\n replicas, while retaining the primary cache cluster.
\nWhen you receive a successful response from this operation, Amazon ElastiCache immediately begins\n deleting the selected resources; you cannot cancel or revert this operation.
\n " }, "DeleteSnapshot": { "name": "DeleteSnapshot", "input": { "shape_name": "DeleteSnapshotMessage", "type": "structure", "members": { "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the snapshot to be deleted.
\n ", "required": true } }, "documentation": "\nRepresents the input of a DeleteSnapshotMessage operation.
\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " }, "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " }, "SnapshotStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the snapshot. Valid values: creating
| available
\n | restoring
| deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
The name of the compute and memory capacity node type for the source cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " }, "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true
) or not (false
).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " }, "NodeSnapshots": { "shape_name": "NodeSnapshotList", "type": "list", "members": { "shape_name": "NodeSnapshot", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " }, "CacheSize": { "shape_name": "String", "type": "string", "documentation": "\nThe size of the cache on the source cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " } }, "wrapper": true, "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", "xmlname": "NodeSnapshot" }, "documentation": "\nA list of the cache cluster nodes in the source cache cluster.
\n " } }, "wrapper": true, "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " } } }, "errors": [ { "shape_name": "SnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " }, { "shape_name": "InvalidSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the snapshot does not allow the requested action to occur.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DeleteSnapshot operation deletes an existing snapshot. When you receive a\n successful response from this operation, ElastiCache immediately begins deleting the snapshot;\n you cannot cancel or revert this operation.
\n " }, "DescribeCacheClusters": { "name": "DescribeCacheClusters", "input": { "shape_name": "DescribeCacheClustersMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cache cluster is returned. This parameter isn't case sensitive.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " }, "ShowCacheNodeInfo": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\nAn optional flag that can be included in the DescribeCacheCluster request to retrieve\n information about the individual cache nodes.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheClusters operation.
\n " }, "output": { "shape_name": "CacheClusterMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "CacheClusters": { "shape_name": "CacheClusterList", "type": "list", "members": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " } }, "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of the topic.
\n " } }, "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of parameter updates.
\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " } }, "documentation": "\nThe status of the cache parameter group.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created.
\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the parameter group applied to this cache node.
\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " } }, "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", "xmlname": "CacheNode" }, "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true
, then minor version patches are applied automatically; if\n false
, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a single cache security group and its status..
\n " }, "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n ", "xmlname": "CacheCluster" }, "documentation": "\nA list of cache clusters. Each item in the list contains detailed information about one\n cache cluster.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheClusters operation.
\n " }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeCacheClusters operation returns information about all provisioned\n cache clusters if no cache cluster identifier is specified, or about a specific cache\n cluster if a cache cluster identifier is supplied.
\nBy default, abbreviated information about the cache clusters(s) will be returned. You can\n use the optional ShowDetails flag to retrieve detailed information about the\n cache nodes associated with the cache clusters. These details include the DNS address\n and port for the cache node endpoint.
\nIf the cluster is in the CREATING state, only cluster level information will be displayed\n until all of the nodes are successfully provisioned.
\nIf the cluster is in the DELETING state, only cluster level information will be\n displayed.
\nIf cache nodes are currently being added to the cache cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the cache cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cache cluster, no endpoint\n information for the removed nodes is displayed.
\n\nThe cache engine to return. Valid values: memcached
| redis
The cache engine version to return.
\nExample: 1.4.14
The name of a specific cache parameter group family to return details for.
\nConstraints:
\nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " }, "DefaultOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheEngineVersions operation.
\n " }, "output": { "shape_name": "CacheEngineVersionMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "CacheEngineVersions": { "shape_name": "CacheEngineVersionList", "type": "list", "members": { "shape_name": "CacheEngineVersion", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version number of the cache engine.
\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group family associated with this cache engine.
\n " }, "CacheEngineDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache engine.
\n " }, "CacheEngineVersionDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache engine version.
\n " } }, "documentation": "\nProvides all of the details about a particular cache engine version.
\n ", "xmlname": "CacheEngineVersion" }, "documentation": "\nA list of cache engine version details. Each element in the list contains detailed\n information about once cache engine version.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheEngineVersions operation.
\n " }, "errors": [], "documentation": "\nThe DescribeCacheEngineVersions operation returns a list of the available cache\n engines and their versions.
\nThe name of a specific cache parameter group to return details for.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheParameterGroups operation.
\n " }, "output": { "shape_name": "CacheParameterGroupsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "CacheParameterGroups": { "shape_name": "CacheParameterGroupList", "type": "list", "members": { "shape_name": "CacheParameterGroup", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group family that this cache parameter group is\n compatible with.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description for this cache parameter group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of a CreateCacheParameterGroup operation.
\n ", "xmlname": "CacheParameterGroup" }, "documentation": "\nA list of cache parameter groups. Each element in the list contains detailed information\n about one cache parameter group.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheParameterGroups operation.
\n " }, "errors": [ { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeCacheParameterGroups operation returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list will contain only\n the descriptions for that group.
\nThe name of a specific cache parameter group to return details for.
\n ", "required": true }, "Source": { "shape_name": "String", "type": "string", "documentation": "\nThe parameter types to return.
\nValid values: user
| system
| engine-default
\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheParameters operation.
\n " }, "output": { "shape_name": "CacheParameterGroupDetails", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the parameter.
\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\nThe value of the parameter.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the parameter.
\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\nThe source of the parameter.
\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nThe valid data type for the parameter.
\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\nThe valid range of values for the parameter.
\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether (true
) or not (false
) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " } }, "documentation": "\nDescribes an individual setting that controls some aspect of ElastiCache behavior.
\n ", "xmlname": "Parameter" }, "documentation": "\nA list of Parameter instances.
\n " }, "CacheNodeTypeSpecificParameters": { "shape_name": "CacheNodeTypeSpecificParametersList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificParameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the parameter.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the parameter.
\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\nThe source of the parameter value.
\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nThe valid data type for the parameter.
\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\nThe valid range of values for the parameter.
\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether (true
) or not (false
) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " }, "CacheNodeTypeSpecificValues": { "shape_name": "CacheNodeTypeSpecificValueList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificValue", "type": "structure", "members": { "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type for which this value applies.
\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\nThe value for the cache node type.
\n " } }, "documentation": "\nA value that applies only to a certain cache node type.
\n ", "xmlname": "CacheNodeTypeSpecificValue" }, "documentation": "\nA list of cache node types and their corresponding values for this parameter.
\n " } }, "documentation": "\nA parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.
\n ", "xmlname": "CacheNodeTypeSpecificParameter" }, "documentation": "\nA list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheParameters operation.
\n " }, "errors": [ { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeCacheParameters operation returns the detailed parameter list for a\n particular cache parameter group.
\nThe name of the cache security group to return details for.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheSecurityGroups operation.
\n " }, "output": { "shape_name": "CacheSecurityGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroups", "type": "list", "members": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the cache security group owner.
\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache security group.
\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " } }, "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nA list of cache security groups. Each element in the list contains detailed information\n about one group.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheSecurityGroups operation.
\n " }, "errors": [ { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeCacheSecurityGroups operation returns a list of cache security group\n descriptions. If a cache security group name is specified, the list will contain only\n the description of that group.
\nThe name of the cache subnet group to return details for.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeCacheSubnetGroups operation.
\n " }, "output": { "shape_name": "CacheSubnetGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "CacheSubnetGroups": { "shape_name": "CacheSubnetGroups", "type": "list", "members": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group.
\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache subnet group.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identifier for the subnet
\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the availability zone.
\n " } }, "wrapper": true, "documentation": "\nThe Availability Zone associated with the subnet
\n " } }, "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", "xmlname": "Subnet" }, "documentation": "\nA list of subnets associated with the cache subnet group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nA list of cache subnet groups. Each element in the list contains detailed information\n about one group.
\n " } }, "documentation": "\nRepresents the output of a DescribeCacheSubnetGroups operation.
\n " }, "errors": [ { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " } ], "documentation": "\nThe DescribeCacheSubnetGroups operation returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list will contain only the\n description of that group.
\nThe name of the cache parameter group family. Valid values are: memcached1.4
\n | redis2.6
| redis2.8
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeEngineDefaultParameters operation.
\n " }, "output": { "shape_name": "EngineDefaultsWrapper", "type": "structure", "members": { "EngineDefaults": { "shape_name": "EngineDefaults", "type": "structure", "members": { "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies the name of the cache parameter group family to which the engine default\n parameters apply.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the parameter.
\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\nThe value of the parameter.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the parameter.
\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\nThe source of the parameter.
\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nThe valid data type for the parameter.
\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\nThe valid range of values for the parameter.
\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether (true
) or not (false
) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " } }, "documentation": "\nDescribes an individual setting that controls some aspect of ElastiCache behavior.
\n ", "xmlname": "Parameter" }, "documentation": "\nContains a list of engine default parameters.
\n " }, "CacheNodeTypeSpecificParameters": { "shape_name": "CacheNodeTypeSpecificParametersList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificParameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the parameter.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the parameter.
\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\nThe source of the parameter value.
\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\nThe valid data type for the parameter.
\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\nThe valid range of values for the parameter.
\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether (true
) or not (false
) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " }, "CacheNodeTypeSpecificValues": { "shape_name": "CacheNodeTypeSpecificValueList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificValue", "type": "structure", "members": { "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type for which this value applies.
\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\nThe value for the cache node type.
\n " } }, "documentation": "\nA value that applies only to a certain cache node type.
\n ", "xmlname": "CacheNodeTypeSpecificValue" }, "documentation": "\nA list of cache node types and their corresponding values for this parameter.
\n " } }, "documentation": "\nA parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.
\n ", "xmlname": "CacheNodeTypeSpecificParameter" }, "documentation": "\nA list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of a DescribeEngineDefaultParameters operation.
\n " } } }, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeEngineDefaultParameters operation returns the default engine and\n system parameter information for the specified cache engine.
\nThe identifier of the event source for which events will be returned. If not specified,\n then all sources are included in the response.
\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group" ], "documentation": "\nThe event source to retrieve events for. If no value is specified, all events are\n returned.
\nValid values are: cache-cluster
| cache-parameter-group
|\n cache-security-group
| cache-subnet-group
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n
\n " }, "EndTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe end of the time interval for which to retrieve events, specified in ISO 8601 format.\n
\n " }, "Duration": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of minutes' worth of events to retrieve.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeEvents operation.
\n " }, "output": { "shape_name": "EventsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "Events": { "shape_name": "EventList", "type": "list", "members": { "shape_name": "Event", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the source of the event. For example, if the event occurred at the\n cache cluster level, the identifier would be the name of the cache cluster.
\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group" ], "documentation": "\nSpecifies the origin of this event - a cache cluster, a parameter group, a security\n group, etc.
\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe text of the event.
\n " }, "Date": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the event occurred.
\n " } }, "documentation": "\nRepresents a single occurrence of something interesting within the system. Some examples\n of events are creating a cache cluster, adding or removing a cache node, or rebooting a\n node.
\n ", "xmlname": "Event" }, "documentation": "\nA list of events. Each element in the list contains detailed information about one\n event.
\n " } }, "documentation": "\nRepresents the output of a DescribeEvents operation.
\n " }, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeEvents operation returns events related to cache clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cache cluster, cache security group, or cache parameter group by providing\n the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; however, you can\n retrieve up to 14 days' worth of events if necessary.
\n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events", "py_input_token": "marker" } }, "DescribeReplicationGroups": { "name": "DescribeReplicationGroups", "input": { "shape_name": "DescribeReplicationGroupsMessage", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the replication group to be described. This parameter is not case\n sensitive.
\nIf you do not specify this parameter, information about all replication groups is\n returned.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeReplicationGroups operation.
\n " }, "output": { "shape_name": "ReplicationGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "ReplicationGroups": { "shape_name": "ReplicationGroupList", "type": "list", "members": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the replication group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the replication group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately
was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " } }, "documentation": "\nRepresents a single node within a node group.
\n ", "xmlname": "NodeGroupMember" }, "documentation": "\nA list containing information about individual nodes within the node group.
\n " } }, "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", "xmlname": "NodeGroup" }, "documentation": "\nA single element list with information about the nodes in the replication group.
\n " }, "SnapshottingClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " } }, "wrapper": true, "documentation": "\nContains all of the attributes of a specific replication group.
\n ", "xmlname": "ReplicationGroup" }, "documentation": "\nA list of replication groups. Each item in the list contains detailed information about\n one replication group.
\n " } }, "documentation": "\nRepresents the output of a DescribeReplicationGroups operation.
\n " }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe specified replication group does not exist.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeReplicationGroups operation returns information about a particular\n replication group. If no identifier is specified, DescribeReplicationGroups\n returns information about all replication groups.
\n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReplicationGroups", "py_input_token": "marker" } }, "DescribeReservedCacheNodes": { "name": "DescribeReservedCacheNodes", "input": { "shape_name": "DescribeReservedCacheNodesMessage", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.
\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\nThe offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.
\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\nThe duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations\n matching the specified product description.
\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\nThe offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.
\nValid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeReservedCacheNodes operation.
\n " }, "output": { "shape_name": "ReservedCacheNodeMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "ReservedCacheNodes": { "shape_name": "ReservedCacheNodeList", "type": "list", "members": { "shape_name": "ReservedCacheNode", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identifier for the reservation.
\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\nThe offering identifier.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type for the reserved cache nodes.
\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe time the reservation started.
\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe duration of the reservation in seconds.
\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price charged for this reserved cache node.
\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe hourly price charged for this reserved cache node.
\n " }, "CacheNodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of cache nodes that have been reserved.
\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the reserved cache node.
\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\nThe offering type of this reserved cache node.
\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\nThe state of the reserved cache node.
\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\nThe monetary amount of the recurring charge.
\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\nThe frequency of the recurring charge.
\n " } }, "wrapper": true, "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", "xmlname": "RecurringCharge" }, "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of a PurchaseReservedCacheNodesOffering operation.
\n ", "xmlname": "ReservedCacheNode" }, "documentation": "\nA list of reserved cache nodes. Each element in the list contains detailed information\n about one node.
\n " } }, "documentation": "\nRepresents the output of a DescribeReservedCacheNodes operation.
\n " }, "errors": [ { "shape_name": "ReservedCacheNodeNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested reserved cache node was not found.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeReservedCacheNodes operation returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.
\nThe offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings\n matching the specified cache node type.
\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\nDuration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.
\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\nThe offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.
\nValid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " } }, "documentation": "\nRepresents the input of a DescribeReservedCacheNodesOfferings operation.
\n " }, "output": { "shape_name": "ReservedCacheNodesOfferingMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " }, "ReservedCacheNodesOfferings": { "shape_name": "ReservedCacheNodesOfferingList", "type": "list", "members": { "shape_name": "ReservedCacheNodesOffering", "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\nA unique identifier for the reserved cache node offering.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type for the reserved cache node.
\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe duration of the offering. in seconds.
\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price charged for this offering.
\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe hourly price charged for this offering.
\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe cache engine used by the offering.
\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\nThe offering type.
\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\nThe monetary amount of the recurring charge.
\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\nThe frequency of the recurring charge.
\n " } }, "wrapper": true, "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", "xmlname": "RecurringCharge" }, "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " } }, "wrapper": true, "documentation": "\nDescribes all of the attributes of a reserved cache node offering.
\n ", "xmlname": "ReservedCacheNodesOffering" }, "documentation": "\nA list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.
\n " } }, "documentation": "\nRepresents the output of a DescribeReservedCacheNodesOfferings operation.
\n " }, "errors": [ { "shape_name": "ReservedCacheNodesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache node offering does not exist.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeReservedCacheNodesOfferings operation lists available reserved cache\n node offerings.
\nA user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cache cluster will be described.
\n " }, "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nA user-supplied name of the snapshot. If this parameter is specified, only this snapshot\n will be described.
\n " }, "SnapshotSource": { "shape_name": "String", "type": "string", "documentation": "\nIndicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
\n " } }, "documentation": "\nRepresents the input of a DescribeSnapshotsMessage operation.
\n " }, "output": { "shape_name": "DescribeSnapshotsListMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n \n " }, "Snapshots": { "shape_name": "SnapshotList", "type": "list", "members": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " }, "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " }, "SnapshotStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the snapshot. Valid values: creating
| available
\n | restoring
| deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).
The name of the compute and memory capacity node type for the source cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " }, "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true
) or not (false
).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " }, "NodeSnapshots": { "shape_name": "NodeSnapshotList", "type": "list", "members": { "shape_name": "NodeSnapshot", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " }, "CacheSize": { "shape_name": "String", "type": "string", "documentation": "\nThe size of the cache on the source cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " } }, "wrapper": true, "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", "xmlname": "NodeSnapshot" }, "documentation": "\nA list of the cache cluster nodes in the source cache cluster.
\n " } }, "wrapper": true, "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n ", "xmlname": "Snapshot" }, "documentation": "\nA list of snapshots. Each item in the list contains detailed information about one\n snapshot.
\n " } }, "documentation": "\nRepresents the output of a DescribeSnapshots operation.
\n " }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "SnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe DescribeSnapshots operation returns information about cache cluster snapshots.\n By default, DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
\n " }, "ModifyCacheCluster": { "name": "ModifyCacheCluster", "input": { "shape_name": "ModifyCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster identifier. This value is stored as a lowercase string.
\n ", "required": true }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes that the cache cluster should have. If the value for\n NumCacheNodes is greater than the existing number of cache nodes, then more\n nodes will be added. If the value is less than the existing number of cache nodes, then\n cache nodes will be removed.
\nIf you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter\n to provide the IDs of the specific cache nodes to be removed.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster and the value of\n NumCacheNodes in the request.
\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\nA list of cache security group names to authorize on this cache cluster. This change is\n asynchronously applied as soon as possible.
\nThis parameter can be used only with clusters that are created outside of an Amazon\n Virtual Private Cloud (VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\nSpecifies the VPC Security Groups associated with the cache cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (VPC).
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe weekly time range (in UTC) during which system maintenance can occur. Note that\n system maintenance may result in an outage. This change is made immediately. If you are\n moving this window to the current time, there must be at least 120 minutes between the\n current time and end of the window to ensure that pending changes are applied.
\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent.
\nThe name of the cache parameter group to apply to this cache cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.
\n " }, "NotificationTopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.
\nValid values: active
| inactive
If true
, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cache cluster.
If false
, then changes to the cache cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true
| false
Default: false
The upgraded version of the cache engine to be run on the cache cluster nodes.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\nIf true
, then minor engine upgrades will be applied automatically to the\n cache cluster during the maintenance window.
Valid values: true
| false
Default: true
The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\n " } }, "documentation": "\nRepresents the input of a ModifyCacheCluster operation.
\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " } }, "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of the topic.
\n " } }, "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of parameter updates.
\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " } }, "documentation": "\nThe status of the cache parameter group.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created.
\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the parameter group applied to this cache node.
\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " } }, "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", "xmlname": "CacheNode" }, "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true
, then minor version patches are applied automatically; if\n false
, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a single cache security group and its status..
\n " }, "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " } } }, "errors": [ { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "NodeQuotaForClusterExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.
\n " }, { "shape_name": "NodeQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n per customer.
\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\nThe VPC network is in an invalid state.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe ModifyCacheCluster operation modifies the settings for a cache cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.
\nThe name of the cache parameter group to modify.
\n ", "required": true }, "ParameterNameValues": { "shape_name": "ParameterNameValueList", "type": "list", "members": { "shape_name": "ParameterNameValue", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the parameter.
\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\nThe value of the parameter.
\n " } }, "documentation": "\nDescribes a name-value pair that is used to update the value of a parameter.
\n ", "xmlname": "ParameterNameValue" }, "documentation": "\nAn array of parameter names and values for the parameter update. You must supply at least\n one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.
\n ", "required": true } }, "documentation": "\nRepresents the input of a ModifyCacheParameterGroup operation.
\n " }, "output": { "shape_name": "CacheParameterGroupNameMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " } }, "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe ModifyCacheParameterGroup operation modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.
\nThe name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
A description for the cache subnet group.
\n " }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\nThe EC2 subnet IDs for the cache subnet group.
\n " } }, "documentation": "\nRepresents the input of a ModifyCacheSubnetGroup operation.
\n " }, "output": { "shape_name": "CacheSubnetGroupWrapper", "type": "structure", "members": { "CacheSubnetGroup": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group.
\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache subnet group.
\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identifier for the subnet
\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the availability zone.
\n " } }, "wrapper": true, "documentation": "\nThe Availability Zone associated with the subnet
\n " } }, "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", "xmlname": "Subnet" }, "documentation": "\nA list of subnets associated with the cache subnet group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " }, { "shape_name": "CacheSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.
\n " }, { "shape_name": "SubnetInUse", "type": "structure", "members": {}, "documentation": "\nThe requested subnet is being used by another cache subnet group.
\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\nAn invalid subnet identifier was specified.
\n " } ], "documentation": "\nThe ModifyCacheSubnetGroup operation modifies an existing cache subnet group.
\nThe identifier of the replication group to modify.
\n ", "required": true }, "ReplicationGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\nA description for the replication group. Maximum length is 255 characters.
\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\nA list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication groups containing cache clusters running\n outside of an Amazon Virtual Private Cloud (VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\nSpecifies the VPC Security Groups associated with the cache clusters in the replication\n group.
\nThis parameter can be used only with replication groups containing cache clusters running\n in an Amazon Virtual Private Cloud (VPC).
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe weekly time range (in UTC) during which replication group system maintenance can\n occur. Note that system maintenance may result in an outage. This change is made\n immediately. If you are moving this window to the current time, there must be at least\n 120 minutes between the current time and end of the window to ensure that pending\n changes are applied.
\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent.
\nThe name of the cache parameter group to apply to all of the cache nodes in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately parameter is specified as true for\n this request.
\n " }, "NotificationTopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon SNS notification topic for the replication group. Notifications\n are sent only if the status is active.
\nValid values: active
| inactive
If true
, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.
If false
, then changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true
| false
Default: false
The upgraded version of the cache engine to be run on the nodes in the replication\n group..
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\nDetermines whether minor engine upgrades will be applied automatically to all of the\n cache nodes in the replication group during the maintenance window. A value of\n true
allows these upgrades to occur; false
disables\n automatic upgrades.
If this parameter is specified, ElastiCache will promote each of the nodes in the specified\n cache cluster to the primary role. The nodes of all other clusters in the replication\n group will be read replicas.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "asdfasdf\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n the cache cluster specified by SnapshottingClusterId.
\nExample: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
\n \n " }, "SnapshottingClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster ID that will be used as the daily snapshot source for the replication\n group.
\n " } }, "documentation": "\nRepresents the input of a ModifyReplicationGroups operation.
\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the replication group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the replication group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately
was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " } }, "documentation": "\nRepresents a single node within a node group.
\n ", "xmlname": "NodeGroupMember" }, "documentation": "\nA list containing information about individual nodes within the node group.
\n " } }, "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", "xmlname": "NodeGroup" }, "documentation": "\nA single element list with information about the nodes in the replication group.
\n " }, "SnapshottingClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " } }, "wrapper": true, "documentation": "\nContains all of the attributes of a specific replication group.
\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe specified replication group does not exist.
\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested replication group is not in the available state.
\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\nThe VPC network is in an invalid state.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe ModifyReplicationGroup operation modifies the settings for a replication\n group.
\n " }, "PurchaseReservedCacheNodesOffering": { "name": "PurchaseReservedCacheNodesOffering", "input": { "shape_name": "PurchaseReservedCacheNodesOfferingMessage", "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the reserved cache node offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
\n ", "required": true }, "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nA customer-specified identifier to track this reservation.
\nExample: myreservationID
\n " }, "CacheNodeCount": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache node instances to reserve.
\nDefault: 1
Represents the input of a PurchaseReservedCacheNodesOffering operation.
\n " }, "output": { "shape_name": "ReservedCacheNodeWrapper", "type": "structure", "members": { "ReservedCacheNode": { "shape_name": "ReservedCacheNode", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe unique identifier for the reservation.
\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\nThe offering identifier.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node type for the reserved cache nodes.
\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe time the reservation started.
\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe duration of the reservation in seconds.
\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price charged for this reserved cache node.
\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\nThe hourly price charged for this reserved cache node.
\n " }, "CacheNodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of cache nodes that have been reserved.
\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the reserved cache node.
\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\nThe offering type of this reserved cache node.
\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\nThe state of the reserved cache node.
\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\nThe monetary amount of the recurring charge.
\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\nThe frequency of the recurring charge.
\n " } }, "wrapper": true, "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", "xmlname": "RecurringCharge" }, "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of a PurchaseReservedCacheNodesOffering operation.
\n " } } }, "errors": [ { "shape_name": "ReservedCacheNodesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache node offering does not exist.
\n " }, { "shape_name": "ReservedCacheNodeAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\nYou already have a reservation with the given identifier.
\n " }, { "shape_name": "ReservedCacheNodeQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\nThe request cannot be processed because it would exceed the user's cache node quota.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved\n cache node offering.
\nThe cache cluster identifier. This parameter is stored as a lowercase string.
\n ", "required": true }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache cluster node IDs to reboot. A node ID is a numeric identifier (0001,\n 0002, etc.). To reboot an entire cache cluster, specify all of the cache cluster node\n IDs.
\n ", "required": true } }, "documentation": "\nRepresents the input of a RebootCacheCluster operation.
\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of cache nodes in the cache cluster.
\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Availability Zone in which the cache cluster is located.
\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache cluster was created.
\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " } }, "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of the topic.
\n " } }, "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of parameter updates.
\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " } }, "documentation": "\nThe status of the cache parameter group.
\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe current state of this cache node.
\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\nThe date and time when the cache node was created.
\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\nThe DNS hostname of the cache node.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port number that the cache engine is listening on.
\n " } }, "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the parameter group applied to this cache node.
\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " } }, "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", "xmlname": "CacheNode" }, "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true
, then minor version patches are applied automatically; if\n false
, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " } }, "documentation": "\nRepresents a single cache security group and its status..
\n " }, "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " }, "SnapshotRetentionLimit": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\n " }, "SnapshotWindow": { "shape_name": "String", "type": "string", "documentation": "\nThe daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " } } }, "errors": [ { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster is not in the available state.
\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " } ], "documentation": "\nThe RebootCacheCluster operation reboots some, or all, of the cache cluster nodes\n within a provisioned cache cluster. This API will apply any modified cache parameter\n groups to the cache cluster. The reboot action takes place as soon as possible, and\n results in a momentary outage to the cache cluster. During the reboot, the cache cluster\n status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache cluster node being rebooted)\n to be lost.
\nWhen the reboot is complete, a cache cluster event is created.
\n " }, "ResetCacheParameterGroup": { "name": "ResetCacheParameterGroup", "input": { "shape_name": "ResetCacheParameterGroupMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group to reset.
\n ", "required": true }, "ResetAllParameters": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf true, all parameters in the cache parameter group will be reset to default\n values. If false, no such action occurs.
\nValid values: true
| false
The name of the parameter.
\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\nThe value of the parameter.
\n " } }, "documentation": "\nDescribes a name-value pair that is used to update the value of a parameter.
\n ", "xmlname": "ParameterNameValue" }, "documentation": "\nAn array of parameter names to be reset. If you are not resetting the entire cache\n parameter group, you must specify at least one parameter name.
\n ", "required": true } }, "documentation": "\nRepresents the input of a ResetCacheParameterGroup operation.
\n " }, "output": { "shape_name": "CacheParameterGroupNameMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache parameter group.
\n " } }, "documentation": "\nRepresents the output of one of the following operations:
\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe ResetCacheParameterGroup operation modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the ResetAllParameters and CacheParameterGroupName parameters.
\n " }, "RevokeCacheSecurityGroupIngress": { "name": "RevokeCacheSecurityGroupIngress", "input": { "shape_name": "RevokeCacheSecurityGroupIngressMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group to revoke ingress from.
\n ", "required": true }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Amazon EC2 security group to revoke access from.
\n ", "required": true }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.
\n ", "required": true } }, "documentation": "\nRepresents the input of a RevokeCacheSecurityGroupIngress operation.
\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the cache security group owner.
\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the cache security group.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the cache security group.
\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the Amazon EC2 security group.
\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " } }, "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " } }, "wrapper": true, "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " }, { "shape_name": "AuthorizationNotFoundFault", "type": "structure", "members": {}, "documentation": "\nThe specified Amazon EC2 security group is not authorized for the specified cache\n security group.
\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nA parameter value is invalid.
\n " } }, "documentation": "\nThe value for a parameter is invalid.
\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " } }, "documentation": "\nTwo or more incompatible parameters were specified.
\n " } ], "documentation": "\nThe RevokeCacheSecurityGroupIngress operation revokes ingress from a cache\n security group. Use this operation to disallow access from an Amazon EC2 security group\n that had been previously authorized.
\n