---
title: "POST /cluster/{clusterArn}/stop"
method: POST
path: "/cluster/{clusterArn}/stop"
---

# POST /cluster/{clusterArn}/stop

`POST /cluster/{clusterArn}/stop`

Stops the running elastic cluster that is specified by <code>clusterArn</code>. The elastic cluster must be in the <i>available</i> state.

## Path parameters

- `clusterArn` string, required

## Response `200`

Success

- StopClusterOutput
  - `cluster` Cluster, required — Returns information about a specific elastic cluster.
    - `adminUserName` string, required — The name of the elastic cluster administrator.
    - `authType` 'PLAIN_TEXT' | 'SECRET_ARN', required — The authentication type for the elastic cluster.
    - `backupRetentionPeriod` integer — The number of days for which automatic snapshots are retained.
    - `clusterArn` string, required — The ARN identifier of the elastic cluster.
    - `clusterEndpoint` string, required — The URL used to connect to the elastic cluster.
    - `clusterName` string, required — The name of the elastic cluster.
    - `createTime` string, required — The time when the elastic cluster was created in Universal Coordinated Time (UTC).
    - `kmsKeyId` string, required — The KMS key identifier to use to encrypt the elastic cluster.
    - `preferredBackupWindow` string — The daily time range during which automated backups are created if automated backups are enabled, as determined by <code>backupRetentionPeriod</code>.
    - `preferredMaintenanceWindow` string, required — <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p> <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p>
    - `shardCapacity` integer, required — The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
    - `shardCount` integer, required — The number of shards assigned to the elastic cluster. Maximum is 32.
    - `shardInstanceCount` integer — The number of replica instances applying to all shards in the cluster. A <code>shardInstanceCount</code> 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` Shard[] — The total number of shards in the cluster.
      - `createTime` string, required — The time when the shard was created in Universal Coordinated Time (UTC).
      - `shardId` string, required — The ID of the shard.
      - `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', required — The current status of the shard.
    - `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', required — The status of the elastic cluster.
    - `subnetIds` String[], required — The Amazon EC2 subnet IDs for the elastic cluster.
    - `vpcSecurityGroupIds` String[], required — A list of EC2 VPC security groups associated with thie elastic cluster.

## Other responses

- `480` — ThrottlingException
- `481` — ValidationException
- `482` — InternalServerException
- `483` — ResourceNotFoundException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/docdb-elastic.md) · [All operations](https://skmtc.net/aws/apis/docdb-elastic/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/docdb-elastic/versions/71417e1f0c94/schema)