기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# Amazon DocumentDB Elastic Clusters
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

Amazon DocumentDB Elastic Clusters는 다음 작업을 지원합니다.
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# ApplyPendingMaintenanceAction
<a name="API_elastic_ApplyPendingMaintenanceAction"></a>

리소스에 적용하기 위해 대기 중인 유지 관리 작업 유형입니다.

## Request Syntax
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestSyntax"></a>

```
POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}
```

## URI 요청 파라미터
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

요청은 URI 파라미터를 사용하지 않습니다.

## 요청 본문
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
리소스에 적용하기 위해 대기 중인 유지 관리 작업입니다.  
유효 작업은 다음과 같습니다.  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256.  
필수 항목 여부: 예

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
옵트인 요청의 유형을 지정하거나 옵트인 요청을 실행 취소하는 값입니다. `IMMEDIATE` 유형의 옵트인 요청은 실행 취소할 수 없습니다.  
타입: 문자열  
유효 값: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
필수 사항 여부: 예

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
보류 중인 유지 관리 작업이 적용되는 리소스의 Amazon DocumentDB Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256.  
필수 항목 여부: 예

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
보류 중인 유지 관리 작업을 적용할 특정 날짜입니다. opt-in-type이 `APPLY_ON`인 경우 필수입니다. 형식: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`   
유형: 문자열  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256.  
필수 여부: 아니요

## 응답 구문
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## 응답 요소
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
적용 보류 중인 유지 관리 작업의 출력입니다.  
타입: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 객체

## 오류
<a name="API_elastic_ApplyPendingMaintenanceAction_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

# CopyClusterSnapshot
<a name="API_elastic_CopyClusterSnapshot"></a>

탄력적 클러스터의 스냅샷을 복사합니다.

## Request Syntax
<a name="API_elastic_CopyClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}
```

## URI 요청 파라미터
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
탄력적 클러스터 스냅샷의 Amazon 리소스 이름(ARN) 식별자.  
필수 항목 여부: 예

## 요청 본문
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
소스 클러스터 스냅샷에서 생성할 새 탄력적 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `elastic-cluster-snapshot-5`   
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이 63.  
필수 항목 여부: 예

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
원본 클러스터 스냅샷의 모든 태그를 대상 탄력적 클러스터 스냅샷으로 복사하려면 `true`로 설정합니다. 기본값은 `false`입니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
암호화된 탄력적 클러스터 스냅샷의 AWS KMS 키 ID입니다. AWS KMS 키 ID는 Amazon 리소스 이름(ARN), AWS KMS 키 식별자 또는 AWS KMS 암호화 키의 AWS KMS 키 별칭입니다.  
 AWS 계정에서 암호화된 탄력적 클러스터 스냅샷을 복사하는 경우의 값을 지정`KmsKeyId`하여 새 AWS S KMS 암호화 키로 복사본을 암호화할 수 있습니다. `KmsKeyId` 값을 지정하지 않으면 탄력적 클러스터 스냅샷의 사본을 원본 탄력적 스냅샷과 동일한 `AWS` KMS 키로 암호화합니다.  
암호화되지 않은 탄력적 클러스터 스냅샷의 복사하고 `KmsKeyId` 파라미터에 대한 값을 지정하려고 시도하면 오류가 반환됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
탄력적 클러스터 스냅샷에 할당할 태그입니다.  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.  
필수 여부: 아니요

## 응답 구문
<a name="API_elastic_CopyClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
특정 탄력적 클러스터 스냅샷에 대한 정보를 반환합니다.  
타입: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 객체

## 오류
<a name="API_elastic_CopyClusterSnapshot_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ServiceQuotaExceededException **   
작업에 대한 서비스 할당량을 초과했습니다.  
HTTP 상태 코드: 402

 ** ThrottlingException **   
요청 조절로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

# CreateCluster
<a name="API_elastic_CreateCluster"></a>

Amazon DocumentDB 탄력적 클러스터를 새로 생성하고 클러스터 구조를 반환합니다.

## Request Syntax
<a name="API_elastic_CreateCluster_RequestSyntax"></a>

```
POST /cluster HTTP/1.1
Content-type: application/json

{
   "adminUserName": "string",
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "clusterName": "string",
   "kmsKeyId": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 요청 파라미터
<a name="API_elastic_CreateCluster_RequestParameters"></a>

요청은 URI 파라미터를 사용하지 않습니다.

## 요청 본문
<a name="API_elastic_CreateCluster_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Amazon DocumentDB 탄력적 클러스터 관리자의 이름.  
 *제약 조건*:  
+ 1\$163자의 문자 또는 숫자여야 합니다.
+ 첫 자는 문자여야 합니다.
+ 예약어가 될 수는 없습니다.
유형: 문자열  
필수 항목 여부: 예

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
Amazon DocumentDB 탄력적 클러스터 관리자의 암호. 암호는 일체의 인쇄 가능한 ASCII 문자를 포함할 수 있습니다.  
 *제약 조건*:  
+ 8자\$1100자여야 합니다.
+ 포워드 슬래시(/), 큰따옴표(“) 또는 “at” 기호(@)를 포함할 수 없습니다.
유형: 문자열  
필수 항목 여부: 예

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
탄력적 클러스터에 액세스하는 데 사용되는 암호를 가져올 위치를 결정하는 데 사용되는 인증 유형입니다. 유효한 형식은 `PLAIN_TEXT` 및 `SECRET_ARN`입니다.  
타입: 문자열  
유효 값: `PLAIN_TEXT | SECRET_ARN`   
필수 사항 여부: 예

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
새 탄력적 클러스터의 이름. 이 파라미터는 소문자 문자열로 저장됩니다.  
 *제약 조건*:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
 *예*: `my-cluster`   
유형: 문자열  
필수 항목 여부: 예

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
각 탄력적 클러스터 샤드에 할당된 vCPU 수 최대 값은 64입니다. 허용되는 값은 2, 4, 8, 16, 32, 64입니다.  
유형: 정수  
필수 항목 여부: 예

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
탄력적 클러스터에 할당된 샤드 수. 최대 값은 32입니다.  
유형: 정수  
필수 항목 여부: 예

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
자동 스냅샷이 보관되는 일수입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
탄력적 클러스터의 클라이언트 토큰.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
새 탄력적 클러스터를 암호화하는 데 사용할 KMS 키 식별자.  
KMS 키 식별자는 KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 이 KMS 암호화 키를 소유하고 있는 동일한 Amazon 계정을 사용하여 클러스터를 생성하는 경우, ARN 대신 KMS 키 별칭을 KMS 암호화 키로 사용할 수 있습니다.  
암호화 키가 지정되지 않은 경우 Amazon DocumentDB는 KMS가 사용자 계정에 대해 생성하는 기본 암호화 키를 사용합니다. 계정에는 Amazon 리전마다 다른 기본 암호화 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위이며, `backupRetentionPeriod` 속성에 의해 결정됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)입니다.  
 *형식*: `ddd:hh24:mi-ddd:hh24:mi`   
 *기본*값: 각에 대해 8시간 블록 시간 중에서 임의로 선택되는 30분 기간으로 AWS 리전, 요일에 무작위로 발생합니다.  
 *유효한 요일*: 월, 화, 수, 목, 금, 토, 일  
 *제약 조건*: 최소 30분의 기간.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
탄력적 클러스터의 모든 샤드에 적용되는 복제본 인스턴스 수입니다. `shardInstanceCount` 값이 1이면 라이터 인스턴스가 하나라는 의미이며, 추가 인스턴스는 읽기에 사용할 수 있고 가용성을 개선하는 복제본입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
새 탄력적 클러스터의 Amazon EC2 서브넷 ID.  
유형: 문자열 배열  
필수 여부: 아니요

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
새 탄력적 클러스터에 할당할 태그.  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.  
필수 여부: 아니요

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
새 탄력적 클러스터에 연결할 EC2 VPC 보안 그룹의 목록.  
유형: 문자열 배열  
필수 항목 여부: 아니요

## 응답 구문
<a name="API_elastic_CreateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_CreateCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
생성된 새 탄력적 클러스터.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_CreateCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ServiceQuotaExceededException **   
작업에 대한 서비스 할당량을 초과했습니다.  
HTTP 상태 코드: 402

 ** ThrottlingException **   
요청 조절로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_CreateCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

# CreateClusterSnapshot
<a name="API_elastic_CreateClusterSnapshot"></a>

탄력적 클러스터의 스냅샷을 생성합니다.

## Request Syntax
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI 요청 파라미터
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

요청은 URI 파라미터를 사용하지 않습니다.

## 요청 본문
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
스냅샷을 생성하려는 탄력적 클러스터의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
새 탄력적 클러스터 스냅샷의 이름.  
유형: 문자열  
길이 제약: 최소 길이 1. 최대 길이 63.  
필수 항목 여부: 예

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
새 탄력적 클러스터 스냅샷에 할당할 태그.  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.  
필수 여부: 아니요

## 응답 구문
<a name="API_elastic_CreateClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
새 탄력적 클러스터 스냅샷에 대한 정보를 반환합니다.  
타입: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 객체

## 오류
<a name="API_elastic_CreateClusterSnapshot_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ServiceQuotaExceededException **   
작업에 대한 서비스 할당량을 초과했습니다.  
HTTP 상태 코드: 402

 ** ThrottlingException **   
요청 조절로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

# DeleteCluster
<a name="API_elastic_DeleteCluster"></a>

탄력적 클러스터를 삭제합니다.

## Request Syntax
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

```
DELETE /cluster/clusterArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
삭제하려는 탄력적 클러스터의 ARN 식별자.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_DeleteCluster_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_DeleteCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
새로 삭제된 탄력적 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_DeleteCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

# DeleteClusterSnapshot
<a name="API_elastic_DeleteClusterSnapshot"></a>

Elastic 클러스터 스냅샷을 삭제합니다.

## Request Syntax
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
삭제할 Elastic 클러스터 스냅샷의 ARN 식별자입니다.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_DeleteClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
새로 삭제된 Elastic 클러스터 스냅샷에 대한 정보를 반환합니다.  
타입: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 객체

## 오류
<a name="API_elastic_DeleteClusterSnapshot_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

# GetCluster
<a name="API_elastic_GetCluster"></a>

특정 탄력적 클러스터에 대한 정보를 반환합니다.

## Request Syntax
<a name="API_elastic_GetCluster_RequestSyntax"></a>

```
GET /cluster/clusterArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_GetCluster_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_GetCluster_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_GetCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_GetCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
특정 탄력적 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_GetCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_GetCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

# GetClusterSnapshot
<a name="API_elastic_GetClusterSnapshot"></a>

특정 탄력적 클러스터 스냅샷에 대한 정보를 반환합니다.

## Request Syntax
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
탄력적 클러스터 스냅샷의 ARN 식별자.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_GetClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
특정 탄력적 클러스터 스냅샷에 대한 정보를 반환합니다.  
타입: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 객체

## 오류
<a name="API_elastic_GetClusterSnapshot_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

# GetPendingMaintenanceAction
<a name="API_elastic_GetPendingMaintenanceAction"></a>

보류 중인 모든 유지 관리 작업을 검색합니다.

## Request Syntax
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

```
GET /pending-action/resourceArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
특정 Amazon 리소스 이름(ARN)에 대해 보류 중인 유지 관리 작업을 검색합니다.  
길이 제약: 최소 길이 1. 최대 길이는 256.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_GetPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## 응답 요소
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.  
타입: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 객체

## 오류
<a name="API_elastic_GetPendingMaintenanceAction_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

# ListClusters
<a name="API_elastic_ListClusters"></a>

프로비저닝된 Amazon DocumentDB 탄력적 클러스터에 대한 정보를 반환합니다.

## Request Syntax
<a name="API_elastic_ListClusters_RequestSyntax"></a>

```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_ListClusters_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
응답에 수신될 최대 탄력적 클러스터 스냅샷 결과의 수.  
유효 범위: 최소값 1. 최댓값은 100입니다.

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 `max-results`에 의해 지정된 값까지의 레코드만 포함됩니다.  
응답에 더 이상 데이터가 없는 경우 `nextToken`은 반환되지 않습니다.

## Request Body
<a name="API_elastic_ListClusters_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 응답 요소
<a name="API_elastic_ListClusters_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Amazon DocumentDB 탄력적 클러스터의 목록.  
타입: [ClusterInList](API_elastic_ClusterInList.md)객체 배열

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 `max-results`에 의해 지정된 값까지의 레코드만 포함됩니다.  
응답에 더 이상 데이터가 없는 경우 `nextToken`은 반환되지 않습니다.  
유형: 문자열

## 오류
<a name="API_elastic_ListClusters_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_ListClusters_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

지정된 탄력적 클러스터의 스냅샷에 대한 정보를 반환합니다.

## Request Syntax
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
응답에 수신될 최대 탄력적 클러스터 스냅샷 결과의 수.  
유효한 범위: 최소값은 20입니다. 최댓값은 100입니다.

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 `max-results`에 의해 지정된 값까지의 레코드만 포함됩니다.  
응답에 더 이상 데이터가 없는 경우 `nextToken`은 반환되지 않습니다.

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.  
+  `automated` - Amazon DocumentDB가 AWS 계정에 대해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다.
+  `manual` - AWS 계정에 대해 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다.

## Request Body
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

## 응답 요소
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
이전의 요청에서 제공된 페이지 매김 토큰. 이 파라미터가 지정된 경우 응답에는 이 토큰을 넘어 `max-results`에 의해 지정된 값까지의 레코드만 포함됩니다.  
응답에 더 이상 데이터가 없는 경우 `nextToken`은 반환되지 않습니다.  
유형: 문자열

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
지정된 탄력적 클러스터의 스냅샷 목록.  
타입: [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 객체 배열

## 오류
<a name="API_elastic_ListClusterSnapshots_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

# ListPendingMaintenanceActions
<a name="API_elastic_ListPendingMaintenanceActions"></a>

보류 중인 모든 유지 관리 작업 목록을 검색합니다.

## Request Syntax
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
응답에 포함되는 최대 결과 수입니다. 지정된 `maxResults` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
유효 범위: 최소값 1. 최댓값은 100입니다.

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `maxResults`에 지정된 값까지의 레코드만 응답에 포함됩니다.

## Request Body
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_ListPendingMaintenanceActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePendingMaintenanceActions": [ 
      { 
         "pendingMaintenanceActionDetails": [ 
            { 
               "action": "string",
               "autoAppliedAfterDate": "string",
               "currentApplyDate": "string",
               "description": "string",
               "forcedApplyDate": "string",
               "optInStatus": "string"
            }
         ],
         "resourceArn": "string"
      }
   ]
}
```

## 응답 요소
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.  
타입: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)객체 배열

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터가 표시된 경우, 마커 이후부터 `maxResults`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

## 오류
<a name="API_elastic_ListPendingMaintenanceActions_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

# ListTagsForResource
<a name="API_elastic_ListTagsForResource"></a>

탄력적 클러스터 리소스의 모든 태그 나열하기

## Request Syntax
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
탄력적 클러스터 리소스의 ARN 식별자.  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 1011입니다.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## 응답 요소
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
지정된 탄력적 클러스터 리소스의 태그 목록.  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.

## 오류
<a name="API_elastic_ListTagsForResource_Errors"></a>

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하세요.

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

스냅샷에서 탄력적 클러스터를 복원합니다.

## Request Syntax
<a name="API_elastic_RestoreClusterFromSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 요청 파라미터
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
탄력적 클러스터 스냅샷의 ARN 식별자.  
필수 항목 여부: 예

## 요청 본문
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Elastic 클러스터의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
새 Amazon DocumentDB Elastic 클러스터 클러스터를 암호화하는 데 사용할 KMS 키 식별자입니다.  
KMS 키 식별자는 KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 이 KMS 암호화 키를 소유하고 있는 동일한 Amazon 계정을 사용하여 클러스터를 생성하는 경우, ARN 대신 KMS 키 별칭을 KMS 암호화 키로 사용할 수 있습니다.  
여기에 암호화 키가 지정되지 않은 경우 Amazon DocumentDB는 KMS가 사용자 계정에 대해 생성하는 기본 암호화 키를 사용합니다. 계정에는 Amazon 리전마다 다른 기본 암호화 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
새로 복원된 탄력적 클러스터의 각 샤드 용량입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
탄력적 클러스터의 모든 샤드에 적용되는 복제본 인스턴스 수입니다. `shardInstanceCount` 값이 1이면 라이터 인스턴스가 하나라는 의미이며, 추가 인스턴스는 읽기에 사용할 수 있고 가용성을 개선하는 복제본입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
탄력적 클러스터의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
키가 태그 이름이고 값이 키 값인 키-값 쌍의 배열 형태로 복원된 Elastic 클러스터에 할당될 태그 이름 목록입니다.  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.  
필수 여부: 아니요

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
이 엘라스틱 클러스터와 연결할 EC2 VPC 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 항목 여부: 아니요

## 응답 구문
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
복원된 Elastic 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_RestoreClusterFromSnapshot_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ServiceQuotaExceededException **   
작업에 대한 서비스 할당량을 초과했습니다.  
HTTP 상태 코드: 402

 ** ThrottlingException **   
요청 조절로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

# StartCluster
<a name="API_elastic_StartCluster"></a>

`clusterARN`에서 지정한 중지된 탄력적 클러스터를 다시 시작합니다.

## Request Syntax
<a name="API_elastic_StartCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/start HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_StartCluster_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_StartCluster_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_StartCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_StartCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
특정 탄력적 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_StartCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_StartCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

# StopCluster
<a name="API_elastic_StopCluster"></a>

`clusterArn`에서 지정한 실행 중인 탄력적 클러스터를 중지합니다. 탄력적 클러스터가 *사용 가능* 상태여야 합니다.

## Request Syntax
<a name="API_elastic_StopCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/stop HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_StopCluster_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
필수 항목 여부: 예

## Request Body
<a name="API_elastic_StopCluster_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_StopCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_StopCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
특정 탄력적 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_StopCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_StopCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

# TagResource
<a name="API_elastic_TagResource"></a>

메타데이터 태그를 엘라스틱 클러스터 리소스에 추가합니다.

## Request Syntax
<a name="API_elastic_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI 요청 파라미터
<a name="API_elastic_TagResource_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
탄력적 클러스터 리소스의 ARN 식별자.  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 1011입니다.  
필수 항목 여부: 예

## 요청 본문
<a name="API_elastic_TagResource_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
엘라스틱 클러스터 리소스에 배정된 태그  
유형: 문자열 간 맵  
키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.  
키 패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256.  
필수 여부: 예

## 응답 구문
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_elastic_TagResource_ResponseElements"></a>

작업이 성공하면 서비스가 비어 있는 HTTP 본문과 함께 HTTP 200 응답을 다시 전송합니다.

## 오류
<a name="API_elastic_TagResource_Errors"></a>

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하세요.

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_TagResource_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

# UntagResource
<a name="API_elastic_UntagResource"></a>

탄력적 클러스터 리소스에서 메타데이터 태그를 제거합니다.

## Request Syntax
<a name="API_elastic_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI 요청 파라미터
<a name="API_elastic_UntagResource_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
탄력적 클러스터 리소스의 ARN 식별자.  
길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 1011입니다.  
필수 항목 여부: 예

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
탄력적 클러스터 리소스에서 제거해야 할 태그 키.  
배열 구성원: 최소수는 0개입니다. 최대수 50개.  
길이 제약: 최소 길이 1. 최대 길이 128.  
패턴: `(?!aws:)[a-zA-Z+-=._:/]+`   
필수 여부: 예

## Request Body
<a name="API_elastic_UntagResource_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_elastic_UntagResource_ResponseElements"></a>

작업이 성공하면 서비스가 비어 있는 HTTP 본문과 함께 HTTP 200 응답을 다시 전송합니다.

## 오류
<a name="API_elastic_UntagResource_Errors"></a>

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하세요.

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_UntagResource_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

엘라스틱 클러스터를 수정합니다. 여기에는 관리자-사용자 이름/암호 업데이트, API 버전 업그레이드, 백업 기간 및 유지 관리 기간 설정이 포함됩니다.

## Request Syntax
<a name="API_elastic_UpdateCluster_RequestSyntax"></a>

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 요청 파라미터
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
필수 항목 여부: 예

## 요청 본문
<a name="API_elastic_UpdateCluster_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
엘라스틱 클러스터 관리자와 관련된 비밀번호. 이 암호에는 슬래시(/), 큰따옴표(") 또는 ‘앳’ 기호(@)를 제외한 인쇄 가능 ASCII 문자가 포함될 수 있습니다.  
 *제약*: 8\$1100자여야 합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
엘라스틱 클러스터에 액세스하는 데 사용되는 암호를 가져올 위치를 결정하는 데 사용되는 인증 유형입니다. 유효한 형식은 `PLAIN_TEXT` 및 `SECRET_ARN`입니다.  
타입: 문자열  
유효 값: `PLAIN_TEXT | SECRET_ARN`   
필수 여부: 아니요

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
자동 스냅샷이 보관되는 일수입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
탄력적 클러스터의 클라이언트 토큰.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위이며, `backupRetentionPeriod` 속성에 의해 결정됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)입니다.  
 *형식*: `ddd:hh24:mi-ddd:hh24:mi`   
 *기본*값: 각에 대해 8시간 블록 시간 중에서 임의로 선택되는 30분 기간으로 AWS 리전, 요일에 무작위로 발생합니다.  
 *유효한 요일*: 월, 화, 수, 목, 금, 토, 일  
 *제약 조건*: 최소 30분의 기간.  
유형: 문자열  
필수 항목 여부: 아니요

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
각 탄력적 클러스터 샤드에 할당된 vCPU 수 최대 값은 64입니다. 허용되는 값은 2, 4, 8, 16, 32, 64입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
탄력적 클러스터에 할당된 샤드 수. 최대 값은 32입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
탄력적 클러스터의 모든 샤드에 적용되는 복제본 인스턴스 수입니다. `shardInstanceCount` 값이 1이면 라이터 인스턴스가 하나라는 의미이며, 추가 인스턴스는 읽기에 사용할 수 있고 가용성을 개선하는 복제본입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
탄력적 클러스터의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
이 엘라스틱 클러스터와 연결할 EC2 VPC 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 항목 여부: 아니요

## 응답 구문
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 응답 요소
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
업데이트된 Elastic 클러스터에 대한 정보를 반환합니다.  
타입: [Cluster](API_elastic_Cluster.md) 객체

## 오류
<a name="API_elastic_UpdateCluster_Errors"></a>

모든 작업에 공통되는 오류에 대한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하십시오.

 ** AccessDeniedException **   
작업을 수행할 권한이 충분하지 않을 때 발생하는 예외.    
 ** message **   
액세스가 거부된 이유를 설명하는 오류 메시지입니다.
HTTP 상태 코드: 403

 ** ConflictException **   
액세스 충돌이 발생했습니다.    
 ** resourceId **   
액세스 충돌이 발생한 리소스의 ID입니다.  
 ** resourceType **   
액세스 충돌이 발생한 리소스의 유형입니다.
HTTP 상태 코드: 409

 ** InternalServerException **   
내부 서버 오류가 발생했습니다.  
HTTP 상태 코드: 500

 ** ResourceNotFoundException **   
지정된 리소스를 찾을 수 없습니다.    
 ** message **   
실패를 설명하는 오류 메시지입니다.  
 ** resourceId **   
찾을 수 없는 리소스의 ID입니다.  
 ** resourceType **   
찾을 수 없는 리소스 유형입니다.
HTTP 상태 코드: 404

 ** ThrottlingException **   
요청 제한으로 인해 요청이 거부되면 ThrottlingException이 발생합니다.    
 ** retryAfterSeconds **   
작업을 재시도하기 전에 대기하는 시간(초)입니다.
HTTP 상태 코드: 429

 ** ValidationException **   
유효성 검사 예외를 정의하는 구조.    
 ** fieldList **   
유효성 검사 예외가 발생한 필드의 목록입니다.  
 ** message **   
유효성 검사 예외를 설명하는 오류 메시지입니다.  
 ** reason **   
검증 예외가 발생한 이유입니다(`unknownOperation`, `cannotParse`, `fieldValidationFailed` 또는 `other` 중 하나).
HTTP 상태 코드: 400

## 참고
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)