ClusterInList - Amazon DocumentDB
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

ClusterInList

A list of Amazon DocumentDB elastic clusters.

Contents

Note

In the following list, the required parameters are described first.

clusterArn

The ARN identifier of the elastic cluster.

Type: String

Required: Yes

clusterName

The name of the elastic cluster.

Type: String

Required: Yes

status

The status of the elastic cluster.

Type: String

Valid Values: 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

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: