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 */).
- CreateCluster ( array $params = [] )
Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
- CreateClusterSnapshot ( array $params = [] )
Creates a snapshot of a cluster.
- DeleteCluster ( array $params = [] )
Delete a Elastic DocumentDB cluster.
- DeleteClusterSnapshot ( array $params = [] )
Delete a Elastic DocumentDB snapshot.
- GetCluster ( array $params = [] )
Returns information about a specific Elastic DocumentDB cluster.
- GetClusterSnapshot ( array $params = [] )
Returns information about a specific Elastic DocumentDB snapshot
- ListClusterSnapshots ( array $params = [] )
Returns information about Elastic DocumentDB snapshots for a specified cluster.
- ListClusters ( array $params = [] )
Returns information about provisioned Elastic DocumentDB clusters.
- ListTagsForResource ( array $params = [] )
Lists all tags on a Elastic DocumentDB resource
- RestoreClusterFromSnapshot ( array $params = [] )
Restores a Elastic DocumentDB cluster from a snapshot.
- TagResource ( array $params = [] )
Adds metadata tags to a Elastic DocumentDB resource
- UntagResource ( array $params = [] )
Removes metadata tags to a Elastic DocumentDB resource
- UpdateCluster ( array $params = [] )
Modifies a Elastic DocumentDB 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:
Operations
CreateCluster
$result = $client->createCluster([/* ... */]); $promise = $client->createClusterAsync([/* ... */]);
Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
Parameter Syntax
$result = $client->createCluster([
'adminUserName' => '<string>', // REQUIRED
'adminUserPassword' => '<string>', // REQUIRED
'authType' => 'PLAIN_TEXT|SECRET_ARN', // REQUIRED
'clientToken' => '<string>',
'clusterName' => '<string>', // REQUIRED
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>, // REQUIRED
'shardCount' => <integer>, // REQUIRED
'subnetIds' => ['<string>', ...],
'tags' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
]);
Parameter Details
Members
- adminUserName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster 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 Elastic DocumentDB cluster administrator and 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 for the Elastic DocumentDB cluster.
- clientToken
-
- Type: string
The client token for the Elastic DocumentDB cluster.
- clusterName
-
- Required: Yes
- Type: string
The name of the new Elastic DocumentDB 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 DocumentDB 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, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
- preferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miDefault: 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 capacity of each shard in the new Elastic DocumentDB cluster.
- shardCount
-
- Required: Yes
- Type: int
The number of shards to create in the new Elastic DocumentDB cluster.
- subnetIds
-
- Type: Array of strings
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to be assigned to the new Elastic DocumentDB cluster.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
Result Syntax
[
'cluster' => [
'adminUserName' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clusterArn' => '<string>',
'clusterEndpoint' => '<string>',
'clusterName' => '<string>',
'createTime' => '<string>',
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- cluster
-
- Required: Yes
- Type: Cluster structure
The new Elastic DocumentDB cluster that has been created.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
ServiceQuotaExceededException:
The service quota for the action was exceeded.
-
There was an access conflict.
-
There was an internal server error.
-
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 a cluster.
Parameter Syntax
$result = $client->createClusterSnapshot([
'clusterArn' => '<string>', // REQUIRED
'snapshotName' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.
- snapshotName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB snapshot.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to be assigned to the new Elastic DocumentDB snapshot.
Result Syntax
[
'snapshot' => [
'adminUserName' => '<string>',
'clusterArn' => '<string>',
'clusterCreationTime' => '<string>',
'kmsKeyId' => '<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',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- snapshot
-
- Required: Yes
- Type: ClusterSnapshot structure
Returns information about the new Elastic DocumentDB snapshot.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
ServiceQuotaExceededException:
The service quota for the action was exceeded.
-
There was an access conflict.
-
There was an internal server error.
-
The specified resource could not be located.
-
An exception that occurs when there are not sufficient permissions to perform an action.
DeleteCluster
$result = $client->deleteCluster([/* ... */]); $promise = $client->deleteClusterAsync([/* ... */]);
Delete a Elastic DocumentDB cluster.
Parameter Syntax
$result = $client->deleteCluster([
'clusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster that is to be deleted.
Result Syntax
[
'cluster' => [
'adminUserName' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clusterArn' => '<string>',
'clusterEndpoint' => '<string>',
'clusterName' => '<string>',
'createTime' => '<string>',
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- cluster
-
- Required: Yes
- Type: Cluster structure
Returns information about the newly deleted Elastic DocumentDB cluster.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an access conflict.
-
There was an internal server error.
-
The specified resource could not be located.
-
An exception that occurs when there are not sufficient permissions to perform an action.
DeleteClusterSnapshot
$result = $client->deleteClusterSnapshot([/* ... */]); $promise = $client->deleteClusterSnapshotAsync([/* ... */]);
Delete a Elastic DocumentDB snapshot.
Parameter Syntax
$result = $client->deleteClusterSnapshot([
'snapshotArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- snapshotArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB snapshot that is to be deleted.
Result Syntax
[
'snapshot' => [
'adminUserName' => '<string>',
'clusterArn' => '<string>',
'clusterCreationTime' => '<string>',
'kmsKeyId' => '<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',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- snapshot
-
- Required: Yes
- Type: ClusterSnapshot structure
Returns information about the newly deleted Elastic DocumentDB snapshot.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an access conflict.
-
There was an internal server error.
-
The specified resource could not be located.
-
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 DocumentDB cluster.
Parameter Syntax
$result = $client->getCluster([
'clusterArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
Result Syntax
[
'cluster' => [
'adminUserName' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clusterArn' => '<string>',
'clusterEndpoint' => '<string>',
'clusterName' => '<string>',
'createTime' => '<string>',
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- cluster
-
- Required: Yes
- Type: Cluster structure
Returns information about a specific Elastic DocumentDB cluster.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
The specified resource could not be located.
-
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 DocumentDB snapshot
Parameter Syntax
$result = $client->getClusterSnapshot([
'snapshotArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- snapshotArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB snapshot.
Result Syntax
[
'snapshot' => [
'adminUserName' => '<string>',
'clusterArn' => '<string>',
'clusterCreationTime' => '<string>',
'kmsKeyId' => '<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',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- snapshot
-
- Required: Yes
- Type: ClusterSnapshot structure
Returns information about a specific Elastic DocumentDB snapshot.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
The specified resource could not be located.
-
An exception that occurs when there are not sufficient permissions to perform an action.
ListClusterSnapshots
$result = $client->listClusterSnapshots([/* ... */]); $promise = $client->listClusterSnapshotsAsync([/* ... */]);
Returns information about Elastic DocumentDB snapshots for a specified cluster.
Parameter Syntax
$result = $client->listClusterSnapshots([
'clusterArn' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- clusterArn
-
- Type: string
The arn of the Elastic DocumentDB cluster.
- maxResults
-
- Type: int
The maximum number of entries to recieve in the response.
- nextToken
-
- Type: string
The nextToken which is used the get the next page of data.
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',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The response will provide a nextToken if there is more data beyond the maxResults.
If there is no more data in the responce, the nextToken will not be returned.
- snapshots
-
- Type: Array of ClusterSnapshotInList structures
A list of Elastic DocumentDB snapshots for a specified cluster.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
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 Elastic DocumentDB clusters.
Parameter Syntax
$result = $client->listClusters([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of entries to recieve in the response.
- nextToken
-
- Type: string
The nextToken which is used the get the next page of data.
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',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- clusters
-
- Type: Array of ClusterInList structures
A list of Elastic DocumentDB cluster.
- nextToken
-
- Type: string
The response will provide a nextToken if there is more data beyond the maxResults.
If there is no more data in the responce, the nextToken will not be returned.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
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 DocumentDB resource
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB 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 DocumentDB resource.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
The specified resource could not be located.
RestoreClusterFromSnapshot
$result = $client->restoreClusterFromSnapshot([/* ... */]); $promise = $client->restoreClusterFromSnapshotAsync([/* ... */]);
Restores a Elastic DocumentDB cluster from a snapshot.
Parameter Syntax
$result = $client->restoreClusterFromSnapshot([
'clusterName' => '<string>', // REQUIRED
'kmsKeyId' => '<string>',
'snapshotArn' => '<string>', // REQUIRED
'subnetIds' => ['<string>', ...],
'tags' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
]);
Parameter Details
Members
- clusterName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster.
- kmsKeyId
-
- Type: string
The KMS key identifier to use to encrypt the new Elastic DocumentDB 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, Elastic 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 of the Elastic DocumentDB snapshot.
- subnetIds
-
- Type: Array of strings
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of the tag names to be assigned to the restored DB 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 DocumentDB cluster.
Result Syntax
[
'cluster' => [
'adminUserName' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clusterArn' => '<string>',
'clusterEndpoint' => '<string>',
'clusterName' => '<string>',
'createTime' => '<string>',
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- cluster
-
- Required: Yes
- Type: Cluster structure
Returns information about a the restored Elastic DocumentDB cluster.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
ServiceQuotaExceededException:
The service quota for the action was exceeded.
-
There was an access conflict.
-
There was an internal server error.
-
The specified resource could not be located.
-
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 a Elastic DocumentDB resource
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to be assigned to the Elastic DocumentDB resource.
Result Syntax
[]
Result Details
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
The specified resource could not be located.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes metadata tags to a Elastic DocumentDB resource
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys to be removed from the Elastic DocumentDB resource.
Result Syntax
[]
Result Details
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an internal server error.
-
The specified resource could not be located.
UpdateCluster
$result = $client->updateCluster([/* ... */]); $promise = $client->updateClusterAsync([/* ... */]);
Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window
Parameter Syntax
$result = $client->updateCluster([
'adminUserPassword' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clientToken' => '<string>',
'clusterArn' => '<string>', // REQUIRED
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
]);
Parameter Details
Members
- adminUserPassword
-
- Type: string
The password for the Elastic DocumentDB 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 for the Elastic DocumentDB cluster.
- clientToken
-
- Type: string
The client token for the Elastic DocumentDB cluster.
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
- preferredMaintenanceWindow
-
- Type: string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miDefault: 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 capacity of each shard in the Elastic DocumentDB cluster.
- shardCount
-
- Type: int
The number of shards to create in the Elastic DocumentDB cluster.
- subnetIds
-
- Type: Array of strings
The number of shards to create in the Elastic DocumentDB cluster.
- vpcSecurityGroupIds
-
- Type: Array of strings
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
Result Syntax
[
'cluster' => [
'adminUserName' => '<string>',
'authType' => 'PLAIN_TEXT|SECRET_ARN',
'clusterArn' => '<string>',
'clusterEndpoint' => '<string>',
'clusterName' => '<string>',
'createTime' => '<string>',
'kmsKeyId' => '<string>',
'preferredMaintenanceWindow' => '<string>',
'shardCapacity' => <integer>,
'shardCount' => <integer>,
'status' => 'CREATING|ACTIVE|DELETING|UPDATING|VPC_ENDPOINT_LIMIT_EXCEEDED|IP_ADDRESS_LIMIT_EXCEEDED|INVALID_SECURITY_GROUP_ID|INVALID_SUBNET_ID|INACCESSIBLE_ENCRYPTION_CREDS',
'subnetIds' => ['<string>', ...],
'vpcSecurityGroupIds' => ['<string>', ...],
],
]
Result Details
Members
- cluster
-
- Required: Yes
- Type: Cluster structure
Returns information about the updated Elastic DocumentDB cluster.
Errors
-
ThrottlingException will be thrown when request was denied due to request throttling.
-
A structure defining a validation exception.
-
There was an access conflict.
-
There was an internal server error.
-
The specified resource could not be located.
-
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 DocumentDB cluster.
Members
- adminUserName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster administrator.
- authType
-
- Required: Yes
- Type: string
The authentication type for the Elastic DocumentDB cluster.
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
- clusterEndpoint
-
- Required: Yes
- Type: string
The URL used to connect to the Elastic DocumentDB cluster.
- clusterName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster.
- createTime
-
- Required: Yes
- Type: string
The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
- kmsKeyId
-
- Required: Yes
- Type: string
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
- 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 capacity of each shard in the Elastic DocumentDB cluster.
- shardCount
-
- Required: Yes
- Type: int
The number of shards in the Elastic DocumentDB cluster.
- status
-
- Required: Yes
- Type: string
The status of the Elastic DocumentDB cluster.
- subnetIds
-
- Required: Yes
- Type: Array of strings
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
- vpcSecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of EC2 VPC security groups associated with this cluster.
ClusterInList
Description
A list of Elastic DocumentDB cluster.
Members
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
- clusterName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster.
- status
-
- Required: Yes
- Type: string
The status of the Elastic DocumentDB cluster.
ClusterSnapshot
Description
Returns information about a specific Elastic DocumentDB snapshot.
Members
- adminUserName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB cluster administrator.
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
- clusterCreationTime
-
- Required: Yes
- Type: string
The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
- kmsKeyId
-
- Required: Yes
- Type: string
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
- snapshotArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB snapshot
- snapshotCreationTime
-
- Required: Yes
- Type: string
The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
- snapshotName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB snapshot.
- status
-
- Required: Yes
- Type: string
The status of the Elastic DocumentDB snapshot.
- subnetIds
-
- Required: Yes
- Type: Array of strings
A list of the IDs of subnets associated with the DB cluster snapshot.
- vpcSecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of the IDs of the VPC security groups associated with the cluster snapshot.
ClusterSnapshotInList
Description
A list of Elastic DocumentDB snapshots.
Members
- clusterArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB cluster.
- snapshotArn
-
- Required: Yes
- Type: string
The arn of the Elastic DocumentDB snapshot
- snapshotCreationTime
-
- Required: Yes
- Type: string
The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
- snapshotName
-
- Required: Yes
- Type: string
The name of the Elastic DocumentDB snapshot.
- status
-
- Required: Yes
- Type: string
The status of the Elastic DocumentDB 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
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.
ServiceQuotaExceededException
Description
The service quota for the action was exceeded.
Members
- message
-
- Required: Yes
- Type: string
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, orother).
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.