BatchUpdateCluster

$result = $client->batchUpdateCluster([/* ... */]);
$promise = $client->batchUpdateClusterAsync([/* ... */]);

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Parameter Syntax

$result = $client->batchUpdateCluster([
    'ClusterNames' => ['<string>', ...], // REQUIRED
    'ServiceUpdate' => [
        'ServiceUpdateNameToApply' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'ProcessedClusters' => [
        [
            'ACLName' => '<string>',
            'ARN' => '<string>',
            'AutoMinorVersionUpgrade' => true || false,
            'AvailabilityMode' => 'singleaz|multiaz',
            'ClusterEndpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
            ],
            'DataTiering' => 'true|false',
            'Description' => '<string>',
            'Engine' => '<string>',
            'EnginePatchVersion' => '<string>',
            'EngineVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'MaintenanceWindow' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'Name' => '<string>',
            'NodeType' => '<string>',
            'NumberOfShards' => <integer>,
            'ParameterGroupName' => '<string>',
            'ParameterGroupStatus' => '<string>',
            'PendingUpdates' => [
                'ACLs' => [
                    'ACLToApply' => '<string>',
                ],
                'Resharding' => [
                    'SlotMigration' => [
                        'ProgressPercentage' => <float>,
                    ],
                ],
                'ServiceUpdates' => [
                    [
                        'ServiceUpdateName' => '<string>',
                        'Status' => 'available|in-progress|complete|scheduled',
                    ],
                    // ...
                ],
            ],
            'SecurityGroups' => [
                [
                    'SecurityGroupId' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'Shards' => [
                [
                    'Name' => '<string>',
                    'Nodes' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'CreateTime' => <DateTime>,
                            'Endpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                            'Name' => '<string>',
                            'Status' => '<string>',
                        ],
                        // ...
                    ],
                    'NumberOfNodes' => <integer>,
                    'Slots' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SnsTopicArn' => '<string>',
            'SnsTopicStatus' => '<string>',
            'Status' => '<string>',
            'SubnetGroupName' => '<string>',
            'TLSEnabled' => true || false,
        ],
        // ...
    ],
    'UnprocessedClusters' => [
        [
            'ClusterName' => '<string>',
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceUpdateNotFoundFault:

InvalidParameterValueException:

CopySnapshot

$result = $client->copySnapshot([/* ... */]);
$promise = $client->copySnapshotAsync([/* ... */]);

Makes a copy of an existing snapshot.

Parameter Syntax

$result = $client->copySnapshot([
    'KmsKeyId' => '<string>',
    'SourceSnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetBucket' => '<string>',
    'TargetSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'ClusterConfiguration' => [
            'Description' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'MaintenanceWindow' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'MultiRegionParameterGroupName' => '<string>',
            'Name' => '<string>',
            'NodeType' => '<string>',
            'NumShards' => <integer>,
            'ParameterGroupName' => '<string>',
            'Port' => <integer>,
            'Shards' => [
                [
                    'Configuration' => [
                        'ReplicaCount' => <integer>,
                        'Slots' => '<string>',
                    ],
                    'Name' => '<string>',
                    'Size' => '<string>',
                    'SnapshotCreationTime' => <DateTime>,
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SubnetGroupName' => '<string>',
            'TopicArn' => '<string>',
            'VpcId' => '<string>',
        ],
        'DataTiering' => 'true|false',
        'KmsKeyId' => '<string>',
        'Name' => '<string>',
        'Source' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

SnapshotAlreadyExistsFault:

SnapshotNotFoundFault:

SnapshotQuotaExceededFault:

InvalidSnapshotStateFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

TagQuotaPerResourceExceeded:

CreateACL

$result = $client->createACL([/* ... */]);
$promise = $client->createACLAsync([/* ... */]);

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

Parameter Syntax

$result = $client->createACL([
    'ACLName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ACL' => [
        'ARN' => '<string>',
        'Clusters' => ['<string>', ...],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'PendingChanges' => [
            'UserNamesToAdd' => ['<string>', ...],
            'UserNamesToRemove' => ['<string>', ...],
        ],
        'Status' => '<string>',
        'UserNames' => ['<string>', ...],
    ],
]

Result Details

Errors

UserNotFoundFault:

DuplicateUserNameFault:

ACLAlreadyExistsFault:

DefaultUserRequired:

ACLQuotaExceededFault:

InvalidParameterValueException:

TagQuotaPerResourceExceeded:

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Parameter Syntax

$result = $client->createCluster([
    'ACLName' => '<string>', // REQUIRED
    'AutoMinorVersionUpgrade' => true || false,
    'ClusterName' => '<string>', // REQUIRED
    'DataTiering' => true || false,
    'Description' => '<string>',
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'MaintenanceWindow' => '<string>',
    'MultiRegionClusterName' => '<string>',
    'NodeType' => '<string>', // REQUIRED
    'NumReplicasPerShard' => <integer>,
    'NumShards' => <integer>,
    'ParameterGroupName' => '<string>',
    'Port' => <integer>,
    'SecurityGroupIds' => ['<string>', ...],
    'SnapshotArns' => ['<string>', ...],
    'SnapshotName' => '<string>',
    'SnapshotRetentionLimit' => <integer>,
    'SnapshotWindow' => '<string>',
    'SnsTopicArn' => '<string>',
    'SubnetGroupName' => '<string>',
    'TLSEnabled' => true || false,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ACLName' => '<string>',
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityMode' => 'singleaz|multiaz',
        'ClusterEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'true|false',
        'Description' => '<string>',
        'Engine' => '<string>',
        'EnginePatchVersion' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceWindow' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'Name' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'ParameterGroupName' => '<string>',
        'ParameterGroupStatus' => '<string>',
        'PendingUpdates' => [
            'ACLs' => [
                'ACLToApply' => '<string>',
            ],
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'ServiceUpdates' => [
                [
                    'ServiceUpdateName' => '<string>',
                    'Status' => 'available|in-progress|complete|scheduled',
                ],
                // ...
            ],
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Shards' => [
            [
                'Name' => '<string>',
                'Nodes' => [
                    [
                        'AvailabilityZone' => '<string>',
                        'CreateTime' => <DateTime>,
                        'Endpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                        'Name' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'NumberOfNodes' => <integer>,
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnsTopicArn' => '<string>',
        'SnsTopicStatus' => '<string>',
        'Status' => '<string>',
        'SubnetGroupName' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

ClusterAlreadyExistsFault:

SubnetGroupNotFoundFault:

ClusterQuotaForCustomerExceededFault:

NodeQuotaForClusterExceededFault:

NodeQuotaForCustomerExceededFault:

ParameterGroupNotFoundFault:

InsufficientClusterCapacityFault:

InvalidVPCNetworkStateFault:

ServiceLinkedRoleNotFoundFault:

ShardsPerClusterQuotaExceededFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

InvalidCredentialsException:

TagQuotaPerResourceExceeded:

ACLNotFoundFault:

InvalidACLStateFault:

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

InvalidMultiRegionClusterStateFault:

The requested operation cannot be performed on the multi-Region cluster in its current state.

CreateMultiRegionCluster

$result = $client->createMultiRegionCluster([/* ... */]);
$promise = $client->createMultiRegionClusterAsync([/* ... */]);

Creates a new multi-Region cluster.

Parameter Syntax

$result = $client->createMultiRegionCluster([
    'Description' => '<string>',
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'MultiRegionClusterNameSuffix' => '<string>', // REQUIRED
    'MultiRegionParameterGroupName' => '<string>',
    'NodeType' => '<string>', // REQUIRED
    'NumShards' => <integer>,
    'TLSEnabled' => true || false,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'MultiRegionCluster' => [
        'ARN' => '<string>',
        'Clusters' => [
            [
                'ARN' => '<string>',
                'ClusterName' => '<string>',
                'Region' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'MultiRegionParameterGroupName' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'Status' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

MultiRegionClusterAlreadyExistsFault:

A multi-Region cluster with the specified name already exists.

InvalidParameterCombinationException:

InvalidParameterValueException:

MultiRegionParameterGroupNotFoundFault:

The specified multi-Region parameter group does not exist.

ClusterQuotaForCustomerExceededFault:

TagQuotaPerResourceExceeded:

CreateParameterGroup

$result = $client->createParameterGroup([/* ... */]);
$promise = $client->createParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createParameterGroup([
    'Description' => '<string>',
    'Family' => '<string>', // REQUIRED
    'ParameterGroupName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ParameterGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Family' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

ParameterGroupQuotaExceededFault:

ParameterGroupAlreadyExistsFault:

InvalidParameterGroupStateFault:

ServiceLinkedRoleNotFoundFault:

TagQuotaPerResourceExceeded:

InvalidParameterValueException:

InvalidParameterCombinationException:

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Creates a copy of an entire cluster at a specific moment in time.

Parameter Syntax

$result = $client->createSnapshot([
    'ClusterName' => '<string>', // REQUIRED
    'KmsKeyId' => '<string>',
    'SnapshotName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'ClusterConfiguration' => [
            'Description' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'MaintenanceWindow' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'MultiRegionParameterGroupName' => '<string>',
            'Name' => '<string>',
            'NodeType' => '<string>',
            'NumShards' => <integer>,
            'ParameterGroupName' => '<string>',
            'Port' => <integer>,
            'Shards' => [
                [
                    'Configuration' => [
                        'ReplicaCount' => <integer>,
                        'Slots' => '<string>',
                    ],
                    'Name' => '<string>',
                    'Size' => '<string>',
                    'SnapshotCreationTime' => <DateTime>,
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SubnetGroupName' => '<string>',
            'TopicArn' => '<string>',
            'VpcId' => '<string>',
        ],
        'DataTiering' => 'true|false',
        'KmsKeyId' => '<string>',
        'Name' => '<string>',
        'Source' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

SnapshotAlreadyExistsFault:

ClusterNotFoundFault:

InvalidClusterStateFault:

SnapshotQuotaExceededFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterCombinationException:

InvalidParameterValueException:

TagQuotaPerResourceExceeded:

CreateSubnetGroup

$result = $client->createSubnetGroup([/* ... */]);
$promise = $client->createSubnetGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSubnetGroup([
    'Description' => '<string>',
    'SubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'SubnetGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Subnets' => [
            [
                'AvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'Identifier' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SubnetGroupAlreadyExistsFault:

SubnetGroupQuotaExceededFault:

SubnetQuotaExceededFault:

InvalidSubnet:

ServiceLinkedRoleNotFoundFault:

SubnetNotAllowedFault:

TagQuotaPerResourceExceeded:

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Parameter Syntax

$result = $client->createUser([
    'AccessString' => '<string>', // REQUIRED
    'AuthenticationMode' => [ // REQUIRED
        'Passwords' => ['<string>', ...],
        'Type' => 'password|iam',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'ACLNames' => ['<string>', ...],
        'ARN' => '<string>',
        'AccessString' => '<string>',
        'Authentication' => [
            'PasswordCount' => <integer>,
            'Type' => 'password|no-password|iam',
        ],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

UserAlreadyExistsFault:

UserQuotaExceededFault:

DuplicateUserNameFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

TagQuotaPerResourceExceeded:

DeleteACL

$result = $client->deleteACL([/* ... */]);
$promise = $client->deleteACLAsync([/* ... */]);

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).

Parameter Syntax

$result = $client->deleteACL([
    'ACLName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ACL' => [
        'ARN' => '<string>',
        'Clusters' => ['<string>', ...],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'PendingChanges' => [
            'UserNamesToAdd' => ['<string>', ...],
            'UserNamesToRemove' => ['<string>', ...],
        ],
        'Status' => '<string>',
        'UserNames' => ['<string>', ...],
    ],
]

Result Details

Errors

ACLNotFoundFault:

InvalidACLStateFault:

InvalidParameterValueException:

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes a cluster. It also deletes all associated nodes and node endpoints.

Parameter Syntax

$result = $client->deleteCluster([
    'ClusterName' => '<string>', // REQUIRED
    'FinalSnapshotName' => '<string>',
    'MultiRegionClusterName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ACLName' => '<string>',
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityMode' => 'singleaz|multiaz',
        'ClusterEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'true|false',
        'Description' => '<string>',
        'Engine' => '<string>',
        'EnginePatchVersion' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceWindow' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'Name' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'ParameterGroupName' => '<string>',
        'ParameterGroupStatus' => '<string>',
        'PendingUpdates' => [
            'ACLs' => [
                'ACLToApply' => '<string>',
            ],
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'ServiceUpdates' => [
                [
                    'ServiceUpdateName' => '<string>',
                    'Status' => 'available|in-progress|complete|scheduled',
                ],
                // ...
            ],
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Shards' => [
            [
                'Name' => '<string>',
                'Nodes' => [
                    [
                        'AvailabilityZone' => '<string>',
                        'CreateTime' => <DateTime>,
                        'Endpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                        'Name' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'NumberOfNodes' => <integer>,
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnsTopicArn' => '<string>',
        'SnsTopicStatus' => '<string>',
        'Status' => '<string>',
        'SubnetGroupName' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

ClusterNotFoundFault:

InvalidClusterStateFault:

SnapshotAlreadyExistsFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DeleteMultiRegionCluster

$result = $client->deleteMultiRegionCluster([/* ... */]);
$promise = $client->deleteMultiRegionClusterAsync([/* ... */]);

Deletes an existing multi-Region cluster.

Parameter Syntax

$result = $client->deleteMultiRegionCluster([
    'MultiRegionClusterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MultiRegionCluster' => [
        'ARN' => '<string>',
        'Clusters' => [
            [
                'ARN' => '<string>',
                'ClusterName' => '<string>',
                'Region' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'MultiRegionParameterGroupName' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'Status' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

InvalidMultiRegionClusterStateFault:

The requested operation cannot be performed on the multi-Region cluster in its current state.

InvalidParameterValueException:

DeleteParameterGroup

$result = $client->deleteParameterGroup([/* ... */]);
$promise = $client->deleteParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ParameterGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Family' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterGroupStateFault:

ParameterGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DeleteSnapshot

$result = $client->deleteSnapshot([/* ... */]);
$promise = $client->deleteSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSnapshot([
    'SnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Snapshot' => [
        'ARN' => '<string>',
        'ClusterConfiguration' => [
            'Description' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'MaintenanceWindow' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'MultiRegionParameterGroupName' => '<string>',
            'Name' => '<string>',
            'NodeType' => '<string>',
            'NumShards' => <integer>,
            'ParameterGroupName' => '<string>',
            'Port' => <integer>,
            'Shards' => [
                [
                    'Configuration' => [
                        'ReplicaCount' => <integer>,
                        'Slots' => '<string>',
                    ],
                    'Name' => '<string>',
                    'Size' => '<string>',
                    'SnapshotCreationTime' => <DateTime>,
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SubnetGroupName' => '<string>',
            'TopicArn' => '<string>',
            'VpcId' => '<string>',
        ],
        'DataTiering' => 'true|false',
        'KmsKeyId' => '<string>',
        'Name' => '<string>',
        'Source' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

SnapshotNotFoundFault:

InvalidSnapshotStateFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DeleteSubnetGroup

$result = $client->deleteSubnetGroup([/* ... */]);
$promise = $client->deleteSubnetGroupAsync([/* ... */]);

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

Parameter Syntax

$result = $client->deleteSubnetGroup([
    'SubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SubnetGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Subnets' => [
            [
                'AvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'Identifier' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SubnetGroupInUseFault:

SubnetGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Parameter Syntax

$result = $client->deleteUser([
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'ACLNames' => ['<string>', ...],
        'ARN' => '<string>',
        'AccessString' => '<string>',
        'Authentication' => [
            'PasswordCount' => <integer>,
            'Type' => 'password|no-password|iam',
        ],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

InvalidUserStateFault:

UserNotFoundFault:

InvalidParameterValueException:

DescribeACLs

$result = $client->describeACLs([/* ... */]);
$promise = $client->describeACLsAsync([/* ... */]);

Returns a list of ACLs.

Parameter Syntax

$result = $client->describeACLs([
    'ACLName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ACLs' => [
        [
            'ARN' => '<string>',
            'Clusters' => ['<string>', ...],
            'MinimumEngineVersion' => '<string>',
            'Name' => '<string>',
            'PendingChanges' => [
                'UserNamesToAdd' => ['<string>', ...],
                'UserNamesToRemove' => ['<string>', ...],
            ],
            'Status' => '<string>',
            'UserNames' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ACLNotFoundFault:

InvalidParameterCombinationException:

DescribeClusters

$result = $client->describeClusters([/* ... */]);
$promise = $client->describeClustersAsync([/* ... */]);

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

Parameter Syntax

$result = $client->describeClusters([
    'ClusterName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ShowShardDetails' => true || false,
]);

Parameter Details

Result Syntax

[
    'Clusters' => [
        [
            'ACLName' => '<string>',
            'ARN' => '<string>',
            'AutoMinorVersionUpgrade' => true || false,
            'AvailabilityMode' => 'singleaz|multiaz',
            'ClusterEndpoint' => [
                'Address' => '<string>',
                'Port' => <integer>,
            ],
            'DataTiering' => 'true|false',
            'Description' => '<string>',
            'Engine' => '<string>',
            'EnginePatchVersion' => '<string>',
            'EngineVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'MaintenanceWindow' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'Name' => '<string>',
            'NodeType' => '<string>',
            'NumberOfShards' => <integer>,
            'ParameterGroupName' => '<string>',
            'ParameterGroupStatus' => '<string>',
            'PendingUpdates' => [
                'ACLs' => [
                    'ACLToApply' => '<string>',
                ],
                'Resharding' => [
                    'SlotMigration' => [
                        'ProgressPercentage' => <float>,
                    ],
                ],
                'ServiceUpdates' => [
                    [
                        'ServiceUpdateName' => '<string>',
                        'Status' => 'available|in-progress|complete|scheduled',
                    ],
                    // ...
                ],
            ],
            'SecurityGroups' => [
                [
                    'SecurityGroupId' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'Shards' => [
                [
                    'Name' => '<string>',
                    'Nodes' => [
                        [
                            'AvailabilityZone' => '<string>',
                            'CreateTime' => <DateTime>,
                            'Endpoint' => [
                                'Address' => '<string>',
                                'Port' => <integer>,
                            ],
                            'Name' => '<string>',
                            'Status' => '<string>',
                        ],
                        // ...
                    ],
                    'NumberOfNodes' => <integer>,
                    'Slots' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'SnapshotRetentionLimit' => <integer>,
            'SnapshotWindow' => '<string>',
            'SnsTopicArn' => '<string>',
            'SnsTopicStatus' => '<string>',
            'Status' => '<string>',
            'SubnetGroupName' => '<string>',
            'TLSEnabled' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ClusterNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeEngineVersions

$result = $client->describeEngineVersions([/* ... */]);
$promise = $client->describeEngineVersionsAsync([/* ... */]);

Returns a list of the available Redis OSS engine versions.

Parameter Syntax

$result = $client->describeEngineVersions([
    'DefaultOnly' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterGroupFamily' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EngineVersions' => [
        [
            'Engine' => '<string>',
            'EnginePatchVersion' => '<string>',
            'EngineVersion' => '<string>',
            'ParameterGroupFamily' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SourceName' => '<string>',
    'SourceType' => 'node|parameter-group|subnet-group|cluster|user|acl',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'Message' => '<string>',
            'SourceName' => '<string>',
            'SourceType' => 'node|parameter-group|subnet-group|cluster|user|acl',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeMultiRegionClusters

$result = $client->describeMultiRegionClusters([/* ... */]);
$promise = $client->describeMultiRegionClustersAsync([/* ... */]);

Returns details about one or more multi-Region clusters.

Parameter Syntax

$result = $client->describeMultiRegionClusters([
    'MaxResults' => <integer>,
    'MultiRegionClusterName' => '<string>',
    'NextToken' => '<string>',
    'ShowClusterDetails' => true || false,
]);

Parameter Details

Result Syntax

[
    'MultiRegionClusters' => [
        [
            'ARN' => '<string>',
            'Clusters' => [
                [
                    'ARN' => '<string>',
                    'ClusterName' => '<string>',
                    'Region' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'Description' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'MultiRegionClusterName' => '<string>',
            'MultiRegionParameterGroupName' => '<string>',
            'NodeType' => '<string>',
            'NumberOfShards' => <integer>,
            'Status' => '<string>',
            'TLSEnabled' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ClusterNotFoundFault:

InvalidParameterCombinationException:

InvalidParameterValueException:

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

DescribeParameterGroups

$result = $client->describeParameterGroups([/* ... */]);
$promise = $client->describeParameterGroupsAsync([/* ... */]);

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

Parameter Syntax

$result = $client->describeParameterGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterGroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ParameterGroups' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Family' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ParameterGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeParameters

$result = $client->describeParameters([/* ... */]);
$promise = $client->describeParametersAsync([/* ... */]);

Returns the detailed parameter list for a particular parameter group.

Parameter Syntax

$result = $client->describeParameters([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'MinimumEngineVersion' => '<string>',
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ParameterGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeReservedNodes

$result = $client->describeReservedNodes([/* ... */]);
$promise = $client->describeReservedNodesAsync([/* ... */]);

Returns information about reserved nodes for this account, or about a specified reserved node.

Parameter Syntax

$result = $client->describeReservedNodes([
    'Duration' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'NodeType' => '<string>',
    'OfferingType' => '<string>',
    'ReservationId' => '<string>',
    'ReservedNodesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedNodes' => [
        [
            'ARN' => '<string>',
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'NodeCount' => <integer>,
            'NodeType' => '<string>',
            'OfferingType' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservationId' => '<string>',
            'ReservedNodesOfferingId' => '<string>',
            'StartTime' => <DateTime>,
            'State' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ReservedNodeNotFoundFault:

The requested node does not exist.

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeReservedNodesOfferings

$result = $client->describeReservedNodesOfferings([/* ... */]);
$promise = $client->describeReservedNodesOfferingsAsync([/* ... */]);

Lists available reserved node offerings.

Parameter Syntax

$result = $client->describeReservedNodesOfferings([
    'Duration' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'NodeType' => '<string>',
    'OfferingType' => '<string>',
    'ReservedNodesOfferingId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedNodesOfferings' => [
        [
            'Duration' => <integer>,
            'FixedPrice' => <float>,
            'NodeType' => '<string>',
            'OfferingType' => '<string>',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedNodesOfferingId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ReservedNodesOfferingNotFoundFault:

The requested node offering does not exist.

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeServiceUpdates

$result = $client->describeServiceUpdates([/* ... */]);
$promise = $client->describeServiceUpdatesAsync([/* ... */]);

Returns details of the service updates.

Parameter Syntax

$result = $client->describeServiceUpdates([
    'ClusterNames' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServiceUpdateName' => '<string>',
    'Status' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ServiceUpdates' => [
        [
            'AutoUpdateStartDate' => <DateTime>,
            'ClusterName' => '<string>',
            'Description' => '<string>',
            'Engine' => '<string>',
            'NodesUpdated' => '<string>',
            'ReleaseDate' => <DateTime>,
            'ServiceUpdateName' => '<string>',
            'Status' => 'available|in-progress|complete|scheduled',
            'Type' => 'security-update',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeSnapshots

$result = $client->describeSnapshots([/* ... */]);
$promise = $client->describeSnapshotsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeSnapshots([
    'ClusterName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ShowDetail' => true || false,
    'SnapshotName' => '<string>',
    'Source' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Snapshots' => [
        [
            'ARN' => '<string>',
            'ClusterConfiguration' => [
                'Description' => '<string>',
                'Engine' => '<string>',
                'EngineVersion' => '<string>',
                'MaintenanceWindow' => '<string>',
                'MultiRegionClusterName' => '<string>',
                'MultiRegionParameterGroupName' => '<string>',
                'Name' => '<string>',
                'NodeType' => '<string>',
                'NumShards' => <integer>,
                'ParameterGroupName' => '<string>',
                'Port' => <integer>,
                'Shards' => [
                    [
                        'Configuration' => [
                            'ReplicaCount' => <integer>,
                            'Slots' => '<string>',
                        ],
                        'Name' => '<string>',
                        'Size' => '<string>',
                        'SnapshotCreationTime' => <DateTime>,
                    ],
                    // ...
                ],
                'SnapshotRetentionLimit' => <integer>,
                'SnapshotWindow' => '<string>',
                'SubnetGroupName' => '<string>',
                'TopicArn' => '<string>',
                'VpcId' => '<string>',
            ],
            'DataTiering' => 'true|false',
            'KmsKeyId' => '<string>',
            'Name' => '<string>',
            'Source' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

SnapshotNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

DescribeSubnetGroups

$result = $client->describeSubnetGroups([/* ... */]);
$promise = $client->describeSubnetGroupsAsync([/* ... */]);

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

Parameter Syntax

$result = $client->describeSubnetGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SubnetGroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SubnetGroups' => [
        [
            'ARN' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'Subnets' => [
                [
                    'AvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'Identifier' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

SubnetGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

DescribeUsers

$result = $client->describeUsers([/* ... */]);
$promise = $client->describeUsersAsync([/* ... */]);

Returns a list of users.

Parameter Syntax

$result = $client->describeUsers([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'ACLNames' => ['<string>', ...],
            'ARN' => '<string>',
            'AccessString' => '<string>',
            'Authentication' => [
                'PasswordCount' => <integer>,
                'Type' => 'password|no-password|iam',
            ],
            'MinimumEngineVersion' => '<string>',
            'Name' => '<string>',
            'Status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UserNotFoundFault:

InvalidParameterCombinationException:

FailoverShard

$result = $client->failoverShard([/* ... */]);
$promise = $client->failoverShardAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->failoverShard([
    'ClusterName' => '<string>', // REQUIRED
    'ShardName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ACLName' => '<string>',
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityMode' => 'singleaz|multiaz',
        'ClusterEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'true|false',
        'Description' => '<string>',
        'Engine' => '<string>',
        'EnginePatchVersion' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceWindow' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'Name' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'ParameterGroupName' => '<string>',
        'ParameterGroupStatus' => '<string>',
        'PendingUpdates' => [
            'ACLs' => [
                'ACLToApply' => '<string>',
            ],
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'ServiceUpdates' => [
                [
                    'ServiceUpdateName' => '<string>',
                    'Status' => 'available|in-progress|complete|scheduled',
                ],
                // ...
            ],
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Shards' => [
            [
                'Name' => '<string>',
                'Nodes' => [
                    [
                        'AvailabilityZone' => '<string>',
                        'CreateTime' => <DateTime>,
                        'Endpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                        'Name' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'NumberOfNodes' => <integer>,
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnsTopicArn' => '<string>',
        'SnsTopicStatus' => '<string>',
        'Status' => '<string>',
        'SubnetGroupName' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

APICallRateForCustomerExceededFault:

InvalidClusterStateFault:

ShardNotFoundFault:

ClusterNotFoundFault:

TestFailoverNotAvailableFault:

InvalidKMSKeyFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

ListAllowedMultiRegionClusterUpdates

$result = $client->listAllowedMultiRegionClusterUpdates([/* ... */]);
$promise = $client->listAllowedMultiRegionClusterUpdatesAsync([/* ... */]);

Lists the allowed updates for a multi-Region cluster.

Parameter Syntax

$result = $client->listAllowedMultiRegionClusterUpdates([
    'MultiRegionClusterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ScaleDownNodeTypes' => ['<string>', ...],
    'ScaleUpNodeTypes' => ['<string>', ...],
]

Result Details

Errors

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

InvalidParameterCombinationException:

InvalidParameterValueException:

ListAllowedNodeTypeUpdates

$result = $client->listAllowedNodeTypeUpdates([/* ... */]);
$promise = $client->listAllowedNodeTypeUpdatesAsync([/* ... */]);

Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.

Parameter Syntax

$result = $client->listAllowedNodeTypeUpdates([
    'ClusterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ScaleDownNodeTypes' => ['<string>', ...],
    'ScaleUpNodeTypes' => ['<string>', ...],
]

Result Details

Errors

ClusterNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterCombinationException:

InvalidParameterValueException:

ListTags

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources.

Parameter Syntax

$result = $client->listTags([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ClusterNotFoundFault:

InvalidClusterStateFault:

ParameterGroupNotFoundFault:

SubnetGroupNotFoundFault:

SnapshotNotFoundFault:

InvalidARNFault:

ServiceLinkedRoleNotFoundFault:

UserNotFoundFault:

ACLNotFoundFault:

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

MultiRegionParameterGroupNotFoundFault:

The specified multi-Region parameter group does not exist.

PurchaseReservedNodesOffering

$result = $client->purchaseReservedNodesOffering([/* ... */]);
$promise = $client->purchaseReservedNodesOfferingAsync([/* ... */]);

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

Parameter Syntax

$result = $client->purchaseReservedNodesOffering([
    'NodeCount' => <integer>,
    'ReservationId' => '<string>',
    'ReservedNodesOfferingId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ReservedNode' => [
        'ARN' => '<string>',
        'Duration' => <integer>,
        'FixedPrice' => <float>,
        'NodeCount' => <integer>,
        'NodeType' => '<string>',
        'OfferingType' => '<string>',
        'RecurringCharges' => [
            [
                'RecurringChargeAmount' => <float>,
                'RecurringChargeFrequency' => '<string>',
            ],
            // ...
        ],
        'ReservationId' => '<string>',
        'ReservedNodesOfferingId' => '<string>',
        'StartTime' => <DateTime>,
        'State' => '<string>',
    ],
]

Result Details

Errors

ReservedNodesOfferingNotFoundFault:

The requested node offering does not exist.

ReservedNodeAlreadyExistsFault:

You already have a reservation with the given identifier.

ReservedNodeQuotaExceededFault:

The request cannot be processed because it would exceed the user's node quota.

ServiceLinkedRoleNotFoundFault:

TagQuotaPerResourceExceeded:

InvalidParameterValueException:

InvalidParameterCombinationException:

ResetParameterGroup

$result = $client->resetParameterGroup([/* ... */]);
$promise = $client->resetParameterGroupAsync([/* ... */]);

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

Parameter Syntax

$result = $client->resetParameterGroup([
    'AllParameters' => true || false,
    'ParameterGroupName' => '<string>', // REQUIRED
    'ParameterNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ParameterGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Family' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterGroupStateFault:

ParameterGroupNotFoundFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

A tag is a key-value pair where the key and value are case-sensitive. 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. For more information, see Resource-level permissions.

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ClusterNotFoundFault:

ParameterGroupNotFoundFault:

SubnetGroupNotFoundFault:

InvalidClusterStateFault:

SnapshotNotFoundFault:

UserNotFoundFault:

ACLNotFoundFault:

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

MultiRegionParameterGroupNotFoundFault:

The specified multi-Region parameter group does not exist.

TagQuotaPerResourceExceeded:

InvalidARNFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Use this operation to remove tags on a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ClusterNotFoundFault:

InvalidClusterStateFault:

ParameterGroupNotFoundFault:

SubnetGroupNotFoundFault:

SnapshotNotFoundFault:

InvalidARNFault:

TagNotFoundFault:

ServiceLinkedRoleNotFoundFault:

UserNotFoundFault:

ACLNotFoundFault:

InvalidParameterValueException:

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

MultiRegionParameterGroupNotFoundFault:

The specified multi-Region parameter group does not exist.

UpdateACL

$result = $client->updateACL([/* ... */]);
$promise = $client->updateACLAsync([/* ... */]);

Changes the list of users that belong to the Access Control List.

Parameter Syntax

$result = $client->updateACL([
    'ACLName' => '<string>', // REQUIRED
    'UserNamesToAdd' => ['<string>', ...],
    'UserNamesToRemove' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ACL' => [
        'ARN' => '<string>',
        'Clusters' => ['<string>', ...],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'PendingChanges' => [
            'UserNamesToAdd' => ['<string>', ...],
            'UserNamesToRemove' => ['<string>', ...],
        ],
        'Status' => '<string>',
        'UserNames' => ['<string>', ...],
    ],
]

Result Details

Errors

ACLNotFoundFault:

UserNotFoundFault:

DuplicateUserNameFault:

DefaultUserRequired:

InvalidACLStateFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

UpdateCluster

$result = $client->updateCluster([/* ... */]);
$promise = $client->updateClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateCluster([
    'ACLName' => '<string>',
    'ClusterName' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'MaintenanceWindow' => '<string>',
    'NodeType' => '<string>',
    'ParameterGroupName' => '<string>',
    'ReplicaConfiguration' => [
        'ReplicaCount' => <integer>,
    ],
    'SecurityGroupIds' => ['<string>', ...],
    'ShardConfiguration' => [
        'ShardCount' => <integer>,
    ],
    'SnapshotRetentionLimit' => <integer>,
    'SnapshotWindow' => '<string>',
    'SnsTopicArn' => '<string>',
    'SnsTopicStatus' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ACLName' => '<string>',
        'ARN' => '<string>',
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityMode' => 'singleaz|multiaz',
        'ClusterEndpoint' => [
            'Address' => '<string>',
            'Port' => <integer>,
        ],
        'DataTiering' => 'true|false',
        'Description' => '<string>',
        'Engine' => '<string>',
        'EnginePatchVersion' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MaintenanceWindow' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'Name' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'ParameterGroupName' => '<string>',
        'ParameterGroupStatus' => '<string>',
        'PendingUpdates' => [
            'ACLs' => [
                'ACLToApply' => '<string>',
            ],
            'Resharding' => [
                'SlotMigration' => [
                    'ProgressPercentage' => <float>,
                ],
            ],
            'ServiceUpdates' => [
                [
                    'ServiceUpdateName' => '<string>',
                    'Status' => 'available|in-progress|complete|scheduled',
                ],
                // ...
            ],
        ],
        'SecurityGroups' => [
            [
                'SecurityGroupId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Shards' => [
            [
                'Name' => '<string>',
                'Nodes' => [
                    [
                        'AvailabilityZone' => '<string>',
                        'CreateTime' => <DateTime>,
                        'Endpoint' => [
                            'Address' => '<string>',
                            'Port' => <integer>,
                        ],
                        'Name' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'NumberOfNodes' => <integer>,
                'Slots' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'SnapshotRetentionLimit' => <integer>,
        'SnapshotWindow' => '<string>',
        'SnsTopicArn' => '<string>',
        'SnsTopicStatus' => '<string>',
        'Status' => '<string>',
        'SubnetGroupName' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

ClusterNotFoundFault:

InvalidClusterStateFault:

InvalidNodeStateFault:

ParameterGroupNotFoundFault:

InvalidVPCNetworkStateFault:

ServiceLinkedRoleNotFoundFault:

InvalidKMSKeyFault:

NodeQuotaForClusterExceededFault:

ClusterQuotaForCustomerExceededFault:

ShardsPerClusterQuotaExceededFault:

NodeQuotaForCustomerExceededFault:

NoOperationFault:

InvalidACLStateFault:

ACLNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

UpdateMultiRegionCluster

$result = $client->updateMultiRegionCluster([/* ... */]);
$promise = $client->updateMultiRegionClusterAsync([/* ... */]);

Updates the configuration of an existing multi-Region cluster.

Parameter Syntax

$result = $client->updateMultiRegionCluster([
    'Description' => '<string>',
    'EngineVersion' => '<string>',
    'MultiRegionClusterName' => '<string>', // REQUIRED
    'MultiRegionParameterGroupName' => '<string>',
    'NodeType' => '<string>',
    'ShardConfiguration' => [
        'ShardCount' => <integer>,
    ],
    'UpdateStrategy' => 'coordinated|uncoordinated',
]);

Parameter Details

Result Syntax

[
    'MultiRegionCluster' => [
        'ARN' => '<string>',
        'Clusters' => [
            [
                'ARN' => '<string>',
                'ClusterName' => '<string>',
                'Region' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'MultiRegionClusterName' => '<string>',
        'MultiRegionParameterGroupName' => '<string>',
        'NodeType' => '<string>',
        'NumberOfShards' => <integer>,
        'Status' => '<string>',
        'TLSEnabled' => true || false,
    ],
]

Result Details

Errors

MultiRegionClusterNotFoundFault:

The specified multi-Region cluster does not exist.

MultiRegionParameterGroupNotFoundFault:

The specified multi-Region parameter group does not exist.

InvalidMultiRegionClusterStateFault:

The requested operation cannot be performed on the multi-Region cluster in its current state.

InvalidParameterCombinationException:

InvalidParameterValueException:

UpdateParameterGroup

$result = $client->updateParameterGroup([/* ... */]);
$promise = $client->updateParameterGroupAsync([/* ... */]);

Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Parameter Syntax

$result = $client->updateParameterGroup([
    'ParameterGroupName' => '<string>', // REQUIRED
    'ParameterNameValues' => [ // REQUIRED
        [
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ParameterGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Family' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

ParameterGroupNotFoundFault:

InvalidParameterGroupStateFault:

ServiceLinkedRoleNotFoundFault:

InvalidParameterValueException:

InvalidParameterCombinationException:

UpdateSubnetGroup

$result = $client->updateSubnetGroup([/* ... */]);
$promise = $client->updateSubnetGroupAsync([/* ... */]);

Updates a subnet group. For more information, see Updating a subnet group

Parameter Syntax

$result = $client->updateSubnetGroup([
    'Description' => '<string>',
    'SubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'SubnetGroup' => [
        'ARN' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Subnets' => [
            [
                'AvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'Identifier' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

SubnetGroupNotFoundFault:

SubnetQuotaExceededFault:

SubnetInUse:

InvalidSubnet:

ServiceLinkedRoleNotFoundFault:

SubnetNotAllowedFault:

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Changes user password(s) and/or access string.

Parameter Syntax

$result = $client->updateUser([
    'AccessString' => '<string>',
    'AuthenticationMode' => [
        'Passwords' => ['<string>', ...],
        'Type' => 'password|iam',
    ],
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'ACLNames' => ['<string>', ...],
        'ARN' => '<string>',
        'AccessString' => '<string>',
        'Authentication' => [
            'PasswordCount' => <integer>,
            'Type' => 'password|no-password|iam',
        ],
        'MinimumEngineVersion' => '<string>',
        'Name' => '<string>',
        'Status' => '<string>',
    ],
]

Result Details

Errors

UserNotFoundFault:

InvalidUserStateFault:

InvalidParameterValueException:

InvalidParameterCombinationException: