The Amazon MemoryDB API contains several data types that various actions use. This section describes each data type in detail.
NoteThe order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• ACL (p. 112)
• ACLPendingChanges (p. 114)
• ACLsUpdateStatus (p. 115)
• Authentication (p. 116)
• AuthenticationMode (p. 117)
• AvailabilityZone (p. 118)
• Cluster (p. 119)
• ClusterConfiguration (p. 123)
• ClusterPendingUpdates (p. 125)
• Endpoint (p. 126)
• EngineVersionInfo (p. 127)
• Event (p. 128)
• Filter (p. 129)
• Node (p. 130)
• Parameter (p. 131)
• ParameterGroup (p. 133)
• ParameterNameValue (p. 134)
• PendingModifiedServiceUpdate (p. 135)
• ReplicaConfigurationRequest (p. 136)
• ReshardingStatus (p. 137)
• SecurityGroupMembership (p. 138)
• ServiceUpdate (p. 139)
• ServiceUpdateRequest (p. 141)
• Shard (p. 142)
• ShardConfiguration (p. 143)
• ShardConfigurationRequest (p. 144)
• ShardDetail (p. 145)
• SlotMigration (p. 146)
• Snapshot (p. 147)
• Subnet (p. 149)
• SubnetGroup (p. 150)
• Tag (p. 152)
• UnprocessedCluster (p. 153)
• User (p. 154)
ACL
ACL
An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
Contents
ARN
The Amazon Resource Name (ARN) of the ACL Type: String
Required: No Clusters
A list of clusters associated with the ACL.
Type: Array of strings Required: No
MinimumEngineVersion
The minimum engine version supported for the ACL Type: String
Required: No Name
The name of the Access Control List Type: String
Required: No PendingChanges
A list of updates being applied to the ACL.
Type: ACLPendingChanges (p. 114) object Required: No
Status
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
Type: String Required: No UserNames
The list of user names that belong to the ACL.
Type: Array of strings
Length Constraints: Minimum length of 1.
See Also
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ACLPendingChanges
ACLPendingChanges
Returns the updates being applied to the ACL.
Contents
UserNamesToAdd
A list of users being added to the ACL Type: Array of strings
Length Constraints: Minimum length of 1.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: No UserNamesToRemove
A list of user names being removed from the ACL Type: Array of strings
Length Constraints: Minimum length of 1.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ACLsUpdateStatus
ACLsUpdateStatus
The status of the ACL update
Contents
ACLToApply
A list of ACLs pending to be applied.
Type: String
Length Constraints: Minimum length of 1.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Authentication
Authentication
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Used in output responses.
Contents
PasswordCount
The number of passwords belonging to the user. The maximum is two.
Type: Integer Required: No Type
Indicates whether the user requires a password to authenticate.
Type: String
Valid Values: password | no-password Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AuthenticationMode
AuthenticationMode
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Used in output responses.
Contents
Passwords
The password(s) used for authentication Type: Array of strings
Array Members: Minimum number of 1 item.
Required: No Type
Indicates whether the user requires a password to authenticate. All newly-created users require a password.
Type: String
Valid Values: password Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AvailabilityZone
AvailabilityZone
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
Contents
Name
The name of the Availability Zone.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Cluster
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 (p. 126) object Required: No
Description
A description of the cluster Type: String
Required: No EnginePatchVersion
The Redis engine patch version used by the cluster
Contents
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
Contents
Required: No PendingUpdates
A group of settings that are currently being applied.
Type: ClusterPendingUpdates (p. 125) object Required: No
SecurityGroups
A list of security groups used by the cluster
Type: Array of SecurityGroupMembership (p. 138) objects Required: No
Shards
A list of shards that are members of the cluster.
Type: Array of Shard (p. 142) 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
See Also
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 AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3