Cluster
Contains all of the attributes of a specific cluster.
Contents
- ACLName
-
The name of the Access Control List associated with this cluster.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Required: No
- ARN
-
The Amazon Resource Name (ARN) of the cluster.
Type: String
Required: No
- AutoMinorVersionUpgrade
-
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Type: Boolean
Required: No
- AvailabilityMode
-
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
Type: String
Valid Values:
singleaz | multiaz
Required: No
- ClusterEndpoint
-
The cluster's configuration endpoint
Type: Endpoint object
Required: No
- Description
-
A description of the cluster
Type: String
Required: No
- EnginePatchVersion
-
The Redis engine patch version used by the cluster
Type: String
Required: No
- EngineVersion
-
The Redis engine version used by the cluster
Type: String
Required: No
- KmsKeyId
-
The ID of the KMS key used to encrypt the cluster
Type: String
Required: No
- MaintenanceWindow
-
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.
Type: String
Required: No
- Name
-
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Type: String
Required: No
- NodeType
-
The cluster's node type
Type: String
Required: No
- NumberOfShards
-
The number of shards in the cluster
Type: Integer
Required: No
- ParameterGroupName
-
The name of the parameter group used by the cluster
Type: String
Required: No
- ParameterGroupStatus
-
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
Type: String
Required: No
- PendingUpdates
-
A group of settings that are currently being applied.
Type: ClusterPendingUpdates object
Required: No
- SecurityGroups
-
A list of security groups used by the cluster
Type: Array of SecurityGroupMembership objects
Required: No
- Shards
-
A list of shards that are members of the cluster.
Type: Array of Shard objects
Required: No
- SnapshotRetentionLimit
-
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.
Type: Integer
Required: No
- SnapshotWindow
-
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.
Type: String
Required: No
- SnsTopicArn
-
The Amazon Resource Name (ARN) of the SNS notification topic
Type: String
Required: No
- SnsTopicStatus
-
The SNS topic must be in Active status to receive notifications
Type: String
Required: No
- Status
-
The status of the cluster. For example, Available, Updating, Creating.
Type: String
Required: No
- SubnetGroupName
-
The name of the subnet group used by the cluster
Type: String
Required: No
- TLSEnabled
-
A flag to indicate if In-transit encryption is enabled
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: