ClusterConfiguration
A list of cluster configuration options.
Contents
Description
The description of the cluster configuration Type: String
Required: No EngineVersion
The Redis engine version used by the cluster Type: String
Required: No MaintenanceWindow
The specified maintenance window for the cluster Type: String
Required: No Name
The name of the cluster Type: String
Required: No NodeType
The node type used for the cluster Type: String
Required: No NumShards
The number of shards in the cluster Type: Integer
Required: No ParameterGroupName
The name of parameter group used by the cluster Type: String
Required: No Port
The port used by the cluster
See Also
Type: Integer Required: No Shards
The list of shards in the cluster
Type: Array of ShardDetail (p. 145) objects Required: No
SnapshotRetentionLimit
The snapshot retention limit set by the cluster Type: Integer
Required: No SnapshotWindow
The snapshot window set by the cluster Type: String
Required: No SubnetGroupName
The name of the subnet group used by the cluster Type: String
Required: No TopicArn
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster Type: String
Required: No VpcId
The ID of the VPC the cluster belongs to 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
ClusterPendingUpdates
ClusterPendingUpdates
A list of updates being applied to the cluster
Contents
ACLs
A list of ACLs associated with the cluster that are being updated Type: ACLsUpdateStatus (p. 115) object
Required: No Resharding
The status of an online resharding operation.
Type: ReshardingStatus (p. 137) object Required: No
ServiceUpdates
A list of service updates being applied to the cluster
Type: Array of PendingModifiedServiceUpdate (p. 135) objects 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
Endpoint
Endpoint
Represents the information required for client programs to connect to the cluster and its nodes.
Contents
Address
The DNS hostname of the node.
Type: String Required: No Port
The port number that the engine is listening on.
Type: Integer 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
EngineVersionInfo
EngineVersionInfo
Provides details of the Redis engine version
Contents
EnginePatchVersion
The patched engine version Type: String
Required: No EngineVersion
The engine version Type: String Required: No ParameterGroupFamily
Specifies the name of the parameter group family to which the engine default parameters apply.
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
Event
Event
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
Contents
Date
The date and time when the event occurred.
Type: Timestamp Required: No Message
The text of the event.
Type: String Required: No SourceName
The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
Type: String Required: No SourceType
Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
Type: String
Valid Values: node | parameter-group | subnet-group | cluster | user | acl 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
Filter
Filter
Used to streamline results of a search based on the property being filtered.
Contents
Name
The property being filtered. For example, UserName.
Type: String Pattern: .*\S.*
Required: Yes Values
The property values to filter on. For example, "user-123".
Type: Array of strings
Array Members: Minimum number of 1 item.
Pattern: .*\S.*
Required: Yes
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
Node
Node
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Contents
AvailabilityZone
The Availability Zone in which the node resides Type: String
Required: No CreateTime
The date and time when the node was created.
Type: Timestamp Required: No Endpoint
The hostname for connecting to this node.
Type: Endpoint (p. 126) object Required: No
Name
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.
Type: String Required: No Status
The status of the service update on the node 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
Parameter
Parameter
Describes an individual setting that controls some aspect of MemoryDB behavior.
Contents
AllowedValues
The valid range of values for the parameter.
Type: String Required: No DataType
The parameter's data type Type: String
Required: No Description
A description of the parameter Type: String
Required: No MinimumEngineVersion
The earliest engine version to which the parameter can apply.
Type: String Required: No Name
The name of the parameter Type: String
Required: No Value
The value of the parameter 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
See Also
• AWS SDK for Ruby V3
ParameterGroup
ParameterGroup
Represents the output of a CreateParameterGroup operation. A parameter group represents a
combination of specific values for the parameters that are passed to the engine software during startup.
Contents
ARN
The Amazon Resource Name (ARN) of the parameter group Type: String
Required: No Description
A description of the parameter group Type: String
Required: No Family
The name of the parameter group family that this parameter group is compatible with.
Type: String Required: No Name
The name of the parameter group 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
ParameterNameValue
ParameterNameValue
Describes a name-value pair that is used to update the value of a parameter.
Contents
ParameterName
The name of the parameter Type: String
Required: No ParameterValue
The value of the parameter 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