2014/10/16 - Amazon ElastiCache - 34 new api methods
The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
Request Syntax
client.describe_cache_security_groups(
CacheSecurityGroupName='string',
MaxRecords=123,
Marker='string'
)
string
The name of the cache security group to return details for.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'CacheSecurityGroups': [
{
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheSecurityGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheSecurityGroups (list) --
A list of cache security groups. Each element in the list contains detailed information about one group.
(dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
OwnerId (string) --
The AWS account ID of the cache security group owner.
CacheSecurityGroupName (string) --
The name of the cache security group.
Description (string) --
The description of the cache security group.
EC2SecurityGroups (list) --
A list of Amazon EC2 security groups that are associated with this cache security group.
(dict) --
Provides ownership and status information for an Amazon EC2 security group.
Status (string) --
The status of the Amazon EC2 security group.
EC2SecurityGroupName (string) --
The name of the Amazon EC2 security group.
EC2SecurityGroupOwnerId (string) --
The AWS account ID of the Amazon EC2 security group owner.
The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.
Request Syntax
client.describe_cache_parameters(
CacheParameterGroupName='string',
Source='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of a specific cache parameter group to return details for.
string
The parameter types to return.
Valid values: user | system | engine-default
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheParameters operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
Parameters (list) --
A list of Parameter instances.
(dict) --
Describes an individual setting that controls some aspect of ElastiCache behavior.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter.
DataType (string) --
The valid data type for the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether ( true ) or not ( false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest cache engine version to which the parameter can apply.
CacheNodeTypeSpecificParameters (list) --
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
(dict) --
A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
ParameterName (string) --
The name of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value.
DataType (string) --
The valid data type for the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether ( true ) or not ( false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest cache engine version to which the parameter can apply.
CacheNodeTypeSpecificValues (list) --
A list of cache node types and their corresponding values for this parameter.
(dict) --
A value that applies only to a certain cache node type.
CacheNodeType (string) --
The cache node type for which this value applies.
Value (string) --
The value for the cache node type.
The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup .
Request Syntax
client.create_cache_security_group(
CacheSecurityGroupName='string',
Description='string'
)
string
[REQUIRED]
A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word "Default".
Example: mysecuritygroup
string
[REQUIRED]
A description for the cache security group.
dict
Response Syntax
{
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
CacheSecurityGroup (dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
OwnerId (string) --
The AWS account ID of the cache security group owner.
CacheSecurityGroupName (string) --
The name of the cache security group.
Description (string) --
The description of the cache security group.
EC2SecurityGroups (list) --
A list of Amazon EC2 security groups that are associated with this cache security group.
(dict) --
Provides ownership and status information for an Amazon EC2 security group.
Status (string) --
The status of the Amazon EC2 security group.
EC2SecurityGroupName (string) --
The name of the Amazon EC2 security group.
EC2SecurityGroupOwnerId (string) --
The AWS account ID of the Amazon EC2 security group owner.
The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
Request Syntax
client.authorize_cache_security_group_ingress(
CacheSecurityGroupName='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
string
[REQUIRED]
The cache security group which will allow network ingress.
string
[REQUIRED]
The Amazon EC2 security group to be authorized for ingress to the cache security group.
string
[REQUIRED]
The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
dict
Response Syntax
{
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
CacheSecurityGroup (dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
OwnerId (string) --
The AWS account ID of the cache security group owner.
CacheSecurityGroupName (string) --
The name of the cache security group.
Description (string) --
The description of the cache security group.
EC2SecurityGroups (list) --
A list of Amazon EC2 security groups that are associated with this cache security group.
(dict) --
Provides ownership and status information for an Amazon EC2 security group.
Status (string) --
The status of the Amazon EC2 security group.
EC2SecurityGroupName (string) --
The name of the Amazon EC2 security group.
EC2SecurityGroupOwnerId (string) --
The AWS account ID of the Amazon EC2 security group owner.
The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.
When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.
Request Syntax
client.create_replication_group(
ReplicationGroupId='string',
PrimaryClusterId='string',
ReplicationGroupDescription='string'
)
string
[REQUIRED]
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 20 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
[REQUIRED]
The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available .
string
[REQUIRED]
A user-specified description for the replication group.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroup (dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The description of the replication group.
Status (string) --
The current state of this replication group - creating , available , etc.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(dict) --
Represents a collection of cache nodes in a replication group.
NodeGroupId (string) --
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
Status (string) --
The current state of this replication group - creating , available , etc.
PrimaryEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group.
(dict) --
Represents a single node within a node group.
CacheClusterId (string) --
The ID of the cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.
Request Syntax
client.modify_cache_subnet_group(
CacheSubnetGroupName='string',
CacheSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
string
A description for the cache subnet group.
list
The EC2 subnet IDs for the cache subnet group.
(string) --
dict
Response Syntax
{
'CacheSubnetGroup': {
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
}
}
Response Structure
(dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroup (dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroupName (string) --
The name of the cache subnet group.
CacheSubnetGroupDescription (string) --
The description of the cache subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Subnets (list) --
A list of subnets associated with the cache subnet group.
(dict) --
Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
SubnetIdentifier (string) --
The unique identifier for the subnet
SubnetAvailabilityZone (dict) --
The Availability Zone associated with the subnet
Name (string) --
The name of the Availability Zone.
The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.
Request Syntax
client.describe_reserved_cache_nodes_offerings(
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MaxRecords=123,
Marker='string'
)
string
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
string
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
string
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
string
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
string
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'ReservedCacheNodesOfferings': [
{
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'ProductDescription': 'string',
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeReservedCacheNodesOfferings operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
ReservedCacheNodesOfferings (list) --
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
(dict) --
Describes all of the attributes of a reserved cache node offering.
ReservedCacheNodesOfferingId (string) --
A unique identifier for the reserved cache node offering.
CacheNodeType (string) --
The cache node type for the reserved cache node.
Duration (integer) --
The duration of the offering. in seconds.
FixedPrice (float) --
The fixed price charged for this offering.
UsagePrice (float) --
The hourly price charged for this offering.
ProductDescription (string) --
The cache engine used by the offering.
OfferingType (string) --
The offering type.
RecurringCharges (list) --
The recurring price charged to run this reserved cache node.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
Request Syntax
client.modify_cache_parameter_group(
CacheParameterGroupName='string',
ParameterNameValues=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
string
[REQUIRED]
The name of the cache parameter group to modify.
list
[REQUIRED]
An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
(dict) --
Describes a name-value pair that is used to update the value of a parameter.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
dict
Response Syntax
{
'CacheParameterGroupName': 'string'
}
Response Structure
(dict) --
Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
CacheParameterGroupName (string) --
The name of the cache parameter group.
The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.
Request Syntax
client.describe_reserved_cache_nodes(
ReservedCacheNodeId='string',
ReservedCacheNodesOfferingId='string',
CacheNodeType='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MaxRecords=123,
Marker='string'
)
string
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
string
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
string
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
string
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
string
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
string
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'ReservedCacheNodes': [
{
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeReservedCacheNodes operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
ReservedCacheNodes (list) --
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
(dict) --
Represents the output of a PurchaseReservedCacheNodesOffering operation.
ReservedCacheNodeId (string) --
The unique identifier for the reservation.
ReservedCacheNodesOfferingId (string) --
The offering identifier.
CacheNodeType (string) --
The cache node type for the reserved cache nodes.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved cache node.
UsagePrice (float) --
The hourly price charged for this reserved cache node.
CacheNodeCount (integer) --
The number of cache nodes that have been reserved.
ProductDescription (string) --
The description of the reserved cache node.
OfferingType (string) --
The offering type of this reserved cache node.
State (string) --
The state of the reserved cache node.
RecurringCharges (list) --
The recurring price charged to run this reserved cache node.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.
Request Syntax
client.delete_cache_cluster(
CacheClusterId='string',
FinalSnapshotIdentifier='string'
)
string
[REQUIRED]
The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
string
The name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster - creating , available , etc.
NumCacheNodes (integer) --
The number of cache nodes in the cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur.
PendingModifiedValues (dict) --
A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster will run.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
The status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname and IP address for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
If true , then minor version patches are applied automatically; if false , then automatic minor version patches are disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status..
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
Request Syntax
client.revoke_cache_security_group_ingress(
CacheSecurityGroupName='string',
EC2SecurityGroupName='string',
EC2SecurityGroupOwnerId='string'
)
string
[REQUIRED]
The name of the cache security group to revoke ingress from.
string
[REQUIRED]
The name of the Amazon EC2 security group to revoke access from.
string
[REQUIRED]
The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
dict
Response Syntax
{
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
CacheSecurityGroup (dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
OwnerId (string) --
The AWS account ID of the cache security group owner.
CacheSecurityGroupName (string) --
The name of the cache security group.
Description (string) --
The description of the cache security group.
EC2SecurityGroups (list) --
A list of Amazon EC2 security groups that are associated with this cache security group.
(dict) --
Provides ownership and status information for an Amazon EC2 security group.
Status (string) --
The status of the Amazon EC2 security group.
EC2SecurityGroupName (string) --
The name of the Amazon EC2 security group.
EC2SecurityGroupOwnerId (string) --
The AWS account ID of the Amazon EC2 security group owner.
The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
Request Syntax
client.describe_snapshots(
CacheClusterId='string',
SnapshotName='string',
SnapshotSource='string',
Marker='string',
MaxRecords=123
)
string
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
string
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.
string
If set to system , the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
dict
Response Syntax
{
'Marker': 'string',
'Snapshots': [
{
'SnapshotName': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NodeSnapshots': [
{
'CacheNodeId': 'string',
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeSnapshots operation.
Marker (string) --
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Snapshots (list) --
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
CacheClusterId (string) --
The user-supplied identifier of the source cache cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) used by the source cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cache cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cache cluster is located.
CacheClusterCreateTime (datetime) --
The date and time when the source cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cache cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cache cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cache cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
AutoMinorVersionUpgrade (boolean) --
For the source cache cluster, indicates whether minor version patches are applied automatically ( true ) or not ( false ).
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
NodeSnapshots (list) --
A list of the cache nodes in the source cache cluster.
(dict) --
Represents an individual cache node in a snapshot of a cache cluster.
CacheNodeId (string) --
The cache node identifier for the node in the source cache cluster.
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cache cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
The DeleteCacheSubnetGroup operation deletes a cache subnet group.
Request Syntax
client.delete_cache_subnet_group(
CacheSubnetGroupName='string'
)
string
[REQUIRED]
The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
None
The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.
Request Syntax
client.create_cache_parameter_group(
CacheParameterGroupName='string',
CacheParameterGroupFamily='string',
Description='string'
)
string
[REQUIRED]
A user-specified name for the cache parameter group.
string
[REQUIRED]
The name of the cache parameter group family the cache parameter group can be used with.
Valid values are: memcached1.4 | redis2.6 | redis2.8
string
[REQUIRED]
A user-specified description for the cache parameter group.
dict
Response Syntax
{
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Represents the output of a CreateCacheParameterGroup operation.
CacheParameterGroup (dict) --
Represents the output of a CreateCacheParameterGroup operation.
CacheParameterGroupName (string) --
The name of the cache parameter group.
CacheParameterGroupFamily (string) --
The name of the cache parameter group family that this cache parameter group is compatible with.
Description (string) --
The description for this cache parameter group.
The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
Request Syntax
client.describe_replication_groups(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
string
The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'ReplicationGroups': [
{
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeReplicationGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
ReplicationGroups (list) --
A list of replication groups. Each item in the list contains detailed information about one replication group.
(dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The description of the replication group.
Status (string) --
The current state of this replication group - creating , available , etc.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(dict) --
Represents a collection of cache nodes in a replication group.
NodeGroupId (string) --
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
Status (string) --
The current state of this replication group - creating , available , etc.
PrimaryEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group.
(dict) --
Represents a single node within a node group.
CacheClusterId (string) --
The ID of the cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
The CopySnapshot operation makes a copy of an existing snapshot.
Request Syntax
client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string'
)
string
[REQUIRED]
The name of an existing snapshot from which to copy.
string
[REQUIRED]
A name for the copied snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NodeSnapshots': [
{
'CacheNodeId': 'string',
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
Snapshot (dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
CacheClusterId (string) --
The user-supplied identifier of the source cache cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) used by the source cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cache cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cache cluster is located.
CacheClusterCreateTime (datetime) --
The date and time when the source cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cache cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cache cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cache cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
AutoMinorVersionUpgrade (boolean) --
For the source cache cluster, indicates whether minor version patches are applied automatically ( true ) or not ( false ).
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
NodeSnapshots (list) --
A list of the cache nodes in the source cache cluster.
(dict) --
Represents an individual cache node in a snapshot of a cache cluster.
CacheNodeId (string) --
The cache node identifier for the node in the source cache cluster.
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cache cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.
Request Syntax
client.describe_cache_engine_versions(
Engine='string',
EngineVersion='string',
CacheParameterGroupFamily='string',
MaxRecords=123,
Marker='string',
DefaultOnly=True|False
)
string
The cache engine to return. Valid values: memcached | redis
string
The cache engine version to return.
Example: 1.4.14
string
The name of a specific cache parameter group family to return details for.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
boolean
If true , specifies that only the default version of the specified engine or engine and major version combination is to be returned.
dict
Response Syntax
{
'Marker': 'string',
'CacheEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'CacheParameterGroupFamily': 'string',
'CacheEngineDescription': 'string',
'CacheEngineVersionDescription': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheEngineVersions operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheEngineVersions (list) --
A list of cache engine version details. Each element in the list contains detailed information about once cache engine version.
(dict) --
Provides all of the details about a particular cache engine version.
Engine (string) --
The name of the cache engine.
EngineVersion (string) --
The version number of the cache engine.
CacheParameterGroupFamily (string) --
The name of the cache parameter group family associated with this cache engine.
CacheEngineDescription (string) --
The description of the cache engine.
CacheEngineVersionDescription (string) --
The description of the cache engine version.
The ModifyReplicationGroup operation modifies the settings for a replication group.
Request Syntax
client.modify_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
PrimaryClusterId='string',
SnapshotRetentionLimit=123,
SnapshotWindow='string',
SnapshottingClusterId='string'
)
string
[REQUIRED]
The identifier of the replication group to modify.
string
A description for the replication group. Maximum length is 255 characters.
list
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication groups containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
(string) --
list
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
(string) --
string
The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
string
The name of the cache parameter group to apply to all of the cache nodes in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
string
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active .
Valid values: active | inactive
boolean
If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false , then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
string
The upgraded version of the cache engine to be run on the nodes in the replication group..
boolean
Determines whether minor engine upgrades will be applied automatically to all of the cache nodes in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
string
If this parameter is specified, ElastiCache will promote each of the nodes in the specified cache cluster to the primary role. The nodes of all other clusters in the replication group will be read replicas.
integer
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
string
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster specified by SnapshottingClusterId .
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
string
The cache cluster ID that will be used as the daily snapshot source for the replication group.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroup (dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The description of the replication group.
Status (string) --
The current state of this replication group - creating , available , etc.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(dict) --
Represents a collection of cache nodes in a replication group.
NodeGroupId (string) --
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
Status (string) --
The current state of this replication group - creating , available , etc.
PrimaryEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group.
(dict) --
Represents a single node within a node group.
CacheClusterId (string) --
The ID of the cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
Request Syntax
client.modify_cache_cluster(
CacheClusterId='string',
NumCacheNodes=123,
CacheNodeIdsToRemove=[
'string',
],
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
AZMode='string',
NewAvailabilityZones=[
'string',
]
)
string
[REQUIRED]
The cache cluster identifier. This value is stored as a lowercase string.
integer
The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For cache clusters running Redis, the value of NumCacheNodes must be 1.
Note: Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately .A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
list
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
(string) --
list
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
(string) --
list
Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
(string) --
string
The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
string
The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active .
Valid values: active | inactive
boolean
If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
If false , then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Warning
If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
string
The upgraded version of the cache engine to be run on the cache nodes.
boolean
If true , then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
Valid values: true | false
Default: true
integer
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
string
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
string
Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az .
list
The list of Availability Zones where the new Memcached cache nodes will be created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
This option is only supported on Memcached clusters.
Scenarios:
Scenario 1: You have 3 active nodes and wish to add 2 nodes.Specify NumCacheNodes=5 (3 + 2) and opitonally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.Specify NumCacheNodes=6 ((3 + 2) + 1)
and optionally specify an Availability Zone for the new node. * Scenario 3: You have 3 active nodes and want to cancel the pending additional nodes from scenarios 1 and 2.Specify NumCacheNodes=3 to cancel the additions from scenarios 1 and 2.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
(string) --
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster - creating , available , etc.
NumCacheNodes (integer) --
The number of cache nodes in the cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur.
PendingModifiedValues (dict) --
A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster will run.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
The status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname and IP address for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
If true , then minor version patches are applied automatically; if false , then automatic minor version patches are disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status..
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.
If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
Request Syntax
client.describe_cache_clusters(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=True|False
)
string
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
boolean
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
dict
Response Syntax
{
'Marker': 'string',
'CacheClusters': [
{
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheClusters operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheClusters (list) --
A list of cache clusters. Each item in the list contains detailed information about one cache cluster.
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster - creating , available , etc.
NumCacheNodes (integer) --
The number of cache nodes in the cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur.
PendingModifiedValues (dict) --
A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster will run.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
The status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname and IP address for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
If true , then minor version patches are applied automatically; if false , then automatic minor version patches are disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status..
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
Request Syntax
client.describe_events(
SourceIdentifier='string',
SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxRecords=123,
Marker='string'
)
string
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
string
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
datetime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
datetime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
integer
The number of minutes' worth of events to retrieve.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeEvents operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
Events (list) --
A list of events. Each element in the list contains detailed information about one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.
SourceIdentifier (string) --
The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.
SourceType (string) --
Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.
Message (string) --
The text of the event.
Date (datetime) --
The date and time when the event occurred.
The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.
Request Syntax
client.create_cache_cluster(
CacheClusterId='string',
ReplicationGroupId='string',
NumCacheNodes=123,
CacheNodeType='string',
Engine='string',
EngineVersion='string',
CacheParameterGroupName='string',
CacheSubnetGroupName='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
SnapshotArns=[
'string',
],
SnapshotName='string',
AZMode='string',
PreferredAvailabilityZone='string',
PreferredAvailabilityZones=[
'string',
],
PreferredMaintenanceWindow='string',
Port=123,
NotificationTopicArn='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string'
)
string
[REQUIRED]
The cache cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 20 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
The replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.
integer
The initial number of cache nodes that the cache cluster will have.
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/ .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
string
The compute and memory capacity of the nodes in the cache cluster.
Valid cache types
Micro cache.t1.micro | cache.m1.small
General Purpose
Current Generation cache.m3.medium | cache.m3.large | cache.m3.xlarge | cache.m3.2xlarge
Previous Generation cache.m1.medium | cache.m1.large | cache.m1.xlarge
Compute Optimized cache.c1.xlarge
Memory Optimized
Current Generation cache.r3.large | cache.r3.xlarge | cache.r3.2xlarge | cache.r3.4xlarge | cache.r3.8xlarge
Previous Generation cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
string
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached | redis
string
The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
string
The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.
string
The name of the cache subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
list
A list of cache security group names to associate with this cache cluster.
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
(string) --
list
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
(string) --
list
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.
Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This parameter is only valid if the Engine parameter is redis .
(string) --
string
The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.
string
Specifies whether the nodes in this Memcached cache cluster are created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az .
string
The EC2 Availability Zone in which the cache cluster will be created.
All cache nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your cache nodes across multiple Availability Zones, use PreferredAvailabilityZones .
Default: System chosen Availability Zone.
list
A list of the Availability Zones in which nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached clusters.
If you want all your cache nodes in the same Availability Zone, use PreferredAvailabilityZone instead or repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of three Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
(string) --
string
The weekly time range (in UTC) during which system maintenance can occur.
Example: sun:05:00-sun:09:00
integer
The port number on which each of the cache nodes will accept connections.
string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
boolean
Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.
Default: true
integer
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).
string
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster - creating , available , etc.
NumCacheNodes (integer) --
The number of cache nodes in the cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur.
PendingModifiedValues (dict) --
A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster will run.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
The status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname and IP address for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
If true , then minor version patches are applied automatically; if false , then automatic minor version patches are disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status..
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.
Request Syntax
client.create_snapshot(
CacheClusterId='string',
SnapshotName='string'
)
string
[REQUIRED]
The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.
string
[REQUIRED]
A name for the snapshot being created.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NodeSnapshots': [
{
'CacheNodeId': 'string',
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
Snapshot (dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
CacheClusterId (string) --
The user-supplied identifier of the source cache cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) used by the source cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cache cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cache cluster is located.
CacheClusterCreateTime (datetime) --
The date and time when the source cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cache cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cache cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cache cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
AutoMinorVersionUpgrade (boolean) --
For the source cache cluster, indicates whether minor version patches are applied automatically ( true ) or not ( false ).
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
NodeSnapshots (list) --
A list of the cache nodes in the source cache cluster.
(dict) --
Represents an individual cache node in a snapshot of a cache cluster.
CacheNodeId (string) --
The cache node identifier for the node in the source cache cluster.
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cache cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
Request Syntax
client.describe_cache_parameter_groups(
CacheParameterGroupName='string',
MaxRecords=123,
Marker='string'
)
string
The name of a specific cache parameter group to return details for.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'CacheParameterGroups': [
{
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheParameterGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheParameterGroups (list) --
A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
(dict) --
Represents the output of a CreateCacheParameterGroup operation.
CacheParameterGroupName (string) --
The name of the cache parameter group.
CacheParameterGroupFamily (string) --
The name of the cache parameter group family that this cache parameter group is compatible with.
Description (string) --
The description for this cache parameter group.
The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.
Request Syntax
client.purchase_reserved_cache_nodes_offering(
ReservedCacheNodesOfferingId='string',
ReservedCacheNodeId='string',
CacheNodeCount=123
)
string
[REQUIRED]
The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
string
A customer-specified identifier to track this reservation.
Example: myreservationID
integer
The number of cache node instances to reserve.
Default: 1
dict
Response Syntax
{
'ReservedCacheNode': {
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the output of a PurchaseReservedCacheNodesOffering operation.
ReservedCacheNode (dict) --
Represents the output of a PurchaseReservedCacheNodesOffering operation.
ReservedCacheNodeId (string) --
The unique identifier for the reservation.
ReservedCacheNodesOfferingId (string) --
The offering identifier.
CacheNodeType (string) --
The cache node type for the reserved cache nodes.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved cache node.
UsagePrice (float) --
The hourly price charged for this reserved cache node.
CacheNodeCount (integer) --
The number of cache nodes that have been reserved.
ProductDescription (string) --
The description of the reserved cache node.
OfferingType (string) --
The offering type of this reserved cache node.
State (string) --
The state of the reserved cache node.
RecurringCharges (list) --
The recurring price charged to run this reserved cache node.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
The DeleteCacheSecurityGroup operation deletes a cache security group.
Request Syntax
client.delete_cache_security_group(
CacheSecurityGroupName='string'
)
string
[REQUIRED]
The name of the cache security group to delete.
None
The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.
Request Syntax
client.describe_engine_default_parameters(
CacheParameterGroupFamily='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'EngineDefaults': {
'CacheParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
],
'CacheNodeTypeSpecificParameters': [
{
'ParameterName': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'string',
'Value': 'string'
},
]
},
]
}
}
Response Structure
(dict) --
Represents the output of a DescribeEngineDefaultParameters operation.
EngineDefaults (dict) --
Represents the output of a DescribeEngineDefaultParameters operation.
CacheParameterGroupFamily (string) --
Specifies the name of the cache parameter group family to which the engine default parameters apply.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
Parameters (list) --
Contains a list of engine default parameters.
(dict) --
Describes an individual setting that controls some aspect of ElastiCache behavior.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter.
DataType (string) --
The valid data type for the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether ( true ) or not ( false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest cache engine version to which the parameter can apply.
CacheNodeTypeSpecificParameters (list) --
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
(dict) --
A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
ParameterName (string) --
The name of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value.
DataType (string) --
The valid data type for the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether ( true ) or not ( false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest cache engine version to which the parameter can apply.
CacheNodeTypeSpecificValues (list) --
A list of cache node types and their corresponding values for this parameter.
(dict) --
A value that applies only to a certain cache node type.
CacheNodeType (string) --
The cache node type for which this value applies.
Value (string) --
The value for the cache node type.
The RebootCacheCluster operation reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cache cluster event is created.
Request Syntax
client.reboot_cache_cluster(
CacheClusterId='string',
CacheNodeIdsToReboot=[
'string',
]
)
string
[REQUIRED]
The cache cluster identifier. This parameter is stored as a lowercase string.
list
[REQUIRED]
A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.
(string) --
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster - creating , available , etc.
NumCacheNodes (integer) --
The number of cache nodes in the cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur.
PendingModifiedValues (dict) --
A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster will run.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
The status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname and IP address for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
If true , then minor version patches are applied automatically; if false , then automatic minor version patches are disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status..
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
The CreateCacheSubnetGroup operation creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
Request Syntax
client.create_cache_subnet_group(
CacheSubnetGroupName='string',
CacheSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
string
[REQUIRED]
A description for the cache subnet group.
list
[REQUIRED]
A list of VPC subnet IDs for the cache subnet group.
(string) --
dict
Response Syntax
{
'CacheSubnetGroup': {
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
}
}
Response Structure
(dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroup (dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroupName (string) --
The name of the cache subnet group.
CacheSubnetGroupDescription (string) --
The description of the cache subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Subnets (list) --
A list of subnets associated with the cache subnet group.
(dict) --
Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
SubnetIdentifier (string) --
The unique identifier for the subnet
SubnetAvailabilityZone (dict) --
The Availability Zone associated with the subnet
Name (string) --
The name of the Availability Zone.
The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
Request Syntax
client.delete_cache_parameter_group(
CacheParameterGroupName='string'
)
string
[REQUIRED]
The name of the cache parameter group to delete.
None
The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
Request Syntax
client.delete_snapshot(
SnapshotName='string'
)
string
[REQUIRED]
The name of the snapshot to be deleted.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NodeSnapshots': [
{
'CacheNodeId': 'string',
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
Snapshot (dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
CacheClusterId (string) --
The user-supplied identifier of the source cache cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cache cluster.
Engine (string) --
The name of the cache engine (memcached or redis ) used by the source cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cache cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cache cluster.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cache cluster is located.
CacheClusterCreateTime (datetime) --
The date and time when the source cache cluster was created.
PreferredMaintenanceWindow (string) --
The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cache cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cache cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cache cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
AutoMinorVersionUpgrade (boolean) --
For the source cache cluster, indicates whether minor version patches are applied automatically ( true ) or not ( false ).
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
NodeSnapshots (list) --
A list of the cache nodes in the source cache cluster.
(dict) --
Represents an individual cache node in a snapshot of a cache cluster.
CacheNodeId (string) --
The cache node identifier for the node in the source cache cluster.
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cache cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
Request Syntax
client.reset_cache_parameter_group(
CacheParameterGroupName='string',
ResetAllParameters=True|False,
ParameterNameValues=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
string
[REQUIRED]
The name of the cache parameter group to reset.
boolean
If true , all parameters in the cache parameter group will be reset to default values. If false , no such action occurs.
Valid values: true | false
list
[REQUIRED]
An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.
(dict) --
Describes a name-value pair that is used to update the value of a parameter.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
dict
Response Syntax
{
'CacheParameterGroupName': 'string'
}
Response Structure
(dict) --
Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
CacheParameterGroupName (string) --
The name of the cache parameter group.
The DeleteReplicationGroup operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
Request Syntax
client.delete_replication_group(
ReplicationGroupId='string',
RetainPrimaryCluster=True|False,
FinalSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier for the replication group to be deleted. This parameter is not case sensitive.
boolean
If set to true , all of the read replicas will be deleted, but the primary cache cluster will be retained.
string
The 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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string'
}
}
Response Structure
(dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroup (dict) --
Contains all of the attributes of a specific replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The description of the replication group.
Status (string) --
The current state of this replication group - creating , available , etc.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(dict) --
Represents a collection of cache nodes in a replication group.
NodeGroupId (string) --
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
Status (string) --
The current state of this replication group - creating , available , etc.
PrimaryEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group.
(dict) --
Represents a single node within a node group.
CacheClusterId (string) --
The ID of the cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
Represents the information required for client programs to connect to a cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
Request Syntax
client.describe_cache_subnet_groups(
CacheSubnetGroupName='string',
MaxRecords=123,
Marker='string'
)
string
The name of the cache subnet group to return details for.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'CacheSubnetGroups': [
{
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheSubnetGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheSubnetGroups (list) --
A list of cache subnet groups. Each element in the list contains detailed information about one group.
(dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroupName (string) --
The name of the cache subnet group.
CacheSubnetGroupDescription (string) --
The description of the cache subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Subnets (list) --
A list of subnets associated with the cache subnet group.
(dict) --
Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
SubnetIdentifier (string) --
The unique identifier for the subnet
SubnetAvailabilityZone (dict) --
The Availability Zone associated with the subnet
Name (string) --
The name of the Availability Zone.