2024/12/02 - Amazon MemoryDB - 5 new10 updated api methods
Changes Amazon MemoryDB SDK now supports all APIs for Multi-Region. Please refer to the updated Amazon MemoryDB public documentation for detailed information on API usage.
Creates a new multi-Region cluster.
See also: AWS API Documentation
Request Syntax
client.create_multi_region_cluster(
MultiRegionClusterNameSuffix='string',
Description='string',
Engine='string',
EngineVersion='string',
NodeType='string',
MultiRegionParameterGroupName='string',
NumShards=123,
TLSEnabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A suffix to be added to the multi-Region cluster name.
string
A description for the multi-Region cluster.
string
The name of the engine to be used for the multi-Region cluster.
string
The version of the engine to be used for the multi-Region cluster.
string
[REQUIRED]
The node type to be used for the multi-Region cluster.
string
The name of the multi-Region parameter group to be associated with the cluster.
integer
The number of shards for the multi-Region cluster.
boolean
Whether to enable TLS encryption for the multi-Region cluster.
list
A list of tags to be applied to the multi-Region cluster.
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'MultiRegionCluster': {
'MultiRegionClusterName': 'string',
'Description': 'string',
'Status': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumberOfShards': 123,
'Clusters': [
{
'ClusterName': 'string',
'Region': 'string',
'Status': 'string',
'ARN': 'string'
},
],
'MultiRegionParameterGroupName': 'string',
'TLSEnabled': True|False,
'ARN': 'string'
}
}
Response Structure
(dict) --
MultiRegionCluster (dict) --
Details about the newly created multi-Region cluster.
MultiRegionClusterName (string) --
The name of the multi-Region cluster.
Description (string) --
The description of the multi-Region cluster.
Status (string) --
The current status of the multi-Region cluster.
NodeType (string) --
The node type used by the multi-Region cluster.
Engine (string) --
The name of the engine used by the multi-Region cluster.
EngineVersion (string) --
The version of the engine used by the multi-Region cluster.
NumberOfShards (integer) --
The number of shards in the multi-Region cluster.
Clusters (list) --
The clusters in this multi-Region cluster.
(dict) --
Represents a Regional cluster
ClusterName (string) --
The name of the Regional cluster
Region (string) --
The Region the current Regional cluster is assigned to.
Status (string) --
The status of the Regional cluster.
ARN (string) --
The Amazon Resource Name (ARN) the Regional cluster
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster.
TLSEnabled (boolean) --
Indiciates if the multi-Region cluster is TLS enabled.
ARN (string) --
The Amazon Resource Name (ARN) of the multi-Region cluster.
Returns details about one or more multi-Region clusters.
See also: AWS API Documentation
Request Syntax
client.describe_multi_region_clusters(
MultiRegionClusterName='string',
MaxResults=123,
NextToken='string',
ShowClusterDetails=True|False
)
string
The name of a specific multi-Region cluster to describe.
integer
The maximum number of results to return.
string
A token to specify where to start paginating.
boolean
Details about the multi-Region cluster.
dict
Response Syntax
{
'NextToken': 'string',
'MultiRegionClusters': [
{
'MultiRegionClusterName': 'string',
'Description': 'string',
'Status': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumberOfShards': 123,
'Clusters': [
{
'ClusterName': 'string',
'Region': 'string',
'Status': 'string',
'ARN': 'string'
},
],
'MultiRegionParameterGroupName': 'string',
'TLSEnabled': True|False,
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A token to use to retrieve the next page of results.
MultiRegionClusters (list) --
A list of multi-Region clusters.
(dict) --
Represents a multi-Region cluster.
MultiRegionClusterName (string) --
The name of the multi-Region cluster.
Description (string) --
The description of the multi-Region cluster.
Status (string) --
The current status of the multi-Region cluster.
NodeType (string) --
The node type used by the multi-Region cluster.
Engine (string) --
The name of the engine used by the multi-Region cluster.
EngineVersion (string) --
The version of the engine used by the multi-Region cluster.
NumberOfShards (integer) --
The number of shards in the multi-Region cluster.
Clusters (list) --
The clusters in this multi-Region cluster.
(dict) --
Represents a Regional cluster
ClusterName (string) --
The name of the Regional cluster
Region (string) --
The Region the current Regional cluster is assigned to.
Status (string) --
The status of the Regional cluster.
ARN (string) --
The Amazon Resource Name (ARN) the Regional cluster
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster.
TLSEnabled (boolean) --
Indiciates if the multi-Region cluster is TLS enabled.
ARN (string) --
The Amazon Resource Name (ARN) of the multi-Region cluster.
Deletes an existing multi-Region cluster.
See also: AWS API Documentation
Request Syntax
client.delete_multi_region_cluster(
MultiRegionClusterName='string'
)
string
[REQUIRED]
The name of the multi-Region cluster to be deleted.
dict
Response Syntax
{
'MultiRegionCluster': {
'MultiRegionClusterName': 'string',
'Description': 'string',
'Status': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumberOfShards': 123,
'Clusters': [
{
'ClusterName': 'string',
'Region': 'string',
'Status': 'string',
'ARN': 'string'
},
],
'MultiRegionParameterGroupName': 'string',
'TLSEnabled': True|False,
'ARN': 'string'
}
}
Response Structure
(dict) --
MultiRegionCluster (dict) --
Details about the deleted multi-Region cluster.
MultiRegionClusterName (string) --
The name of the multi-Region cluster.
Description (string) --
The description of the multi-Region cluster.
Status (string) --
The current status of the multi-Region cluster.
NodeType (string) --
The node type used by the multi-Region cluster.
Engine (string) --
The name of the engine used by the multi-Region cluster.
EngineVersion (string) --
The version of the engine used by the multi-Region cluster.
NumberOfShards (integer) --
The number of shards in the multi-Region cluster.
Clusters (list) --
The clusters in this multi-Region cluster.
(dict) --
Represents a Regional cluster
ClusterName (string) --
The name of the Regional cluster
Region (string) --
The Region the current Regional cluster is assigned to.
Status (string) --
The status of the Regional cluster.
ARN (string) --
The Amazon Resource Name (ARN) the Regional cluster
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster.
TLSEnabled (boolean) --
Indiciates if the multi-Region cluster is TLS enabled.
ARN (string) --
The Amazon Resource Name (ARN) of the multi-Region cluster.
Lists the allowed updates for a multi-Region cluster.
See also: AWS API Documentation
Request Syntax
client.list_allowed_multi_region_cluster_updates(
MultiRegionClusterName='string'
)
string
[REQUIRED]
The name of the multi-Region cluster.
dict
Response Syntax
{
'ScaleUpNodeTypes': [
'string',
],
'ScaleDownNodeTypes': [
'string',
]
}
Response Structure
(dict) --
ScaleUpNodeTypes (list) --
The node types that the cluster can be scaled up to.
(string) --
ScaleDownNodeTypes (list) --
The node types that the cluster can be scaled down to.
(string) --
Updates the configuration of an existing multi-Region cluster.
See also: AWS API Documentation
Request Syntax
client.update_multi_region_cluster(
MultiRegionClusterName='string',
NodeType='string',
Description='string',
EngineVersion='string',
ShardConfiguration={
'ShardCount': 123
},
MultiRegionParameterGroupName='string',
UpdateStrategy='coordinated'|'uncoordinated'
)
string
[REQUIRED]
The name of the multi-Region cluster to be updated.
string
The new node type to be used for the multi-Region cluster.
string
A new description for the multi-Region cluster.
string
The new engine version to be used for the multi-Region cluster.
dict
A request to configure the sharding properties of a cluster
ShardCount (integer) --
The number of shards in the cluster
string
The new multi-Region parameter group to be associated with the cluster.
string
Whether to force the update even if it may cause data loss.
dict
Response Syntax
{
'MultiRegionCluster': {
'MultiRegionClusterName': 'string',
'Description': 'string',
'Status': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumberOfShards': 123,
'Clusters': [
{
'ClusterName': 'string',
'Region': 'string',
'Status': 'string',
'ARN': 'string'
},
],
'MultiRegionParameterGroupName': 'string',
'TLSEnabled': True|False,
'ARN': 'string'
}
}
Response Structure
(dict) --
MultiRegionCluster (dict) --
The status of updating the multi-Region cluster.
MultiRegionClusterName (string) --
The name of the multi-Region cluster.
Description (string) --
The description of the multi-Region cluster.
Status (string) --
The current status of the multi-Region cluster.
NodeType (string) --
The node type used by the multi-Region cluster.
Engine (string) --
The name of the engine used by the multi-Region cluster.
EngineVersion (string) --
The version of the engine used by the multi-Region cluster.
NumberOfShards (integer) --
The number of shards in the multi-Region cluster.
Clusters (list) --
The clusters in this multi-Region cluster.
(dict) --
Represents a Regional cluster
ClusterName (string) --
The name of the Regional cluster
Region (string) --
The Region the current Regional cluster is assigned to.
Status (string) --
The status of the Regional cluster.
ARN (string) --
The Amazon Resource Name (ARN) the Regional cluster
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster.
TLSEnabled (boolean) --
Indiciates if the multi-Region cluster is TLS enabled.
ARN (string) --
The Amazon Resource Name (ARN) of the multi-Region cluster.
{'ProcessedClusters': {'MultiRegionClusterName': 'string'}}
Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
See also: AWS API Documentation
Request Syntax
client.batch_update_cluster(
ClusterNames=[
'string',
],
ServiceUpdate={
'ServiceUpdateNameToApply': 'string'
}
)
list
[REQUIRED]
The cluster names to apply the updates.
(string) --
dict
The unique ID of the service update
ServiceUpdateNameToApply (string) --
The unique ID of the service update
dict
Response Syntax
{
'ProcessedClusters': [
{
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
},
],
'UnprocessedClusters': [
{
'ClusterName': 'string',
'ErrorType': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ProcessedClusters (list) --
The list of clusters that have been updated.
(dict) --
Contains all of the attributes of a specific cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
UnprocessedClusters (list) --
The list of clusters where updates have not been applied.
(dict) --
A cluster whose updates have failed
ClusterName (string) --
The name of the cluster
ErrorType (string) --
The error type associated with the update failure
ErrorMessage (string) --
The error message associated with the update failure
{'Snapshot': {'ClusterConfiguration': {'MultiRegionClusterName': 'string',
'MultiRegionParameterGroupName': 'string'}}}
Makes a copy of an existing snapshot.
See also: AWS API Documentation
Request Syntax
client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of an existing snapshot from which to make a copy.
string
[REQUIRED]
A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.
string
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.
string
The ID of the KMS key used to encrypt the target snapshot.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
],
'MultiRegionParameterGroupName': 'string',
'MultiRegionClusterName': 'string'
},
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
Engine (string) --
The name of the engine used by the cluster configuration.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster configuration.
MultiRegionClusterName (string) --
The name for the multi-Region cluster associated with the cluster configuration.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'MultiRegionClusterName': 'string'}
Response {'Cluster': {'MultiRegionClusterName': 'string'}}
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
See also: AWS API Documentation
Request Syntax
client.create_cluster(
ClusterName='string',
NodeType='string',
MultiRegionClusterName='string',
ParameterGroupName='string',
Description='string',
NumShards=123,
NumReplicasPerShard=123,
SubnetGroupName='string',
SecurityGroupIds=[
'string',
],
MaintenanceWindow='string',
Port=123,
SnsTopicArn='string',
TLSEnabled=True|False,
KmsKeyId='string',
SnapshotArns=[
'string',
],
SnapshotName='string',
SnapshotRetentionLimit=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SnapshotWindow='string',
ACLName='string',
Engine='string',
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
DataTiering=True|False
)
string
[REQUIRED]
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
string
[REQUIRED]
The compute and memory capacity of the nodes in the cluster.
string
The name of the multi-Region cluster to be created.
string
The name of the parameter group associated with the cluster.
string
An optional description of the cluster.
integer
The number of shards the cluster will contain. The default value is 1.
integer
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
string
The name of the subnet group to be used for the cluster.
list
A list of security group names to associate with this cluster.
(string) --
string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
integer
The port number on which each of the nodes accepts connections.
string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
boolean
A flag to enable in-transit encryption on the cluster.
string
The ID of the KMS key used to encrypt the cluster.
list
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
(string) --
string
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
integer
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
list
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
string
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
string
[REQUIRED]
The name of the Access Control List to associate with the cluster.
string
The name of the engine to be used for the cluster.
string
The version number of the Redis OSS engine to be used for the cluster.
boolean
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
boolean
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The newly-created cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Snapshot': {'ClusterConfiguration': {'MultiRegionClusterName': 'string',
'MultiRegionParameterGroupName': 'string'}}}
Creates a copy of an entire cluster at a specific moment in time.
See also: AWS API Documentation
Request Syntax
client.create_snapshot(
ClusterName='string',
SnapshotName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The snapshot is created from this cluster.
string
[REQUIRED]
A name for the snapshot being created.
string
The ID of the KMS key used to encrypt the snapshot.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
],
'MultiRegionParameterGroupName': 'string',
'MultiRegionClusterName': 'string'
},
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Snapshot (dict) --
The newly-created snapshot.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
Engine (string) --
The name of the engine used by the cluster configuration.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster configuration.
MultiRegionClusterName (string) --
The name for the multi-Region cluster associated with the cluster configuration.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'MultiRegionClusterName': 'string'}
Response {'Cluster': {'MultiRegionClusterName': 'string'}}
Deletes a cluster. It also deletes all associated nodes and node endpoints.
See also: AWS API Documentation
Request Syntax
client.delete_cluster(
ClusterName='string',
MultiRegionClusterName='string',
FinalSnapshotName='string'
)
string
[REQUIRED]
The name of the cluster to be deleted
string
The name of the multi-Region cluster to be deleted.
string
The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The cluster object that has been deleted.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Snapshot': {'ClusterConfiguration': {'MultiRegionClusterName': 'string',
'MultiRegionParameterGroupName': 'string'}}}
Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
See also: AWS API Documentation
Request Syntax
client.delete_snapshot(
SnapshotName='string'
)
string
[REQUIRED]
The name of the snapshot to delete.
dict
Response Syntax
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
],
'MultiRegionParameterGroupName': 'string',
'MultiRegionClusterName': 'string'
},
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Snapshot (dict) --
The snapshot object that has been deleted.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
Engine (string) --
The name of the engine used by the cluster configuration.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster configuration.
MultiRegionClusterName (string) --
The name for the multi-Region cluster associated with the cluster configuration.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Clusters': {'MultiRegionClusterName': 'string'}}
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
See also: AWS API Documentation
Request Syntax
client.describe_clusters(
ClusterName='string',
MaxResults=123,
NextToken='string',
ShowShardDetails=True|False
)
string
The name of the cluster.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
string
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
boolean
An optional flag that can be included in the request to retrieve information about the individual shard(s).
dict
Response Syntax
{
'NextToken': 'string',
'Clusters': [
{
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Clusters (list) --
A list of clusters
(dict) --
Contains all of the attributes of a specific cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Snapshots': {'ClusterConfiguration': {'MultiRegionClusterName': 'string',
'MultiRegionParameterGroupName': 'string'}}}
Returns information about 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 cluster.
See also: AWS API Documentation
Request Syntax
client.describe_snapshots(
ClusterName='string',
SnapshotName='string',
Source='string',
NextToken='string',
MaxResults=123,
ShowDetail=True|False
)
string
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
string
A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.
string
If set to system, the output shows snapshots that were automatically created by MemoryDB. 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 argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
boolean
A Boolean value which if true, the shard configuration is included in the snapshot description.
dict
Response Syntax
{
'NextToken': 'string',
'Snapshots': [
{
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
],
'MultiRegionParameterGroupName': 'string',
'MultiRegionClusterName': 'string'
},
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Snapshots (list) --
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(dict) --
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
Engine (string) --
The name of the engine used by the cluster configuration.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
MultiRegionParameterGroupName (string) --
The name of the multi-Region parameter group associated with the cluster configuration.
MultiRegionClusterName (string) --
The name for the multi-Region cluster associated with the cluster configuration.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Cluster': {'MultiRegionClusterName': 'string'}}
Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.
See also: AWS API Documentation
Request Syntax
client.failover_shard(
ClusterName='string',
ShardName='string'
)
string
[REQUIRED]
The cluster being failed over.
string
[REQUIRED]
The name of the shard.
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The cluster being failed over.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
{'Cluster': {'MultiRegionClusterName': 'string'}}
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
See also: AWS API Documentation
Request Syntax
client.update_cluster(
ClusterName='string',
Description='string',
SecurityGroupIds=[
'string',
],
MaintenanceWindow='string',
SnsTopicArn='string',
SnsTopicStatus='string',
ParameterGroupName='string',
SnapshotWindow='string',
SnapshotRetentionLimit=123,
NodeType='string',
Engine='string',
EngineVersion='string',
ReplicaConfiguration={
'ReplicaCount': 123
},
ShardConfiguration={
'ShardCount': 123
},
ACLName='string'
)
string
[REQUIRED]
The name of the cluster to update.
string
The description of the cluster to update.
list
The SecurityGroupIds to update.
(string) --
string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
string
The SNS topic ARN to update.
string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
string
The name of the parameter group to update.
string
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
integer
The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
string
A valid node type that you want to scale this cluster up or down to.
string
The name of the engine to be used for the cluster.
string
The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
dict
The number of replicas that will reside in each shard.
ReplicaCount (integer) --
The number of replicas to scale up or down to
dict
The number of shards in the cluster.
ShardCount (integer) --
The number of shards in the cluster
string
The Access Control List that is associated with the cluster.
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'MultiRegionClusterName': 'string',
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The updated cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
MultiRegionClusterName (string) --
The name of the multi-Region cluster that this cluster belongs to.
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
Engine (string) --
The name of the engine used by the cluster.
EngineVersion (string) --
The Redis OSS engine version used by the cluster
EnginePatchVersion (string) --
The Redis OSS engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.