"EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string",
"MaintenanceWindow": "string", "Name": "string",
"NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string", "ParameterGroupStatus": "string", "PendingUpdates": {
"SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string",
"SubnetGroupName": "string", "TLSEnabled": boolean }
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
Cluster (p. 16)
The newly-created cluster.
Type: Cluster (p. 119) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ACLNotFoundFault
HTTP Status Code: 400 ClusterAlreadyExistsFault
HTTP Status Code: 400
ClusterQuotaForCustomerExceededFault
HTTP Status Code: 400 InsufficientClusterCapacityFault
HTTP Status Code: 400 InvalidACLStateFault
HTTP Status Code: 400 InvalidCredentialsException
HTTP Status Code: 400
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 InvalidVPCNetworkStateFault
HTTP Status Code: 400
NodeQuotaForClusterExceededFault
HTTP Status Code: 400
NodeQuotaForCustomerExceededFault HTTP Status Code: 400
ParameterGroupNotFoundFault
See Also
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400
ShardsPerClusterQuotaExceededFault
HTTP Status Code: 400 SubnetGroupNotFoundFault
HTTP Status Code: 400 TagQuotaPerResourceExceeded
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateParameterGroup
CreateParameterGroup
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
Request Syntax
{ "Description": "string", "Family": "string",
"ParameterGroupName": "string", "Tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
Description (p. 20)
An optional description of the parameter group.
Type: String Required: No Family (p. 20)
The name of the parameter group family that the parameter group can be used with.
Type: String Required: Yes
ParameterGroupName (p. 20)
The name of the parameter group.
Type: String Required: Yes Tags (p. 20)
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.
Type: Array of Tag (p. 152) objects
Array Members: Maximum number of 200 items.
Response Syntax
Required: No
Response Syntax
{ "ParameterGroup": { "ARN": "string",
"Description": "string", "Family": "string", "Name": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ParameterGroup (p. 21)
The newly-created parameter group.
Type: ParameterGroup (p. 133) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterGroupStateFault
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400
ParameterGroupAlreadyExistsFault
HTTP Status Code: 400
ParameterGroupQuotaExceededFault
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 TagQuotaPerResourceExceeded
See Also
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateSnapshot
CreateSnapshot
Creates a copy of an entire cluster at a specific moment in time.
Request Syntax
{ "ClusterName": "string", "KmsKeyId": "string", "SnapshotName": "string", "Tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ClusterName (p. 23)
The snapshot is created from this cluster.
Type: String Required: Yes KmsKeyId (p. 23)
The ID of the KMS key used to encrypt the snapshot.
Type: String Required: No SnapshotName (p. 23)
A name for the snapshot being created.
Type: String Required: Yes Tags (p. 23)
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.
Type: Array of Tag (p. 152) objects
Array Members: Maximum number of 200 items.
Required: No
Response Syntax
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Snapshot (p. 24)
The newly-created snapshot.
Type: Snapshot (p. 147) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ClusterNotFoundFault HTTP Status Code: 400 InvalidClusterStateFault
See Also
HTTP Status Code: 400
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 SnapshotAlreadyExistsFault
HTTP Status Code: 400 SnapshotQuotaExceededFault
HTTP Status Code: 400 TagQuotaPerResourceExceeded
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateSubnetGroup
CreateSubnetGroup
Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
Request Syntax
{
"Description": "string", "SubnetGroupName": "string", "SubnetIds": [ "string" ], "Tags": [
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
Description (p. 26)
A description for the subnet group.
Type: String Required: No
SubnetGroupName (p. 26)
The name of the subnet group.
Type: String Required: Yes SubnetIds (p. 26)
A list of VPC subnet IDs for the subnet group.
Type: Array of strings Required: Yes Tags (p. 26)
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.
Type: Array of Tag (p. 152) objects
Response Syntax
Array Members: Maximum number of 200 items.
Required: No
Response Syntax
{ "SubnetGroup": { "ARN": "string",
"Description": "string", "Name": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
SubnetGroup (p. 27)
The newly-created subnet group Type: SubnetGroup (p. 150) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
InvalidSubnet
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 SubnetGroupAlreadyExistsFault
HTTP Status Code: 400 SubnetGroupQuotaExceededFault
HTTP Status Code: 400 SubnetNotAllowedFault
See Also
HTTP Status Code: 400 SubnetQuotaExceededFault
HTTP Status Code: 400 TagQuotaPerResourceExceeded
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateUser
CreateUser
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
Request Syntax
{
"AccessString": "string", "AuthenticationMode": { "Passwords": [ "string" ],
"UserName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
AccessString (p. 29)
Access permissions string used for this user.
Type: String Pattern: .*\S.*
Required: Yes
AuthenticationMode (p. 29)
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Type: AuthenticationMode (p. 117) object Required: Yes
Tags (p. 29)
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.
Type: Array of Tag (p. 152) objects
Array Members: Maximum number of 200 items.
Required: No UserName (p. 29)
The name of the user. This value must be unique as it also serves as the user identifier.
Response Syntax
Type: String
Length Constraints: Minimum length of 1.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: Yes
Response Syntax
{ "User": {
"AccessString": "string", "ACLNames": [ "string" ], "ARN": "string",
"Authentication": { "PasswordCount": number, "Type": "string"
},
"MinimumEngineVersion": "string", "Name": "string",
"Status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
User (p. 30)
The newly-created user.
Type: User (p. 154) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
DuplicateUserNameFault
HTTP Status Code: 400
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 TagQuotaPerResourceExceeded
HTTP Status Code: 400
See Also
UserAlreadyExistsFault
HTTP Status Code: 400 UserQuotaExceededFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteACL
DeleteACL
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
Request Syntax
{ "ACLName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ACLName (p. 32)
The name of the Access Control List to delete Type: String
"MinimumEngineVersion": "string", "Name": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ACL (p. 32)
The Access Control List object that has been deleted.
Type: ACL (p. 112) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ACLNotFoundFault
HTTP Status Code: 400 InvalidACLStateFault
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteCluster
DeleteCluster
Deletes a cluster. It also deletes all associated nodes and node endpoints
Request Syntax
{
"ClusterName": "string", "FinalSnapshotName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ClusterName (p. 34)
The name of the cluster to be deleted Type: String
Required: Yes
FinalSnapshotName (p. 34)
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.
Type: String
"AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": {
"Address": "string", "Port": number },
"Description": "string",
"EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string",
"MaintenanceWindow": "string", "Name": "string",
"NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string",
Response Elements
"ParameterGroupStatus": "string", "PendingUpdates": {
"SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string",
"SubnetGroupName": "string", "TLSEnabled": boolean }
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Cluster (p. 34)
The cluster object that has been deleted Type: Cluster (p. 119) object
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ClusterNotFoundFault
HTTP Status Code: 400 InvalidClusterStateFault
HTTP Status Code: 400
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 SnapshotAlreadyExistsFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteParameterGroup
DeleteParameterGroup
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
Request Syntax
{ "ParameterGroupName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ParameterGroupName (p. 37)
The name of the parameter group to delete.
Type: String Required: Yes
Response Syntax
{
"ParameterGroup": { "ARN": "string",
"Description": "string", "Family": "string", "Name": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ParameterGroup (p. 37)
The parameter group that has been deleted.
Type: ParameterGroup (p. 133) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
See Also
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterGroupStateFault
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 ParameterGroupNotFoundFault
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSnapshot
DeleteSnapshot
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.
Request Syntax
{ "SnapshotName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
SnapshotName (p. 39)
The name of the snapshot to delete Type: String
Response Elements
"KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Snapshot (p. 39)
The snapshot object that has been deleted.
Type: Snapshot (p. 147) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
InvalidParameterCombinationException
HTTP Status Code: 400 InvalidParameterValueException
HTTP Status Code: 400 InvalidSnapshotStateFault
HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 SnapshotNotFoundFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSubnetGroup
DeleteSubnetGroup
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
Request Syntax
{ "SubnetGroupName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
SubnetGroupName (p. 42)
The name of the subnet group to delete Type: String
Required: Yes
Response Syntax
{ "SubnetGroup": { "ARN": "string",
"Description": "string", "Name": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
SubnetGroup (p. 42)
The subnet group object that has been deleted.
Errors
Type: SubnetGroup (p. 150) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ServiceLinkedRoleNotFoundFault
HTTP Status Code: 400 SubnetGroupInUseFault
HTTP Status Code: 400 SubnetGroupNotFoundFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteUser
DeleteUser
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
Request Syntax
{
"UserName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
UserName (p. 44)
The name of the user to delete Type: String
Length Constraints: Minimum length of 1.
Pattern: [a-zA-Z][a-zA-Z0-9\-]*
Required: Yes
Response Syntax
{ "User": {
"AccessString": "string", "ACLNames": [ "string" ],
"MinimumEngineVersion": "string", "Name": "string",
"Status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
User (p. 44)
The user object that has been deleted.
Errors
Type: User (p. 154) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
InvalidParameterValueException
HTTP Status Code: 400 InvalidUserStateFault
HTTP Status Code: 400 UserNotFoundFault
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeACLs
DescribeACLs
Returns a list of ACLs
Request Syntax
{
"ACLName": "string", "MaxResults": number, "NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ACLName (p. 46) The name of the ACL Type: String
Required: No MaxResults (p. 46)
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.
Type: Integer Required: No NextToken (p. 46)
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.
Type: String
"MinimumEngineVersion": "string", "Name": "string",
"PendingChanges": {
Response Elements
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ACLs (p. 46) The list of ACLs
Type: Array of ACL (p. 112) objects NextToken (p. 46)
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.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 158).
ACLNotFoundFault
HTTP Status Code: 400
InvalidParameterCombinationException
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
See Also
• AWS SDK for Ruby V3
DescribeClusters
DescribeClusters
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
Request Syntax
{
"ClusterName": "string", "MaxResults": number, "NextToken": "string", "ShowShardDetails": boolean }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 156).
The request accepts the following data in JSON format.
ClusterName (p. 49) The name of the cluster Type: String
Required: No MaxResults (p. 49)
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.
Type: Integer Required: No NextToken (p. 49)
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.
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.