SDK for PHP 3.x

Amazon DocumentDB Elastic Clusters 2022-11-28

Client: Aws\DocDBElastic\DocDBElasticClient
Service ID: docdb-elastic
Version: 2022-11-28

This page describes the parameters and results for the operations of the Amazon DocumentDB Elastic Clusters (2022-11-28), and shows how to use the Aws\DocDBElastic\DocDBElasticClient object to call the described operations. This documentation is specific to the 2022-11-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ApplyPendingMaintenanceAction ( array $params = [] )
The type of pending maintenance action to be applied to the resource.
CopyClusterSnapshot ( array $params = [] )
Copies a snapshot of an elastic cluster.
CreateCluster ( array $params = [] )
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
CreateClusterSnapshot ( array $params = [] )
Creates a snapshot of an elastic cluster.
DeleteCluster ( array $params = [] )
Delete an elastic cluster.
DeleteClusterSnapshot ( array $params = [] )
Delete an elastic cluster snapshot.
GetCluster ( array $params = [] )
Returns information about a specific elastic cluster.
GetClusterSnapshot ( array $params = [] )
Returns information about a specific elastic cluster snapshot
GetPendingMaintenanceAction ( array $params = [] )
Retrieves all maintenance actions that are pending.
ListClusterSnapshots ( array $params = [] )
Returns information about snapshots for a specified elastic cluster.
ListClusters ( array $params = [] )
Returns information about provisioned Amazon DocumentDB elastic clusters.
ListPendingMaintenanceActions ( array $params = [] )
Retrieves a list of all maintenance actions that are pending.
ListTagsForResource ( array $params = [] )
Lists all tags on a elastic cluster resource
RestoreClusterFromSnapshot ( array $params = [] )
Restores an elastic cluster from a snapshot.
StartCluster ( array $params = [] )
Restarts the stopped elastic cluster that is specified by clusterARN.
StopCluster ( array $params = [] )
Stops the running elastic cluster that is specified by clusterArn.
TagResource ( array $params = [] )
Adds metadata tags to an elastic cluster resource
UntagResource ( array $params = [] )
Removes metadata tags from an elastic cluster resource
UpdateCluster ( array $params = [] )
Modifies an elastic cluster.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListClusterSnapshots
ListClusters
ListPendingMaintenanceActions

Operations

ApplyPendingMaintenanceAction 

$result = $client->applyPendingMaintenanceAction([/* ... */]);
$promise = $client->applyPendingMaintenanceActionAsync([/* ... */]);

The type of pending maintenance action to be applied to the resource.

Parameter Syntax

$result = $client->applyPendingMaintenanceAction([
    'applyAction' => '<string>', // REQUIRED
    'applyOn' => '<string>',
    'optInType' => 'IMMEDIATE|NEXT_MAINTENANCE|APPLY_ON|UNDO_OPT_IN', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
applyAction
Required: Yes
Type: string

The pending maintenance action to apply to the resource.

Valid actions are:

  • ENGINE_UPDATE

  • ENGINE_UPGRADE

  • SECURITY_UPDATE

  • OS_UPDATE

  • MASTER_USER_PASSWORD_UPDATE

applyOn
Type: string

A specific date to apply the pending maintenance action. Required if opt-in-type is APPLY_ON. Format: yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm

optInType
Required: Yes
Type: string

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type IMMEDIATE can't be undone.

resourceArn
Required: Yes
Type: string

The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

Result Syntax

[
    'resourcePendingMaintenanceAction' => [
        'pendingMaintenanceActionDetails' => [
            [
                'action' => '<string>',
                'autoAppliedAfterDate' => '<string>',
                'currentApplyDate' => '<string>',
                'description' => '<string>',
                'forcedApplyDate' => '<string>',
                'optInStatus' => '<string>',
            ],
            // ...
        ],
        'resourceArn' => '<string>',
    ],
]

Result Details

Members
resourcePendingMaintenanceAction
Required: Yes
Type: ResourcePendingMaintenanceAction structure

The output of the pending maintenance action being applied.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

CopyClusterSnapshot 

$result = $client->copyClusterSnapshot([/* ... */]);
$promise = $client->copyClusterSnapshotAsync([/* ... */]);

Copies a snapshot of an elastic cluster.

Parameter Syntax

$result = $client->copyClusterSnapshot([
    'copyTags' => true || false,
    'kmsKeyId' => '<string>',
    'snapshotArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Members
copyTags
Type: boolean

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

kmsKeyId
Type: string

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

snapshotArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to be assigned to the elastic cluster snapshot.

targetSnapshotName
Required: Yes
Type: string

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

Result Syntax

[
    'snapshot' => [
        'adminUserName' => '<string>',
        'clusterArn' => '<string>',
        'clusterCreationTime' => '<string>',
        'kmsKeyId' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreationTime' => '<string>',
        'snapshotName' => '<string>',
        'snapshotType' => 'MANUAL|AUTOMATED',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
snapshot
Required: Yes
Type: ClusterSnapshot structure

Returns information about a specific elastic cluster snapshot.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ServiceQuotaExceededException:

The service quota for the action was exceeded.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

CreateCluster 

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

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Parameter Syntax

$result = $client->createCluster([
    'adminUserName' => '<string>', // REQUIRED
    'adminUserPassword' => '<string>', // REQUIRED
    'authType' => 'PLAIN_TEXT|SECRET_ARN', // REQUIRED
    'backupRetentionPeriod' => <integer>,
    'clientToken' => '<string>',
    'clusterName' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'preferredBackupWindow' => '<string>',
    'preferredMaintenanceWindow' => '<string>',
    'shardCapacity' => <integer>, // REQUIRED
    'shardCount' => <integer>, // REQUIRED
    'shardInstanceCount' => <integer>,
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'vpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
adminUserName
Required: Yes
Type: string

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word.

adminUserPassword
Required: Yes
Type: string

The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

Constraints:

  • Must contain from 8 to 100 characters.

  • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

authType
Required: Yes
Type: string

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

backupRetentionPeriod
Type: int

The number of days for which automatic snapshots are retained.

clientToken
Type: string

The client token for the elastic cluster.

clusterName
Required: Yes
Type: string

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

kmsKeyId
Type: string

The KMS key identifier to use to encrypt the new elastic cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredBackupWindow
Type: string

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

preferredMaintenanceWindow
Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

shardCapacity
Required: Yes
Type: int

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount
Required: Yes
Type: int

The number of shards assigned to the elastic cluster. Maximum is 32.

shardInstanceCount
Type: int

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIds
Type: Array of strings

The Amazon EC2 subnet IDs for the new elastic cluster.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to be assigned to the new elastic cluster.

vpcSecurityGroupIds
Type: Array of strings

A list of EC2 VPC security groups to associate with the new elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

The new elastic cluster that has been created.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ServiceQuotaExceededException:

The service quota for the action was exceeded.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

CreateClusterSnapshot 

$result = $client->createClusterSnapshot([/* ... */]);
$promise = $client->createClusterSnapshotAsync([/* ... */]);

Creates a snapshot of an elastic cluster.

Parameter Syntax

$result = $client->createClusterSnapshot([
    'clusterArn' => '<string>', // REQUIRED
    'snapshotName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster of which you want to create a snapshot.

snapshotName
Required: Yes
Type: string

The name of the new elastic cluster snapshot.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to be assigned to the new elastic cluster snapshot.

Result Syntax

[
    'snapshot' => [
        'adminUserName' => '<string>',
        'clusterArn' => '<string>',
        'clusterCreationTime' => '<string>',
        'kmsKeyId' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreationTime' => '<string>',
        'snapshotName' => '<string>',
        'snapshotType' => 'MANUAL|AUTOMATED',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
snapshot
Required: Yes
Type: ClusterSnapshot structure

Returns information about the new elastic cluster snapshot.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ServiceQuotaExceededException:

The service quota for the action was exceeded.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

DeleteCluster 

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

Delete an elastic cluster.

Parameter Syntax

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

Parameter Details

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster that is to be deleted.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about the newly deleted elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

DeleteClusterSnapshot 

$result = $client->deleteClusterSnapshot([/* ... */]);
$promise = $client->deleteClusterSnapshotAsync([/* ... */]);

Delete an elastic cluster snapshot.

Parameter Syntax

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

Parameter Details

Members
snapshotArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster snapshot that is to be deleted.

Result Syntax

[
    'snapshot' => [
        'adminUserName' => '<string>',
        'clusterArn' => '<string>',
        'clusterCreationTime' => '<string>',
        'kmsKeyId' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreationTime' => '<string>',
        'snapshotName' => '<string>',
        'snapshotType' => 'MANUAL|AUTOMATED',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
snapshot
Required: Yes
Type: ClusterSnapshot structure

Returns information about the newly deleted elastic cluster snapshot.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

GetCluster 

$result = $client->getCluster([/* ... */]);
$promise = $client->getClusterAsync([/* ... */]);

Returns information about a specific elastic cluster.

Parameter Syntax

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

Parameter Details

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about a specific elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

GetClusterSnapshot 

$result = $client->getClusterSnapshot([/* ... */]);
$promise = $client->getClusterSnapshotAsync([/* ... */]);

Returns information about a specific elastic cluster snapshot

Parameter Syntax

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

Parameter Details

Members
snapshotArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster snapshot.

Result Syntax

[
    'snapshot' => [
        'adminUserName' => '<string>',
        'clusterArn' => '<string>',
        'clusterCreationTime' => '<string>',
        'kmsKeyId' => '<string>',
        'snapshotArn' => '<string>',
        'snapshotCreationTime' => '<string>',
        'snapshotName' => '<string>',
        'snapshotType' => 'MANUAL|AUTOMATED',
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
snapshot
Required: Yes
Type: ClusterSnapshot structure

Returns information about a specific elastic cluster snapshot.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

GetPendingMaintenanceAction 

$result = $client->getPendingMaintenanceAction([/* ... */]);
$promise = $client->getPendingMaintenanceActionAsync([/* ... */]);

Retrieves all maintenance actions that are pending.

Parameter Syntax

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

Parameter Details

Members
resourceArn
Required: Yes
Type: string

Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).

Result Syntax

[
    'resourcePendingMaintenanceAction' => [
        'pendingMaintenanceActionDetails' => [
            [
                'action' => '<string>',
                'autoAppliedAfterDate' => '<string>',
                'currentApplyDate' => '<string>',
                'description' => '<string>',
                'forcedApplyDate' => '<string>',
                'optInStatus' => '<string>',
            ],
            // ...
        ],
        'resourceArn' => '<string>',
    ],
]

Result Details

Members
resourcePendingMaintenanceAction
Required: Yes
Type: ResourcePendingMaintenanceAction structure

Provides information about a pending maintenance action for a resource.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

ListClusterSnapshots 

$result = $client->listClusterSnapshots([/* ... */]);
$promise = $client->listClusterSnapshotsAsync([/* ... */]);

Returns information about snapshots for a specified elastic cluster.

Parameter Syntax

$result = $client->listClusterSnapshots([
    'clusterArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'snapshotType' => '<string>',
]);

Parameter Details

Members
clusterArn
Type: string

The ARN identifier of the elastic cluster.

maxResults
Type: int

The maximum number of elastic cluster snapshot results to receive in the response.

nextToken
Type: string

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

snapshotType
Type: string

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

Result Syntax

[
    'nextToken' => '<string>',
    'snapshots' => [
        [
            'clusterArn' => '<string>',
            'snapshotArn' => '<string>',
            'snapshotCreationTime' => '<string>',
            'snapshotName' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

snapshots
Type: Array of ClusterSnapshotInList structures

A list of snapshots for a specified elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

ListClusters 

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Returns information about provisioned Amazon DocumentDB elastic clusters.

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of elastic cluster snapshot results to receive in the response.

nextToken
Type: string

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

Result Syntax

[
    'clusters' => [
        [
            'clusterArn' => '<string>',
            'clusterName' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
clusters
Type: Array of ClusterInList structures

A list of Amazon DocumentDB elastic clusters.

nextToken
Type: string

A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

If there is no more data in the responce, the nextToken will not be returned.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

ListPendingMaintenanceActions 

$result = $client->listPendingMaintenanceActions([/* ... */]);
$promise = $client->listPendingMaintenanceActionsAsync([/* ... */]);

Retrieves a list of all maintenance actions that are pending.

Parameter Syntax

$result = $client->listPendingMaintenanceActions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to include in the response. If more records exist than the specified maxResults value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

nextToken
Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by maxResults.

Result Syntax

[
    'nextToken' => '<string>',
    'resourcePendingMaintenanceActions' => [
        [
            'pendingMaintenanceActionDetails' => [
                [
                    'action' => '<string>',
                    'autoAppliedAfterDate' => '<string>',
                    'currentApplyDate' => '<string>',
                    'description' => '<string>',
                    'forcedApplyDate' => '<string>',
                    'optInStatus' => '<string>',
                ],
                // ...
            ],
            'resourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

An optional pagination token provided by a previous request. If this parameter is displayed, the responses will include only records beyond the marker, up to the value specified by maxResults.

resourcePendingMaintenanceActions
Required: Yes
Type: Array of ResourcePendingMaintenanceAction structures

Provides information about a pending maintenance action for a resource.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags on a elastic cluster resource

Parameter Syntax

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

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The list of tags for the specified elastic cluster resource.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

RestoreClusterFromSnapshot 

$result = $client->restoreClusterFromSnapshot([/* ... */]);
$promise = $client->restoreClusterFromSnapshotAsync([/* ... */]);

Restores an elastic cluster from a snapshot.

Parameter Syntax

$result = $client->restoreClusterFromSnapshot([
    'clusterName' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'shardCapacity' => <integer>,
    'shardInstanceCount' => <integer>,
    'snapshotArn' => '<string>', // REQUIRED
    'subnetIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'vpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
clusterName
Required: Yes
Type: string

The name of the elastic cluster.

kmsKeyId
Type: string

The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

shardCapacity
Type: int

The capacity of each shard in the new restored elastic cluster.

shardInstanceCount
Type: int

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

snapshotArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster snapshot.

subnetIds
Type: Array of strings

The Amazon EC2 subnet IDs for the elastic cluster.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

vpcSecurityGroupIds
Type: Array of strings

A list of EC2 VPC security groups to associate with the elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about a the restored elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ServiceQuotaExceededException:

The service quota for the action was exceeded.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

StartCluster 

$result = $client->startCluster([/* ... */]);
$promise = $client->startClusterAsync([/* ... */]);

Restarts the stopped elastic cluster that is specified by clusterARN.

Parameter Syntax

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

Parameter Details

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about a specific elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

StopCluster 

$result = $client->stopCluster([/* ... */]);
$promise = $client->stopClusterAsync([/* ... */]);

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

Parameter Syntax

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

Parameter Details

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about a specific elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

TagResource 

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

Adds metadata tags to an elastic cluster resource

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster resource.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags that are assigned to the elastic cluster resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

UntagResource 

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

Removes metadata tags from an elastic cluster resource

Parameter Syntax

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

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster resource.

tagKeys
Required: Yes
Type: Array of strings

The tag keys to be removed from the elastic cluster resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

UpdateCluster 

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

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Parameter Syntax

$result = $client->updateCluster([
    'adminUserPassword' => '<string>',
    'authType' => 'PLAIN_TEXT|SECRET_ARN',
    'backupRetentionPeriod' => <integer>,
    'clientToken' => '<string>',
    'clusterArn' => '<string>', // REQUIRED
    'preferredBackupWindow' => '<string>',
    'preferredMaintenanceWindow' => '<string>',
    'shardCapacity' => <integer>,
    'shardCount' => <integer>,
    'shardInstanceCount' => <integer>,
    'subnetIds' => ['<string>', ...],
    'vpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members
adminUserPassword
Type: string

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

authType
Type: string

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

backupRetentionPeriod
Type: int

The number of days for which automatic snapshots are retained.

clientToken
Type: string

The client token for the elastic cluster.

clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

preferredBackupWindow
Type: string

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

preferredMaintenanceWindow
Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

shardCapacity
Type: int

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount
Type: int

The number of shards assigned to the elastic cluster. Maximum is 32.

shardInstanceCount
Type: int

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIds
Type: Array of strings

The Amazon EC2 subnet IDs for the elastic cluster.

vpcSecurityGroupIds
Type: Array of strings

A list of EC2 VPC security groups to associate with the elastic cluster.

Result Syntax

[
    'cluster' => [
        'adminUserName' => '<string>',
        'authType' => 'PLAIN_TEXT|SECRET_ARN',
        'backupRetentionPeriod' => <integer>,
        'clusterArn' => '<string>',
        'clusterEndpoint' => '<string>',
        'clusterName' => '<string>',
        'createTime' => '<string>',
        'kmsKeyId' => '<string>',
        'preferredBackupWindow' => '<string>',
        'preferredMaintenanceWindow' => '<string>',
        'shardCapacity' => <integer>,
        'shardCount' => <integer>,
        'shardInstanceCount' => <integer>,
        'shards' => [
            [
                'createTime' => '<string>',
                'shardId' => '<string>',
                'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
            ],
            // ...
        ],
        'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS|INACCESSIBLE_SECRET_ARN|INACCESSIBLE_VPC_ENDPOINT|INCOMPATIBLE_NETWORK|MERGING|MODIFYING|SPLITTING|COPYING|STARTING|STOPPING|STOPPED|MAINTENANCE|INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds' => ['<string>', ...],
        'vpcSecurityGroupIds' => ['<string>', ...],
    ],
]

Result Details

Members
cluster
Required: Yes
Type: Cluster structure

Returns information about the updated elastic cluster.

Errors

ThrottlingException:

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException:

A structure defining a validation exception.

ConflictException:

There was an access conflict.

InternalServerException:

There was an internal server error.

ResourceNotFoundException:

The specified resource could not be located.

AccessDeniedException:

An exception that occurs when there are not sufficient permissions to perform an action.

Shapes

AccessDeniedException

Description

An exception that occurs when there are not sufficient permissions to perform an action.

Members
message
Required: Yes
Type: string

An error message explaining why access was denied.

Cluster

Description

Returns information about a specific elastic cluster.

Members
adminUserName
Required: Yes
Type: string

The name of the elastic cluster administrator.

authType
Required: Yes
Type: string

The authentication type for the elastic cluster.

backupRetentionPeriod
Type: int

The number of days for which automatic snapshots are retained.

clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

clusterEndpoint
Required: Yes
Type: string

The URL used to connect to the elastic cluster.

clusterName
Required: Yes
Type: string

The name of the elastic cluster.

createTime
Required: Yes
Type: string

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

kmsKeyId
Required: Yes
Type: string

The KMS key identifier to use to encrypt the elastic cluster.

preferredBackupWindow
Type: string

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

preferredMaintenanceWindow
Required: Yes
Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

shardCapacity
Required: Yes
Type: int

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount
Required: Yes
Type: int

The number of shards assigned to the elastic cluster. Maximum is 32.

shardInstanceCount
Type: int

The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

shards
Type: Array of Shard structures

The total number of shards in the cluster.

status
Required: Yes
Type: string

The status of the elastic cluster.

subnetIds
Required: Yes
Type: Array of strings

The Amazon EC2 subnet IDs for the elastic cluster.

vpcSecurityGroupIds
Required: Yes
Type: Array of strings

A list of EC2 VPC security groups associated with thie elastic cluster.

ClusterInList

Description

A list of Amazon DocumentDB elastic clusters.

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

clusterName
Required: Yes
Type: string

The name of the elastic cluster.

status
Required: Yes
Type: string

The status of the elastic cluster.

ClusterSnapshot

Description

Returns information about a specific elastic cluster snapshot.

Members
adminUserName
Required: Yes
Type: string

The name of the elastic cluster administrator.

clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

clusterCreationTime
Required: Yes
Type: string

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

kmsKeyId
Required: Yes
Type: string

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

snapshotArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster snapshot.

snapshotCreationTime
Required: Yes
Type: string

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

snapshotName
Required: Yes
Type: string

The name of the elastic cluster snapshot.

snapshotType
Type: string

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

status
Required: Yes
Type: string

The status of the elastic cluster snapshot.

subnetIds
Required: Yes
Type: Array of strings

The Amazon EC2 subnet IDs for the elastic cluster.

vpcSecurityGroupIds
Required: Yes
Type: Array of strings

A list of EC2 VPC security groups to associate with the elastic cluster.

ClusterSnapshotInList

Description

A list of elastic cluster snapshots.

Members
clusterArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster.

snapshotArn
Required: Yes
Type: string

The ARN identifier of the elastic cluster snapshot.

snapshotCreationTime
Required: Yes
Type: string

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

snapshotName
Required: Yes
Type: string

The name of the elastic cluster snapshot.

status
Required: Yes
Type: string

The status of the elastic cluster snapshot.

ConflictException

Description

There was an access conflict.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The ID of the resource where there was an access conflict.

resourceType
Required: Yes
Type: string

The type of the resource where there was an access conflict.

InternalServerException

Description

There was an internal server error.

Members
message
Required: Yes
Type: string

PendingMaintenanceActionDetails

Description

Retrieves the details of maintenance actions that are pending.

Members
action
Required: Yes
Type: string

Displays the specific action of a pending maintenance action.

autoAppliedAfterDate
Type: string

Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any NEXT_MAINTENANCE optInType requests are ignored.

currentApplyDate
Type: string

Displays the effective date when the pending maintenance action is applied to the resource.

description
Type: string

Displays a description providing more detail about the maintenance action.

forcedApplyDate
Type: string

Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any IMMEDIATE optInType requests are ignored.

optInStatus
Type: string

Displays the type of optInType request that has been received for the resource.

ResourceNotFoundException

Description

The specified resource could not be located.

Members
message
Required: Yes
Type: string

An error message describing the failure.

resourceId
Required: Yes
Type: string

The ID of the resource that could not be located.

resourceType
Required: Yes
Type: string

The type of the resource that could not be found.

ResourcePendingMaintenanceAction

Description

Provides information about a pending maintenance action for a resource.

Members
pendingMaintenanceActionDetails
Type: Array of PendingMaintenanceActionDetails structures

Provides information about a pending maintenance action for a resource.

resourceArn
Type: string

The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

ServiceQuotaExceededException

Description

The service quota for the action was exceeded.

Members
message
Required: Yes
Type: string

Shard

Description

The name of the shard.

Members
createTime
Required: Yes
Type: string

The time when the shard was created in Universal Coordinated Time (UTC).

shardId
Required: Yes
Type: string

The ID of the shard.

status
Required: Yes
Type: string

The current status of the shard.

ThrottlingException

Description

ThrottlingException will be thrown when request was denied due to request throttling.

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

The number of seconds to wait before retrying the operation.

ValidationException

Description

A structure defining a validation exception.

Members
fieldList
Type: Array of ValidationExceptionField structures

A list of the fields in which the validation exception occurred.

message
Required: Yes
Type: string

An error message describing the validation exception.

reason
Required: Yes
Type: string

The reason why the validation exception occurred (one of unknownOperation, cannotParse, fieldValidationFailed, or other).

ValidationExceptionField

Description

A specific field in which a given validation exception occurred.

Members
message
Required: Yes
Type: string

An error message describing the validation exception in this field.

name
Required: Yes
Type: string

The name of the field where the validation exception occurred.