

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

# Amazon DocumentDB 클러스터, 인스턴스 및 리소스 관리 API 참조
<a name="api-reference"></a>

이 섹션에서는 HTTP, AWS Command Line Interface (AWS CLI), 또는 AWS SDK를 통해 액세스할 수 있는 Amazon DocumentDB(MongoDB 호환)의 클러스터, 인스턴스 및 리소스 관리 작업에 관해 설명합니다. 이러한 API를 사용하여 클러스터 및 인스턴스를 생성, 삭제 및 수정할 수 있습니다.

 

**중요**  
이 API는 클러스터, 인스턴스 및 관련 리소스를 관리하는 데만 사용됩니다. 실행 중인 Amazon DocumentDB 클러스터에 연결하는 방법에 관한 자세한 내용은 [시작 안내서](get-started-guide.md) 섹션을 참조하세요.

**Topics**
+ [작업](API_Operations.md)
+ [데이터 타입](API_Types.md)
+ [일반적인 오류](CommonErrors.md)
+ [공통 파라미터](CommonParameters.md)

# 작업
<a name="API_Operations"></a>

다음 작업이 Amazon DocumentDB (with MongoDB compatibility)에서 지원됩니다:
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

다음 작업이 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) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Operations_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

다음 작업이 Amazon DocumentDB (with MongoDB compatibility)에서 지원됩니다.
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

기존의 이벤트 알림 구독에 소스 식별자를 추가합니다.

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

 모든 작업에 공통되는 파라미터에 관한 정보는 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** SourceIdentifier **   
추가할 이벤트 소스의 식별자입니다.  
+ 소스 유형이 인스턴스라면 `DBInstanceIdentifier`을 입력해야 합니다.
+ 소스 유형이 보안 그룹이라면 `DBSecurityGroupName`을 제공해야 합니다.
+ 소스 유형이 파라미터 그룹이라면 `DBParameterGroupName`을 제공해야 합니다.
+ 소스 유형이 스냅샷이라면 `DBSnapshotIdentifier`를 입력해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** SubscriptionName **   
소스 식별자를 추가하려는 Amazon DocumentDB 이벤트 알림 구독의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** EventSubscription **   
구독한 이벤트에 대한 세부 정보.  
타입: [EventSubscription](API_EventSubscription.md) 객체

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

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 단원을 참조하십시오.

 ** SourceNotFound **   
요청한 소스를 찾을 수 없습니다.  
HTTP 상태 코드: 404

 ** SubscriptionNotFound **   
구독의 이름이 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

메타데이터 태그를 Amazon DocumentDB 리소스에 추가합니다. 이러한 태그를 비용 할당 보고와 함께 사용하여 Amazon DocumentDB 리소스와 관련된 비용을 추적하거나 Amazon DocumentDB에 대한 AWS Identity and Access Management (IAM) 정책의 `Condition` 명령문에서 비용을 추적할 수 있습니다. Amazon DocumentDB

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** ResourceName **   
태그가 추가된 Amazon DocumentDB 리소스입니다. 이 값은 Amazon 리소스 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Tags.Tag.N**   
Amazon DocumentDB 리소스에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수 항목 여부: 예

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`는 기존 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

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

대기 중인 유지 관리 작업을 리소스(예: Amazon DocumentDB 인스턴스)에 적용합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** ApplyAction **   
이 리소스에 적용할 대기 중인 유지 관리 작업입니다.  
유효값: `system-update`, `db-upgrade`   
유형: 문자열  
필수 항목 여부: 예

 ** OptInType **   
옵트인 요청의 유형을 지정하거나 옵트인 요청을 실행 취소하는 값입니다. `immediate` 유형의 옵트인 요청은 실행 취소할 수 없습니다.  
유효한 값:  
+  `immediate` - 유지 관리 작업을 즉시 적용합니다.
+  `next-maintenance` - 리소스의 다음번 유지 관리 기간 중에 유지 관리 작업을 적용합니다.
+  `undo-opt-in` - 기존의 `next-maintenance` 옵트인 요청을 모두 취소합니다.
유형: 문자열  
필수 항목 여부: 예

 ** ResourceIdentifier **   
대기 중인 유지 관리 작업이 적용되는 리소스의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** ResourcePendingMaintenanceActions **   
[ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction)의 출력을 나타냅니다.  
타입: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 객체

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

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

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** ResourceNotFoundFault **   
지정된 리소스 ID를 찾을 수 없습니다.  
HTTP 상태 코드: 404

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

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

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

지정된 클러스터 파라미터 그룹을 복사합니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** SourceDBClusterParameterGroupIdentifier **   
소스 클러스터 파라미터 그룹의 식별자 또는 Amazon 리소스 이름(ARN)입니다.  
제약 조건:  
+ 유효한 클러스터 파라미터 그룹을 지정해야 합니다.
+ 소스 클러스터 파라미터 그룹이 복사본 AWS 리전 과 동일한에 있는 경우 유효한 파라미터 그룹 식별자, 예를 들어 `my-db-cluster-param-group`또는 유효한 ARN을 지정합니다.
+ 소스 파라미터 그룹이 복사본 AWS 리전 과 다른에 있는 경우 유효한 클러스터 파라미터 그룹 ARN을 지정합니다. 예: `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
유형: 문자열  
필수 항목 여부: 예

 ** TargetDBClusterParameterGroupDescription **   
복사된 클러스터 파라미터 그룹에 대한 설명입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** TargetDBClusterParameterGroupIdentifier **   
복사된 클러스터 파라미터 그룹의 식별자입니다.  
제약 조건:  
+ null이거나, 비워 두거나, 공백을 입력할 수 없습니다.
+ 1\$1255자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-cluster-param-group1`   
유형: 문자열  
필수 항목 여부: 예

 **Tags.Tag.N**   
파라미터 그룹에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** DBClusterParameterGroup **   
클러스터 파라미터 그룹의 상세 정보입니다.  
타입: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 객체

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

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

 ** DBParameterGroupAlreadyExists **   
동일한 이름의 파라미터 그룹이 있습니다.  
HTTP 상태 코드: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`는 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBParameterGroupQuotaExceeded **   
이 요청으로 인해 허용된 파라미터 그룹 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

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

공유된 수동 클러스터 스냅샷에서 클러스터 스냅샷을 복사하려면 `SourceDBClusterSnapshotIdentifier`가 공유된 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이어야 합니다. 동일한 AWS 리전에서는 암호화 여부와 관계없이 공유 DB 클러스터 스냅샷만 복사할 수 있습니다.

복사 작업이 진행 중일 때 이를 취소하려면 해당 클러스터 스냅샷이 *복사* 상태에 있는 동안 `TargetDBClusterSnapshotIdentifier`에 의해 식별된 대상 클러스터 스냅샷을 삭제합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** SourceDBClusterSnapshotIdentifier **   
복사할 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ *사용 가능*한 상태에서 유효한 클러스터 스냅샷을 지정해야 합니다.
+ 소스 클러스터 스냅샷이 복사본 AWS 리전 과 동일한에 있는 경우 유효한 스냅샷 식별자를 지정합니다.
+ 소스 클러스터 스냅샷이 다른에 AWS 리전 있거나 다른 AWS 계정이 소유한 경우 스냅샷 ARN을 지정합니다.
예시: `my-cluster-snapshot1`   
유형: 문자열  
필수 항목 여부: 예

 ** TargetDBClusterSnapshotIdentifier **   
소스 클러스터 스냅샷에서 생성할 새 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-cluster-snapshot2`   
유형: 문자열  
필수 항목 여부: 예

 ** CopyTags **   
원본 클러스터 스냅샷의 모든 태그를 대상 클러스터 스냅샷으로 복사하려면 `true`이고, 그렇지 않으면 `false`입니다. 기본값은 `false`입니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** KmsKeyId **   
암호화된 클러스터 스냅샷의 AWS KMS 키 ID입니다. 키 ID는 AWS KMS Amazon 리소스 이름(ARN), AWS KMS 키 식별자 또는 AWS KMS 암호화 AWS KMS 키의 키 별칭입니다.  
에서 암호화된 클러스터 스냅샷을 복사 AWS 계정하는 경우의 값을 지정`KmsKeyId`하여 새 암호화 AWS KMS 키로 복사본을 암호화할 수 있습니다. 에 값을 지정하지 않으면 클러스터 스냅샷의 `KmsKeyId`사본이 소스 클러스터 스냅샷과 동일한 AWS KMS 키로 암호화됩니다.  
다른에서 공유된 암호화된 클러스터 스냅샷을 복사 AWS 계정하는 경우에 대한 값을 지정해야 합니다`KmsKeyId`.  
암호화된 클러스터 스냅샷을 다른에 복사하려면 대상 리전에서 클러스터 스냅샷의 사본을 암호화하는 데 사용할 AWS KMS 키 ID로 `KmsKeyId`를 AWS 리전설정합니다. AWS KMS 암호화 키는 생성된에 고유 AWS 리전 하며 한 AWS 리전 에서 다른 로 암호화 키를 사용할 수 없습니다 AWS 리전.  
암호화되지 않은 클러스터 스냅샷의 복사하고 `KmsKeyId` 파라미터에 대한 값을 지정하려고 시도하면 오류가 반환됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** PreSignedUrl **   
복사할 소스 클러스터 스냅샷이 포함된의 API 작업에 대한`CopyDBClusterSnapshot` 서명 버전 4 서명 요청이 AWS 리전 포함된 URL입니다. 다른 AWS 리전의 클러스터 스냅샷을 복사할 때는 이 `PreSignedUrl` 파라미터를 사용해야 합니다.  
 AWS SDK 도구 또는를 사용하는 경우 `PreSignedUrl` 수동으로 지정하는 대신를 지정할 수 있습니다`SourceRegion`(또는 `--source-region`의 AWS CLI경우 AWS CLI). `SourceRegion`을 지정하면 소스 AWS 리전에서 실행할 수 있는 작업에 대한 유효한 요청인 미리 서명된 URL이 자동으로 생성됩니다.  
미리 서명된 URL은 복사할 클러스터 스냅샷이 포함된 소스에서 실행할 수 AWS 리전 있는 `CopyDBClusterSnapshot` API 작업에 대한 유효한 요청이어야 합니다. 미리 서명된 URL 요청은 다음 파라미터 값을 포함해야 합니다.  
+  `SourceRegion`- 복사할 스냅샷이 포함된 지역의 ID.
+  `SourceDBClusterSnapshotIdentifier` – 복사할 암호화된 클러스터 스냅샷의 식별자입니다. 이 식별자는 소스 AWS 리전용 Amazon 리소스 이름(ARN) 형식이어야 합니다. 예를 들어, 암호화된 클러스터 스냅샷을 us-east-1 AWS 리전에서 복사하는 경우, `SourceDBClusterSnapshotIdentifier`는 다음과 같이 보입니다: `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+  `TargetDBClusterSnapshotIdentifier` – 생성할 새 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
새 클러스터 스냅샷에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterSnapshot **   
클러스터 스냅샷에 대한 세부 정보입니다.  
타입: [DBClusterSnapshot](API_DBClusterSnapshot.md) 객체

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

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

 ** DBClusterSnapshotAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터 스냅샷이 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`은 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** KMSKeyNotAccessibleFault **   
 AWS KMS 키에 액세스할 때 오류가 발생했습니다.  
HTTP 상태 코드: 400

 ** SnapshotQuotaExceeded **   
요청으로 인해 허용된 스냅샷 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

새 Amazon DocumentDB 클러스터를 생성합니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** DBClusterIdentifier **   
클러스터 식별자입니다. 이 파라미터는 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-cluster`   
유형: 문자열  
필수 항목 여부: 예

 ** Engine **   
이 클러스터에 사용할 데이터베이스 엔진의 이름입니다.  
유효한 값: `docdb`   
유형: 문자열  
필수 항목 여부: 예

 **AvailabilityZones.AvailabilityZone.N**   
클러스터의 인스턴스를 생성할 수 있는 Amazon EC2 가용 영역의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** BackupRetentionPeriod **   
자동 백업이 보존되는 일수입니다. 1 이상의 값을 지정해야 합니다.  
기본값: 1  
제약 조건:  
+ 1\$135의 값이어야 합니다.
유형: 정수  
필수 항목 여부: 아니요

 ** DBClusterParameterGroupName **   
이 클러스터와 연결할 클러스터 파라미터 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** DBSubnetGroupName **   
이 클러스터와 연결할 서브넷 그룹입니다.  
제약: 기존의 `DBSubnetGroup` 이름과 일치해야 합니다. 기본값이 아니어야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. `DeletionProtection`이 활성화되면 클러스터를 수정하고 `DeletionProtection` 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. `DeletionProtection`은 클러스터가 실수로 삭제되지 않도록 보호합니다.  
유형: 부울  
필수 항목 여부: 아니요

 **EnableCloudwatchLogsExports.member.N**   
Amazon CloudWatch Logs로 내보내기에 대해 활성화해야 하는 로그 유형의 목록입니다. 감사 로그 또는 프로파일러 로그를 활성화할 수 있습니다. 자세한 내용은 [Amazon DocumentDB 이벤트 감사](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) 및 [Amazon DocumentDB 작업 프로파일링](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html)을 참조하십시오.  
유형: 문자열 배열  
필수 여부: 아니요

 ** EngineVersion **   
사용할 데이터베이스 엔진의 버전 번호입니다. `--engine-version`은 기본적으로 최신 주요 엔진 버전으로 설정됩니다. 프로덕션 워크로드의 경우 이 파라미터를 의도한 주요 엔진 버전으로 명시적으로 선언하는 것이 좋습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** GlobalClusterIdentifier **   
새 글로벌 클러스터의 클러스터 식별자입니다.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 아니요

 ** KmsKeyId **   
암호화된 클러스터의 AWS KMS 키 식별자입니다.  
 AWS KMS 키 식별자는 AWS KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 새 클러스터를 암호화하는 데 사용되는 AWS KMS 암호화 키를 소유 AWS 계정 한 동일한를 사용하여 클러스터를 생성하는 경우 AWS KMS 암호화 AWS KMS 키에 ARN 대신 키 별칭을 사용할 수 있습니다.  
`KmsKeyId`에 암호화 키가 지정되어 있지 않은 경우:   
+ `StorageEncrypted` 파라미터가 `true`인 경우 Amazon DocumentDB는 기본 암호화 키를 사용합니다.
 AWS KMS 는에 대한 기본 암호화 키를 생성합니다 AWS 계정. AWS 계정 에는 각각 다른 기본 암호화 키가 있습니다 AWS 리전.  
유형: 문자열  
필수 항목 여부: 아니요

 ** ManageMasterUserPassword **   
Amazon Web Services Secrets Manager를 사용하여 마스터 사용자 암호를 관리할지 여부를 지정합니다.  
제약 조건: `MasterUserPassword`가 지정된 경우 Amazon Web Services Secrets Manager로 마스터 사용자 암호를 관리할 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** MasterUsername **   
클러스터의 마스터 사용자 이름입니다.  
제약 조건:  
+ 1\$163자의 문자 또는 숫자여야 합니다.
+ 첫 자는 문자여야 합니다.
+ 선택한 데이터베이스 엔진의 예약어는 사용할 수 없습니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** MasterUserPassword **   
마스터 데이터베이스 사용자의 암호입니다. 이 암호에는 슬래시(/), 큰따옴표(") 또는 ‘앳’ 기호(@)를 제외한 인쇄 가능 ASCII 문자가 포함될 수 있습니다.  
제약: 8\$1100자여야 합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MasterUserSecretKmsKeyId **   
Amazon Web Services Secrets Manager에서 자동으로 생성되고 관리되는 보안 암호를 암호화하기 위한 Amazon Web Services KMS 키 식별자입니다. 이 설정은 DB 클러스터용 Amazon Web Services Secrets Manager의 Amazon DocumentDB에서 마스터 사용자 암호를 관리하는 경우에만 유효합니다.  
Amazon Web Services KMS 키 식별자는 KMS 키의 키 ARN, 키 ID, 별칭 ARN 또는 별칭 이름입니다. 다른 Amazon Web Services 계정에서 KMS 키를 사용하려면 키 ARN 또는 별칭 ARN을 지정하세요.  
`MasterUserSecretKmsKeyId`를 지정하지 않으면 `aws/secretsmanager` KMS 키가 보안 암호를 암호화하는 데 사용됩니다. 보안 암호가 다른 Amazon Web Services 계정에 있는 경우 `aws/secretsmanager` KMS 키를 사용하여 보안 암호를 보안 암호화할 수 없으며 고객 관리형 KMS 키를 사용해야 합니다.  
Amazon Web Services 계정에 대한 기본 KMS 키가 있습니다. Amazon Web Services 계정에는 Amazon Web Services 리전마다 다른 기본 KMS 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** NetworkType **   
클러스터의 네트워크 유형입니다.  
네트워크 유형은 클러스터에 대해 지정된 `DBSubnetGroup`에 의해 결정됩니다. `DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(`DUAL`)만 지원할 수 있습니다.  
자세한 내용은 Amazon DocumentDB 개발자 안내서의 [VPC의 DocumentDB 클러스터](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)를 참조하세요.  
유효한 값: `IPV4` \$1 `DUAL`   
유형: 문자열  
필수 항목 여부: 아니요

 ** Port **   
클러스터의 인스턴스가 연결을 허용하는 포트 번호입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** PreferredBackupWindow **   
`BackupRetentionPeriod` 파라미터를 사용하여 자동 백업을 활성화한 경우, 자동 백업이 생성되는 일일 시간 범위입니다.  
기본값은 각각에 대해 8시간 블록 시간 중에서 임의로 선택한 30분 기간입니다 AWS 리전.  
제약 조건:  
+ `hh24:mi-hh24:mi` 형식이어야 합니다.
+ 협정 세계시(UTC)여야 합니다.
+ 원하는 유지 관리 기간과 충돌하지 않아야 합니다.
+ 30분 이상이어야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

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

 ** PreSignedUrl **   
현재 지원되지 않습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 클러스터의 규모 조정 구성을 포함합니다.  
유형: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)객체  
필수 여부: 아니요

 ** StorageEncrypted **   
클러스터의 암호화 여부를 지정합니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** StorageType **   
DB 클러스터와 연결할 스토리지 유형입니다.  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
스토리지 유형이 `iopt1`로 설정된 Amazon DocumentDB 클러스터를 생성하면 스토리지 유형이 응답에 반환됩니다. 스토리지 유형을 `standard`로 설정하면 스토리지 유형이 반환되지 않습니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
클러스터에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
이 클러스터와 연결할 EC2 VPC 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`는 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName`는 기존 클러스터 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterQuotaExceededFault **   
클러스터의 최대 허용 할당량에 도달했기 때문에 클러스터를 생성할 수 없습니다.  
HTTP 상태 코드: 403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
가용 영역이 하나뿐인 경우를 제외하고, 서브넷 그룹의 서브넷은 최소한 두 개의 가용 영역을 포함해야 합니다.  
HTTP 상태 코드: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`은 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InsufficientStorageClusterCapacity **   
현재의 작업에 사용할 스토리지가 부족합니다. 사용 가능한 스토리지가 더 많은 다른 가용 영역을 사용하도록 서브넷 그룹을 업데이트하여 이 오류를 해결할 수 있습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBSubnetGroupStateFault **   
서브넷 그룹이 사용 중이므로 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** KMSKeyNotAccessibleFault **   
 AWS KMS 키에 액세스할 때 오류가 발생했습니다.  
HTTP 상태 코드: 400

 ** NetworkTypeNotSupported **   
네트워크 유형은 `DBSubnetGroup` 또는 DB 엔진 버전에서 지원되지 않습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

새 클러스터 파라미터 그룹을 생성합니다.

클러스터 파라미터 그룹의 파라미터는 클러스터의 모든 인스턴스에 적용됩니다.

처음에 클러스터 파라미터 그룹은 클러스터의 인스턴스에서 사용하는 데이터베이스 엔진의 기본 파라미터로 생성됩니다. Amazon DocumentDB에서는 `default.docdb3.6` 클러스터 파라미터 그룹을 직접 수정할 수 없습니다. Amazon DocumentDB 클러스터가 기본 클러스터 파라미터 그룹을 사용하고 있고 이 그룹의 값을 수정하려면 먼저 [새 파라미터 그룹을 생성](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html)하거나 [기존 파라미터 그룹을 복사](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html)하여 수정한 다음 수정된 파라미터 그룹을 클러스터에 적용해야 합니다. 새 클러스터 파라미터 그룹 및 연결된 설정을 적용하려면 장애 조치 없이 클러스터의 인스턴스를 재부팅해야 합니다. 자세한 내용은 [Amazon DocumentDB 클러스터 파라미터 그룹 수정](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html)을 참조하세요.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
클러스터 파라미터 그룹의 이름입니다.  
제약 조건:  
+ 기존의 `DBClusterParameterGroup` 이름과 일치할 수 없습니다.
이 값은 소문자 문자열로 저장됩니다.
유형: 문자열  
필수 항목 여부: 예

 ** DBParameterGroupFamily **   
클러스터 파라미터 그룹 패밀리의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** Description **   
클러스터 파라미터 그룹에 대한 설명입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Tags.Tag.N**   
클러스터 파라미터 그룹에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** DBClusterParameterGroup **   
클러스터 파라미터 그룹의 상세 정보입니다.  
타입: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 객체

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

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

 ** DBParameterGroupAlreadyExists **   
동일한 이름의 파라미터 그룹이 있습니다.  
HTTP 상태 코드: 400

 ** DBParameterGroupQuotaExceeded **   
이 요청으로 인해 허용된 파라미터 그룹 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

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

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
스냅샷을 만들 클러스터의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 `DBCluster`의 식별자와 일치해야 합니다.
예시: `my-cluster`   
유형: 문자열  
필수 항목 여부: 예

 ** DBClusterSnapshotIdentifier **   
클러스터 스냅샷의 식별자입니다. 이 파라미터는 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-cluster-snapshot1`   
유형: 문자열  
필수 항목 여부: 예

 **Tags.Tag.N**   
새 클러스터 스냅샷에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterSnapshot **   
클러스터 스냅샷에 대한 세부 정보입니다.  
타입: [DBClusterSnapshot](API_DBClusterSnapshot.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터 스냅샷이 이미 있습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** SnapshotQuotaExceeded **   
요청으로 인해 허용된 스냅샷 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

새 인스턴스를 생성합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
인스턴스가 속하게 될 클러스터의 식별자입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** DBInstanceClass **   
인스턴스의 컴퓨팅 및 메모리 용량입니다(예: `db.r5.large`).  
유형: 문자열  
필수 항목 여부: 예

 ** DBInstanceIdentifier **   
인스턴스 식별자입니다. 이 파라미터는 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `mydbinstance`   
유형: 문자열  
필수 항목 여부: 예

 ** Engine **   
이 인스턴스에서 사용되는 데이터베이스 엔진의 이름입니다.  
유효한 값: `docdb`   
유형: 문자열  
필수 항목 여부: 예

 ** AutoMinorVersionUpgrade **   
이 파라미터는 Amazon DocumentDB에는 적용되지 않습니다. Amazon DocumentDB는 값 세트에 관계없이 마이너 버전 업그레이드를 수행하지 않습니다.  
기본값: `false`   
유형: 부울  
필수 항목 여부: 아니요

 ** AvailabilityZone **   
인스턴스가 생성된 Amazon EC2 가용 영역입니다.  
기본값: 엔드포인트의 시스템에서 선택한 무작위 가용 영역입니다 AWS 리전.  
예시: `us-east-1d`   
유형: 문자열  
필수 항목 여부: 아니요

 ** CACertificateIdentifier **   
DB 인스턴스의 서버 인증서에 사용할 CA 인증서 식별자입니다.  
자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 [Amazon DocumentDB TLS 인증서 업데이트](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) 및 [전송 중 데이터 암호화](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)를 참조하십시오.  
유형: 문자열  
필수 항목 여부: 아니요

 ** CopyTagsToSnapshot **   
태그를 DB 인스턴스에서 DB 인스턴스의 스냅샷으로 복사할지 여부를 나타내는 값입니다. 태그는 기본적으로 복사되지 않습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** EnablePerformanceInsights **   
DB 인스턴스에 Performance Insights를 활성화할지 여부를 나타내는 값입니다. 자세한 내용은 [Amazon 성능 개선 도우미 사용](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)을 참조하세요.  
유형: 부울  
필수 항목 여부: 아니요

 ** PerformanceInsightsKMSKeyId **   
성능 개선 도우미 데이터의 암호화를 위한 AWS KMS 키 식별자입니다.  
 AWS KMS 키 식별자는 KMS 키의 키 ARN, 키 ID, 별칭 ARN 또는 별칭 이름입니다.  
PerformanceInsightsKMSKeyId에 대한 값을 지정하지 않으면 Amazon DocumentDB에서는 기본 KMS 키를 사용합니다. Amazon Web Services 계정에 대한 기본 KMS 키가 있습니다. Amazon Web Services 계정에는 Amazon Web Services 리전마다 다른 기본 KMS 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

 ** PromotionTier **   
기존 기본 인스턴스에 결함이 발생한 후 Amazon DocumentDB 복제본을 기본 인스턴스로 승격할 순서를 지정하는 값  
기본값: 1  
유효한 값: 0\$115  
유형: 정수  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
인스턴스에 할당할 태그입니다. 하나의 인스턴스에 최대 10개의 태그를 할당할 수 있습니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBInstance **   
인스턴스에 대한 자세한 정보입니다.  
타입: [DBInstance](API_DBInstance.md) 객체

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

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

 ** AuthorizationNotFound **   
지정한 CIDR IP 또는 Amazon EC2 보안 그룹에 대해 지정한 보안 그룹에 대한 권한이 없습니다.  
Amazon DocumentDB는 또한 IAM을 사용하여 사용자를 대신하여 필요한 작업을 수행할 권한이 없을 수도 있습니다.  
HTTP 상태 코드: 404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBInstanceAlreadyExists **   
해당 식별자를 사용하는 인스턴스가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`는 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName`는 기존 보안 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
가용 영역이 하나뿐인 경우를 제외하고, 서브넷 그룹의 서브넷은 최소한 두 개의 가용 영역을 포함해야 합니다.  
HTTP 상태 코드: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`은 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InstanceQuotaExceeded **   
요청으로 인해 허용된 인스턴스 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** InsufficientDBInstanceCapacity **   
지정한 인스턴스 클래스를 지정한 가용성 영역에서 사용할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** KMSKeyNotAccessibleFault **   
 AWS KMS 키에 액세스할 때 오류가 발생했습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** StorageTypeNotSupported **   
지정된 `StorageType`을 이 DB 인스턴스와 연결할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

새 서브넷 그룹을 생성합니다. 서브넷 그룹은 AWS 리전의 두 개 이상의 가용성 영역에 하나 이상의 서브넷을 포함해야 합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBSubnetGroupDescription **   
서브넷 그룹에 대한 설명입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** DBSubnetGroupName **   
서브넷 그룹의 이름입니다. 이 값은 소문자 문자열로 저장됩니다.  
제약: 255자 이하의 문자, 숫자, 마침표, 밑줄, 공백 또는 하이픈만 포함해야 합니다. 기본값이 아니어야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 예

 **SubnetIds.SubnetIdentifier.N**   
서브넷 그룹의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 항목 여부: 예

 **Tags.Tag.N**   
서브넷 그룹에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBSubnetGroup **   
서브넷 그룹에 대한 자세한 정보.  
타입: [DBSubnetGroup](API_DBSubnetGroup.md) 객체

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

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

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName`은 기존 서브넷 그룹에서 이미 사용하고 있습니다.  
HTTP 상태 코드: 400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
가용 영역이 하나뿐인 경우를 제외하고 서브넷 그룹의 서브넷은 두 개 이상의 가용 영역을 포함해야 합니다.  
HTTP 상태 코드: 400

 ** DBSubnetGroupQuotaExceeded **   
요청 시 허용되는 서브넷 그룹의 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** DBSubnetQuotaExceededFault **   
요청 시 서브넷 그룹의 허용된 서브넷의 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

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

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

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

Amazon DocumentDB 이벤트 알림 구독 생성 이 작업을 하려면 Amazon DocumentDB 콘솔, Amazon SNS 콘솔 또는 Amazon SNS API를 사용해 생성한 주제 Amazon 리소스 이름(ARN)이 필요합니다. Amazon SNS를 통해 ARN을 받으려면 Amazon SNS에서 주제를 생성하고 그 주제를 구독해야 합니다. ARN이 Amazon SNS 콘솔에 표시됩니다.

알림 메시지를 받고 싶은 소스 유형과 이벤트를 트리거링하는 소스(`SourceType`)를 지정할 수 있습니다. 또한 이벤트를 트리거하는 Amazon DocumentDB 소스 목록(`SourceIds`)을 제공하고 알림을 받고자 하는 이벤트의 이벤트 카테고리 목록(`EventCategories`)을 제공할 수 있습니다. 예를 들어, `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` 및 `EventCategories = Availability, Backup`을 지정할 수 있습니다.

`SourceType`및 `SourceIds` (예: `SourceType = db-instance` 및`SourceIdentifier = myDBInstance1`)를 모두 지정하면 지정된 소스의 모든 `db-instance` 이벤트에 대한 알림을 받게 됩니다. 하지만 `SourceType`을 지정하지만 `SourceIdentifier`를 지정하지 않으면 모든 Amazon DocumentDB 소스에 대한 소스 유형의 이벤트만 알림 메시지로 받게 됩니다. `SourceType` 또는 `SourceIdentifier`를 둘 다 지정하지 않으면 고객 계정에 속하는 모든 Amazon DocumentDB 소스에서 발생하는 이벤트의 알림을 받게 됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** SnsTopicArn **   
이벤트 알림을 위해 생성한 SNS 주제의 Amazon 리소스 이름(ARN)입니다. Amazon SNS는 주제를 생성하고 구독할 때 ARN을 생성합니다.  
유형: 문자열  
필수 항목 여부: 예

 ** SubscriptionName **   
구독의 이름.  
제약: 이름은 255자 미만이어야 합니다.  
유형: 문자열  
필수 항목 여부: 예

 ** Enabled **   
 부울 값입니다. 구독을 활성화하려면 `true`로 설정하고, 구독을 생성만 하고 활성화하지 않으려면 `false`로 설정합니다.  
유형: 부울  
필수 항목 여부: 아니요

 **EventCategories.EventCategory.N**   
 구독할 `SourceType`의 이벤트 범주 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 **SourceIds.SourceId.N**   
반환되는 이벤트에 대한 이벤트 소스 식별자 목록입니다. 지정하지 않으면 모든 소스가 응답에 포함됩니다. 식별자는 문자로 시작해야 하고, ASCII 문자, 숫자 및 하이픈만 포함할 수 있으며, 하이픈으로 끝나거나 하이픈을 연속으로 두 개 사용하면 안 됩니다.  
제약 조건:  
+ `SourceIds`이 제공된 경우 `SourceType`도 제공해야 합니다.
+ 소스 유형이 인스턴스라면 `DBInstanceIdentifier`을 제공해야 합니다.
+ 소스 유형이 보안 그룹이라면 `DBSecurityGroupName`을 제공해야 합니다.
+ 소스 유형이 파라미터 그룹이라면 `DBParameterGroupName`을 제공해야 합니다.
+ 소스 유형이 스냅샷이라면 `DBSnapshotIdentifier`을 제공해야 합니다.
유형: 문자열 배열  
필수 여부: 아니요

 ** SourceType **   
이벤트가 발생하는 소스의 유형입니다. 예를 들어, 인스턴스에서 생성되는 이벤트에 대한 알림을 받으려면 이 파라미터를 `db-instance`로 설정합니다. 이 값을 지정하지 않으면 모든 이벤트가 반환됩니다.  
유효한 값: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`   
유형: 문자열  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
이벤트 구독에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** EventSubscription **   
구독한 이벤트에 대한 세부 정보.  
타입: [EventSubscription](API_EventSubscription.md) 객체

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

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 단원을 참조하십시오.

 ** EventSubscriptionQuotaExceeded **   
최대 이벤트 구독 수에 도달했습니다.  
HTTP 상태 코드: 400

 ** SNSInvalidTopic **   
Amazon SNS에서 지정된 주제에 문제가 있다고 응답했습니다.  
HTTP 상태 코드: 400

 ** SNSNoAuthorization **   
SNS 주제 Amazon 리소스 이름(ARN) 에 게시할 권한이 없습니다.  
HTTP 상태 코드: 400

 ** SNSTopicArnNotFound **   
SNS 주제 Amazon 리소스 이름(ARN)이 존재하지 않습니다   
HTTP 상태 코드: 404

 ** SourceNotFound **   
요청한 소스를 찾을 수 없습니다.  
HTTP 상태 코드: 404

 ** SubscriptionAlreadyExist **   
입력한 구독 이름이 이미 존재합니다.  
HTTP 상태 코드: 400

 ** SubscriptionCategoryNotFound **   
제공된 범주가 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

여러 개의 AWS 리전에 걸쳐 있는 Amazon DocumentDB 글로벌 클러스터를 생성합니다. 글로벌 클러스터에는 읽기-쓰기 기능이 있는 기본 클러스터 1개와 읽기 전용 보조 클러스터 최대 10개가 포함되어 있습니다. 글로벌 클러스터는 워크로드 성능에 영향을 주지 않는 전용 인프라를 사용하여 지연 시간이 1초 미만인 리전 간에 스토리지 기반의 고속 복제를 사용합니다.



처음에 비어 있는 글로벌 클러스터를 생성한 다음 기본 클러스터와 보조 클러스터를 추가할 수 있습니다. 또는 생성 작업 중에 기존 클러스터를 지정할 수 있으며, 그러면 이 클러스터가 글로벌 클러스터의 기본 클러스터가 됩니다.

**참고**  
이 작업은 Amazon DocumentDB 클러스터에만 적용됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** GlobalClusterIdentifier **   
새 글로벌 클러스터의 클러스터 식별자.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

 ** DatabaseName **   
영숫자 문자 최대 64자로 된 데이터베이스의 이름입니다. 이름을 입력하지 않으면 Amazon DocumentDB는 생성 중인 글로벌 클러스터에 데이터베이스를 생성하지 않습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
새 글로벌 클러스터에 대한 삭제 보호 설정. 삭제 방지 기능이 활성화되면 글로벌 클러스터가 삭제될 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Engine **   
이 클러스터에 사용할 데이터베이스 엔진의 이름.  
유형: 문자열  
필수 항목 여부: 아니요

 ** EngineVersion **   
글로벌 클러스터의 엔진 버전.  
유형: 문자열  
필수 항목 여부: 아니요

 ** SourceDBClusterIdentifier **   
글로벌 클러스터의 기본 클러스터로 사용할 Amazon 리소스 이름(ARN). 이 파라미터는 선택 사항입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** StorageEncrypted **   
새 글로벌 클러스터에 대한 스토리지 암호화 설정입니다.  
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** GlobalClusterAlreadyExistsFault **   
`GlobalClusterIdentifier`이 이미 존재합니다. 새 글로벌 클러스터 식별자(고유 이름)를 선택하여 새 글로벌 클러스터를 생성합니다.  
HTTP 상태 코드: 400

 ** GlobalClusterQuotaExceededFault **   
이 계정의 글로벌 클러스터 수가 이미 허용된 최대치에 도달했습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

이전에 프로비저닝된 클러스터를 삭제합니다. 클러스터를 삭제하면 해당 클러스터의 자동 백업도 모두 삭제되며 복구할 수 없습니다. 지정한 클러스터의 수동 DB 클러스터 스냅샷은 삭제되지 않습니다.



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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
삭제할 클러스터의 클러스터 식별자. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 `DBClusterIdentifier`과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** FinalDBSnapshotIdentifier **   
 `SkipFinalSnapshot`이 `false`로 설정된 경우 생성되는 새 클러스터 스냅샷의 클러스터 스냅샷 식별자.  
 이 파라미터를 지정하고 또한 `SkipFinalShapshot` 파라미터를 `true`로 설정하면 오류가 발생합니다.
제약 조건:  
+ 1\$1255개의 문자, 숫자 또는 하이픈을 사용해야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** SkipFinalSnapshot **   
 클러스터를 삭제하기 전에 최종 클러스터 스냅샷을 생성할지 여부를 결정합니다. `true`로 지정된 경우 클러스터 스냅샷이 생성되지 않습니다. `false`로 지정된 경우 DB 클러스터가 삭제되기 전에 클러스터 스냅샷이 생성됩니다.  
`SkipFinalSnapshot`이 `false`이면 `FinalDBSnapshotIdentifier` 파라미터를 지정해야 합니다.
기본값: `false`   
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterSnapshotAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터 스냅샷이 이미 있습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** SnapshotQuotaExceeded **   
요청으로 인해 허용된 스냅샷 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

지정된 클러스터 파라미터 그룹을 삭제합니다. 삭제할 클러스터 파라미터 그룹은 어떤 클러스터와도 연결할 수 없습니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
클러스터 파라미터 그룹의 이름입니다.  
제약 조건:  
+ 기존 클러스터 파라미터 그룹의 이름이어야 합니다.
+ 기본 클러스터 파라미터 그룹은 삭제할 수 없습니다.
+ 어떤 클러스터와도 연결할 수 없습니다.
유형: 문자열  
필수 항목 여부: 예

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBParameterGroupState **   
파라미터 그룹이 사용 중이거나 유효하지 않은 상태입니다. 파라미터 그룹을 삭제하려는 경우 파라미터 그룹이 이 상태일 때는 삭제할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

클러스터 스냅샷을 삭제합니다. 스냅샷을 복사 중인 경우, 복사 작업이 종료됩니다.

**참고**  
클러스터 스냅샷을 삭제하려면 `available` 상태여야 합니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** DBClusterSnapshotIdentifier **   
삭제할 클러스터 스냅샷의 식별자입니다.  
제약: `available` 상태인 기존 클러스터 스냅샷의 이름이어야 합니다.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterSnapshot **   
클러스터 스냅샷에 대한 세부 정보입니다.  
타입: [DBClusterSnapshot](API_DBClusterSnapshot.md) 객체

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`은 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

이전에 프로비전된 인스턴스를 삭제합니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** DBInstanceIdentifier **   
삭제할 인스턴스의 인스턴스 식별자입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 인스턴스의 이름과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBInstance **   
인스턴스에 대한 자세한 정보입니다.  
타입: [DBInstance](API_DBInstance.md) 객체

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier`는 기존 스냅샷에서 이미 사용 중입니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** SnapshotQuotaExceeded **   
요청으로 인해 허용된 스냅샷 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

서브넷 그룹을 삭제합니다.

**참고**  
지정된 데이터베이스 서브넷 그룹은 어떤 DB 인스턴스와도 연결되어 있으면 안 됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBSubnetGroupName **   
삭제할 데이터베이스 서브넷 그룹의 이름입니다.  
기본 서브넷 그룹은 삭제할 수 없습니다.
제약 조건:  
기존의 `DBSubnetGroup` 이름과 일치해야 합니다. 기본값이 아니어야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 예

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

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

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`은 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBSubnetGroupStateFault **   
서브넷 그룹이 사용 중이므로 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidDBSubnetStateFault **   
 서브넷이 *사용 가능한* 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

Amazon DocumentDB 이벤트 알림 구독을 삭제합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** SubscriptionName **   
삭제할 Amazon DocumentDB 이벤트 알림 구독의 이름.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** EventSubscription **   
구독한 이벤트에 대한 세부 정보.  
타입: [EventSubscription](API_EventSubscription.md) 객체

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

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

 ** InvalidEventSubscriptionState **   
다른 사람이 구독을 수정하고 있을 수 있습니다. 몇 초 기다린 후 다시 시도하십시오.  
HTTP 상태 코드: 400

 ** SubscriptionNotFound **   
구독의 이름이 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

글로벌 클러스터를 삭제합니다. 글로벌 클러스터를 삭제하려면 먼저 기본 및 보조 클러스터를 분리하거나 삭제해야 합니다.

**참고**  
이 작업은 Amazon DocumentDB 클러스터에만 적용됩니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** GlobalClusterIdentifier **   
삭제되는 글로벌 클러스터의 클러스터 식별자입니다.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

이에 대해 Amazon DocumentDB에서 제공한 인증 기관 (CA) 인증서 목록을 반환합니다. AWS 계정

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하세요.

 ** CertificateIdentifier **   
사용자 제공 인증서 식별자. 이 파라미터를 지정하면 지정된 인증서에 대한 정보만 반환됩니다. 이 파라미터가 누락되면 최대 `MaxRecords` 인증서 목록이 반환됩니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건  
+ 기존 것과 일치해야 합니다. `CertificateIdentifier` 
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 `DescribeCertificates` 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 마커라고 부르는 페이지 매김 토큰을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약 조건:  
+ 최소: 20
+ 최대: 100
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **Certificates.Certificate.N**   
이 AWS 계정에 대한 인증서 목록.  
타입: [Certificate](API_Certificate.md)객체 배열

 ** Marker **   
검색된 레코드 수가 다음보다 큰 경우 제공되는 선택적 페이지 매김 토큰. `MaxRecords` 이 파라미터가 지정되면 마커가 목록의 다음 레코드를 지정합니다. 다음 호출 `DescribeCertificates` 결과에 `Marker` 의 값을 포함하면 인증서의 다음 페이지로 이동합니다.  
유형: 문자열

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

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

 ** CertificateNotFound **   
 `CertificateIdentifier`는 기존 인증서를 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

`DBClusterParameterGroup` 설명 목록을 반환합니다. `DBClusterParameterGroupName` 파라미터가 지정된 경우, 목록에는 지정된 클러스터 파라미터 그룹에 대한 설명만 포함됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
세부 정보를 반환할 특정 클러스터 파라미터 그룹의 이름.  
제약 조건:  
+ 제공된 경우 기존 `DBClusterParameterGroup`의 이름과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBClusterParameterGroups.DBClusterParameterGroup.N**   
클러스터 파라미터 그룹의 목록.  
타입: [DBClusterParameterGroup](API_DBClusterParameterGroup.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

특정 클러스터 파라미터 그룹에 대한 세부 파라미터 목록을 반환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
파라미터의 세부 정보를 반환할 특정 클러스터 파라미터 그룹의 이름.  
제약 조건:  
+ 제공된 경우 기존 `DBClusterParameterGroup`의 이름과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** Source **   
 특정 소스의 파라미터만 반환됨을 나타내는 값입니다. 파라미터 소스는 `engine`, `service` 또는 `customer`가 될 수 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

 **Parameters.Parameter.N**   
클러스터 파라미터 그룹의 파라미터 목록을 제공합니다.  
타입: [Parameter](API_Parameter.md) 객체 배열

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

프로비저닝된 Amazon DocumentDB 클러스터에 대한 정보를 반환합니다. 이 API 작업은 페이지 매김을 지원합니다. 클러스터 및 인스턴스 수명 주기 관리와 같은 특정 관리 기능의 경우 Amazon DocumentDB는 Amazon RDS 및 Amazon Neptune과 공유되는 운영 기술을 활용합니다. `filterName=engine,Values=docdb` 필터 파라미터를 사용하면 Amazon DocumentDB 클러스터만 반환할 수 있습니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
사용자가 제공한 클러스터 식별자. 이 파라미터를 지정한 경우 바로 그 클러스터에서 온 정보만 반환됩니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 제공된 경우 기존 `DBClusterIdentifier`과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
설명할 클러스터를 하나 이상 지정하는 필터.  
지원되는 필터:  
+  `db-cluster-id` - 클러스터 식별자 및 클러스터의 Amazon 리소스 이름(ARN)을 사용할 수 있습니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터에 대한 정보만 포함됩니다.
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBClusters.DBCluster.N**   
클러스터의 목록.  
타입: [DBCluster](API_DBCluster.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

수동 DB 클러스터 스냅샷의 클러스터 스냅샷 속성 이름 및 값 목록을 반환합니다.

스냅샷을 다른와 공유하면 AWS 계정는 수동 클러스터 스냅샷을 복사하거나 복원할 권한이 AWS 계정 있는의 `restore` 속성과 IDs 목록을 `DescribeDBClusterSnapshotAttributes` 반환합니다. `all`이 `restore` 특성에 대한 값 목록에 포함된 경우 수동 클러스터 스냅샷은 공용이며 모든 AWS 계정에 의해 복사 또는 복원될 수 있습니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterSnapshotIdentifier **   
특성을 설명하는 클러스터 스냅샷의 식별자입니다.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterSnapshotAttributesResult **   
클러스터 스냅샷과 관련된 특성에 대한 상세 정보입니다.  
타입: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 객체

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`은 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

클러스터 스냅샷에 대한 정보를 반환합니다. API 작업은 페이지 매김을 지원합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
클러스터 스냅샷의 목록을 검색할 클러스터의 ID. 이 파라미터는 `DBClusterSnapshotIdentifier` 파라미터와 함께 사용할 수 없습니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 제공된 경우 기존 `DBCluster`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** DBClusterSnapshotIdentifier **   
설명할 특정 클러스터 스냅샷 식별자. 이 파라미터는 `DBClusterIdentifier` 파라미터와 함께 사용할 수 없습니다. 이 값은 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 제공된 경우 기존 `DBClusterSnapshot`의 식별자와 일치해야 합니다.
+ 이 식별자가 자동화된 스냅샷의 식별자인 경우, `SnapshotType` 파라미터도 지정해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** IncludePublic **   
퍼블릭인 수동 클러스터 스냅샷을 포함`true`하려면를 로 설정하고 AWS 계정, 그렇지 않으면에서 복사하거나 복원할 수 있습니다`false`. 기본값은 `false`입니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** IncludeShared **   
복사 또는 복원 권한이 AWS 계정 부여된 다른의 공유 수동 클러스터 스냅샷 AWS 계정 을 포함`true`하려면 로 설정하고, 그렇지 않으면 로 설정합니다`false`. 기본값은 `false`입니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** SnapshotType **   
반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.  
+  `automated` - Amazon DocumentDB가 AWS 계정를 위해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다.
+  `manual` - AWS 계정를 위해 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다.
+  `shared` - AWS 계정에 공유된 모든 수동 클러스터 스냅샷을 반환합니다.
+  `public` - 퍼블릭으로 표시된 클러스터 스냅샷을 모두 반환합니다.
`SnapshotType` 값을 지정하지 않으면 자동 및 수동 클러스터 스냅샷이 모두 반환됩니다. `IncludeShared` 파라미터를 `true`로 설정하여 이러한 결과에 공유 클러스터 스냅샷을 포함시킬 수 있습니다. `IncludePublic` 파라미터를 `true`로 설정하여 이러한 결과에 퍼블릭 클러스터 스냅샷을 포함시킬 수 있습니다.  
`SnapshotType` 값이 `manual` 또는 `automated`인 경우 `IncludeShared` 및 `IncludePublic` 파라미터는 적용되지 않습니다. `SnapshotType`이 `shared`로 설정된 경우 `IncludePublic` 파라미터는 적용되지 않습니다. `SnapshotType`이 `public`로 설정된 경우 `IncludeShared` 파라미터는 적용되지 않습니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBClusterSnapshots.DBClusterSnapshot.N**   
클러스터 스냅샷의 목록을 제공합니다.  
타입: [DBClusterSnapshot](API_DBClusterSnapshot.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`은 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

사용 가능한 엔진의 목록을 반환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBParameterGroupFamily **   
세부 정보를 반환할 특정 파라미터 그룹 패밀리의 이름입니다.  
제약 조건:  
+ 제공된 경우 기존 `DBParameterGroupFamily`과 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** DefaultOnly **   
지정된 엔진의 기본 버전 또는 지정된 엔진과 메이저 버전의 조합만 반환됨을 나타냅니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Engine **   
반환할 데이터베이스 엔진입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** EngineVersion **   
반환할 데이터베이스 버전입니다.  
예시: `3.6.0`   
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** ListSupportedCharacterSets **   
이 파라미터를 지정했으며 요청한 엔진이 `CreateDBInstance`에 대해 `CharacterSetName` 파라미터를 지원하는 경우, 엔진 버전별로 지원되는 문자 세트 목록이 응답에 포함됩니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** ListSupportedTimezones **   
이 파라미터를 지정했으며 요청한 엔진이 `CreateDBInstance`에 대해 `TimeZone` 파라미터를 지원하는 경우, 엔진 버전별로 지원되는 시간대 목록이 응답에 포함됩니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBEngineVersions.DBEngineVersion.N**   
하나 이상의 엔진 버전 세부 정보.  
타입: [DBEngineVersion](API_DBEngineVersion.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

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

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

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

프로비저닝된 Amazon DocumentDB 인스턴스에 대한 정보를 반환합니다. 이 API는 페이지 매김을 지원합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBInstanceIdentifier **   
사용자가 제공한 인스턴스 식별자. 이 파라미터를 지정한 경우, 바로 그 인스턴스에서 온 정보만 반환됩니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 제공된 경우 기존 `DBInstance`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
설명할 인스턴스를 하나 이상 지정하는 필터입니다.  
지원되는 필터:  
+  `db-cluster-id` - 클러스터 식별자 및 클러스터 Amazon 리소스 이름(ARN)을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터와 연결되어 있는 인스턴스에 관한 정보만 포함됩니다.
+  `db-instance-id` - 인스턴스 식별자 및 인스턴스 ARN을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 인스턴스에 대한 정보만 포함됩니다.
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBInstances.DBInstance.N**   
하나 이상의 인스턴스 세부 정보.  
타입: [DBInstance](API_DBInstance.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

`DBSubnetGroup` 설명 목록을 반환합니다. `DBSubnetGroupName`이 지정된 경우, 이 목록에는 지정된 `DBSubnetGroup`에 대한 설명만 포함됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBSubnetGroupName **   
세부 정보를 반환할 서브넷 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **DBSubnetGroups.DBSubnetGroup.N**   
하나 이상의 서브넷 그룹에 대한 자세한 정보.  
타입: [DBSubnetGroup](API_DBSubnetGroup.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`은 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

클러스터 데이터베이스 엔진에 대한 기본 엔진 및 시스템 파라미터 정보를 반환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [범용 파라미터를](CommonParameters.md) 참조하십시오.

 ** DBParameterGroupFamily **   
엔진 파라미터 정보를 반환할 클러스터 파라미터 그룹 패밀리의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** EngineDefaults **   
성공한 `DescribeEngineDefaultClusterParameters` 작업의 간접 호출 결과가 포함되어 있습니다.  
타입: [EngineDefaults](API_EngineDefaults.md) 객체

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

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

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

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

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

모든 이벤트 소스 유형 또는 지정된 경우 지정된 소스 유형에 대한 범주 목록을 표시합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [범용 파라미터](CommonParameters.md)를 참조하십시오.

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** SourceType **   
이벤트가 발생하는 소스의 유형입니다.  
유효한 값: `db-instance`, `db-parameter-group`, `db-security-group`   
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **EventCategoriesMapList.EventCategoriesMap.N**   
이벤트 카테고리 맵의 목록입니다.  
타입: [EventCategoriesMap](API_EventCategoriesMap.md) 객체 배열

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

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

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

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

# DescribeEvents
<a name="API_DescribeEvents"></a>

지난 14일 동안의 인스턴스, 보안 그룹, 스냅샷 및 DB 파라미터 그룹과 관련된 이벤트를 반환합니다. 이름을 파라미터로 제공하여 특정 DB 인스턴스, 보안 그룹, 스냅샷 또는 파라미터 그룹과 관련된 이벤트를 얻을 수 있습니다. 기본적으로 지난 1시간 동안의 이벤트가 반환됩니다.

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

 모든 작업에 공통되는 파라미터에 관한 정보는 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** Duration **   
이벤트를 검색할 시간(분)입니다.  
기본값: 60  
유형: 정수  
필수 항목 여부: 아니요

 ** EndTime **   
 이벤트를 검색할 기간의 종료 시점을 ISO 8601 형식으로 지정합니다.  
예: 2009-07-08T18:00Z  
유형: 타임스탬프  
필수 여부: 아니요

 **EventCategories.EventCategory.N**   
이벤트 알림 구독에서 알림을 트리거하는 이벤트 범주의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** SourceIdentifier **   
반환되는 이벤트에 대한 이벤트 소스의 식별자입니다. 지정하지 않으면 모든 소스가 응답에 포함됩니다.  
제약 조건:  
+ `SourceIdentifier`이 제공된 경우, `SourceType`도 함께 제공해야 합니다.
+ 소스 유형이 `DBInstance`이라면 `DBInstanceIdentifier`을 입력해야 합니다.
+ 소스 유형이 `DBSecurityGroup`이라면 `DBSecurityGroupName`을 입력해야 합니다.
+ 소스 유형이 `DBParameterGroup`이라면 `DBParameterGroupName`을 입력해야 합니다.
+ 소스 유형이 `DBSnapshot`이라면 `DBSnapshotIdentifier`을 입력해야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** SourceType **   
이벤트를 검색할 이벤트 소스입니다. 값을 지정하지 않으면 모든 이벤트가 반환됩니다.  
타입: 문자열  
유효 값: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
필수 여부: 아니요

 ** StartTime **   
 이벤트를 검색할 기간의 시작 시점을 ISO 8601 형식으로 지정합니다.  
예: 2009-07-08T18:00Z  
유형: 타임스탬프  
필수 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **Events.Event.N**   
하나 이상의 이벤트 세부 정보.  
타입: [Event](API_Event.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

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

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

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

고객 계정의 모든 구독 설명을 나열합니다. 구독에 대한 설명에는 `SubscriptionName`, `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`, `Status`가 포함됩니다.

`SubscriptionName`을 지정하면 해당 구독의 설명이 나열됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [범용 파라미터](CommonParameters.md)를 참조하십시오.

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** SubscriptionName **   
설명할 Amazon DocumentDB 이벤트 알림 구독의 이름.  
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **EventSubscriptionsList.EventSubscription.N**   
이벤트 구독의 목록  
타입: [EventSubscription](API_EventSubscription.md)객체 배열

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

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

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

 ** SubscriptionNotFound **   
구독의 이름이 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

Amazon DocumentDB 글로벌 클러스터에 대한 정보를 반환합니다. 이 API는 페이지 매김을 지원합니다.

**참고**  
이 작업은 Amazon DocumentDB 클러스터에만 적용됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [범용 파라미터](CommonParameters.md)를 참조하십시오.

 **Filters.Filter.N**   
설명할 글로벌 DB 클러스터를 하나 이상 지정하는 필터입니다.  
지원되는 필터: `db-cluster-id`는 클러스터 식별자 및 클러스터 Amazon 리소스 이름(ARN)을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터에 대한 정보만 포함됩니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** GlobalClusterIdentifier **   
사용자가 제공한 클러스터 식별자입니다. 이 파라미터를 지정한 경우, 바로 그 클러스터에서 온 정보만 반환됩니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 아니요

 ** Marker **   
이전의 `DescribeGlobalClusters` 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 나머지 결과를 검색할 수 있도록 마커라는 페이지 매김 토큰이 응답에 포함됩니다.  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **GlobalClusters.GlobalClusterMember.N**   
  
타입: [GlobalCluster](API_GlobalCluster.md)객체 배열

 ** Marker **   
  
유형: 문자열

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

지정된 엔진에 대해 명령 가능한 인스턴스 옵션의 목록을 반환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** Engine **   
인스턴스 옵션을 검색할 엔진의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** DBInstanceClass **   
인스턴스 클래스 필터의 값입니다. 지정된 인스턴스 클래스에 맞고 사용 가능한 제품만 표시되게 하려면 이 파라미터를 지정하십시오.  
유형: 문자열  
필수 항목 여부: 아니요

 ** EngineVersion **   
엔진 버전 필터의 값입니다. 지정된 엔진 버전에 맞고 사용 가능한 제품만 표시되게 하려면 이 파라미터를 지정하십시오.  
유형: 문자열  
필수 항목 여부: 아니요

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** LicenseModel **   
라이선스 모델 필터의 값입니다. 지정된 라이선스 모델에 맞고 사용 가능한 제품만 표시되게 하려면 이 파라미터를 지정하십시오.  
유형: 문자열  
필수 항목 여부: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** Vpc **   
Virtual Private Cloud(VPC) 필터 값입니다. 사용 가능한 VPC 또는 비VPC 제품만 표시되게 하려면 이 파라미터를 지정하십시오.  
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

 **OrderableDBInstanceOptions.OrderableDBInstanceOption.N**   
주문 가능한 특정 인스턴스에 사용할 수 있는 옵션  
타입: [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 객체 배열

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

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

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

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

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

대기 중인 유지 관리 작업이 하나 이상 있는 리소스(예: 인스턴스)의 목록을 반환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [범용 파라미터](CommonParameters.md)를 참조하십시오.

 **Filters.Filter.N**   
대기 중인 유지 관리 작업을 반환할 리소스를 하나 이상 지정하는 필터입니다.  
지원되는 필터:  
+  `db-cluster-id` - 클러스터 식별자 및 클러스터 Amazon 리소스 이름(ARN)을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 클러스터에 대해 대기 중인 유지 관리 작업만 포함됩니다.
+  `db-instance-id` - 인스턴스 식별자 및 인스턴스 ARN을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 DB 인스턴스에 대해 대기 중인 유지 관리 작업만 포함됩니다.
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MaxRecords **   
 응답에 포함되는 최대 레코드 수입니다. 지정된 `MaxRecords` 값보다 레코드 수가 많으면 페이지 매김 토큰(마커)을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.  
기본값: 100  
제약: 최소 20, 최대 100입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** ResourceIdentifier **   
대기 중인 유지 관리 작업을 반환할 리소스의 ARN입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열

 **PendingMaintenanceActions.ResourcePendingMaintenanceActions.N**   
적용할 유지 관리 작업.  
타입: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 객체 배열

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

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

 ** ResourceNotFoundFault **   
지정된 리소스 ID를 찾을 수 없습니다.  
HTTP 상태 코드: 404

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

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

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

클러스터에 대한 장애 조치를 강제로 실행합니다.

클러스터에 대한 장애 조치에서 클러스터 내 Amazon DocumentDB 복제본 중 하나(읽기 전용 인스턴스)를 기본 인스턴스(클러스터 라이터)로 승격시킵니다.

Amazon DocumentDB는 기본 인스턴스에 장애가 발생할 경우 Amazon DocumentDB 복제본(있는 경우)에 자동으로 장애 조치됩니다. 테스트를 위해 기본 인스턴스의 실패를 시뮬레이션하려는 경우 장애 조치를 강제할 수 있습니다.

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

 모든 작업에 공통되는 파라미터에 대한 정보는 [범용파라미터](CommonParameters.md)를 참조하세요.

 ** DBClusterIdentifier **   
장애 조치를 강제 실행할 클러스터 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 `DBCluster`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** TargetDBInstanceIdentifier **   
기본 인스턴스로 승격시킬 인스턴스의 이름입니다.  
클러스터에서 Amazon DocumentDB 복제본의 인스턴스 식별자를 지정해야 합니다. 예를 들어 `mydbcluster-replica1`입니다.  
유형: String  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

글로벌 클러스터를 장애 조치할 때 지정된 보조 DB 클러스터를 글로벌 클러스터의 기본 DB 클러스터로 승격합니다.

이 작업을 사용하여 기본 리전의 리전 재해와 같은 계획되지 않은 이벤트에 대응합니다. 장애 조치로 인해 장애 조치 이벤트가 발생하기 전에 선택한 보조 리전에 쓰기 트랜잭션 데이터가 복제되지 않으면 해당 데이터가 손실될 수 있습니다. 하지만 선택한 보조 DB 클러스터의 DB 인스턴스를 기본 라이터 DB 인스턴스로 승격시키는 복구 프로세스는 데이터가 트랜잭션 형태로 일관된 상태를 유지하도록 보장해 줍니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** GlobalClusterIdentifier **   
이 작업을 적용할 Amazon DocumentDB 글로벌 클러스터의 식별자입니다. 식별자는 클러스터가 생성될 때 사용자가 할당한 고유 키입니다. 즉, 글로벌 클러스터의 이름입니다.  
제약 조건:  
+ 기존 글로벌 클러스터의 식별자와 일치해야 합니다.
+ 최소 길이는 1이고, 최대 길이는 255.
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

 ** TargetDbClusterIdentifier **   
글로벌 클러스터의 기본으로 승격시키려는 보조 Amazon DocumentDB 클러스터의 식별자입니다. Amazon DocumentDB가 해당 리전에서 클러스터를 찾을 수 있도록 식별자에 Amazon 리소스 이름(ARN)을 사용합니다. AWS   
제약 조건:  
+ 기존 보조 클러스터의 식별자와 일치해야 합니다.
+ 최소 길이는 1이고, 최대 길이는 255.
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

 ** AllowDataLoss **   
이 글로벌 클러스터 작업에 대한 데이터 손실을 허용할지 여부를 지정합니다. 데이터 손실을 허용하면 글로벌 장애 조치 작업이 트리거됩니다.  
`AllowDataLoss`를 지정하지 않으면 글로벌 클러스터 작업이 기본적으로 전환으로 설정됩니다.  
제약 조건:  
+ `Switchover` 파라미터와 함께 지정할 수 없습니다.
유형: 부울  
필수 항목 여부: 아니요

 ** Switchover **   
이 글로벌 데이터베이스 클러스터를 전환할지 여부를 지정합니다.  
제약 조건:  
+ `AllowDataLoss` 파라미터와 함께 지정할 수 없습니다.
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

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

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

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

Amazon DocumentDB 리소스의 모든 태그를 나열합니다.

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

 모든 작업에서 공유하는 파라미터에 대한 내용은[범용파라미터](CommonParameters.md)를 참조하세요.

 ** ResourceName **   
목록으로 나열할 태그가 있는 Amazon DocumentDB 리소스입니다. 이 값은 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Filters.Filter.N**   
현재 지원되지 않는 파라미터입니다.  
타입: [Filter](API_Filter.md)객체 배열  
필수: 아니요

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

서비스에서 반환되는 요소는 다음과 같습니다.

 **TagList.tag.n**   
태그를 하나 이상 지정합니다.  
타입: [Tag](API_Tag.md) 객체 배열

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`는 기존 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

Amazon DocumentDB 클러스터에 대한 설정을 수정합니다. 요청에 이러한 데이터베이스 구성 파라미터와 새 값을 지정하여 하나 이상의 파라미터를 변경할 수 있습니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
수정 중인 클러스터의 클러스터 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 `DBCluster`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** AllowMajorVersionUpgrade **   
메이저 버전 업그레이드가 허용되는지 여부를 나타내는 값입니다.  
제약 조건:  
+ 클러스터의 현재 버전과 메이저 버전이 다른 `EngineVersion` 파라미터의 값을 지정하는 경우 메이저 버전 업그레이드를 허용해야 합니다.
+ 일부 파라미터는 버전별로 다르므로 해당 파라미터를 변경하려면 인플레이스 MVU가 완료된 후 새 `ModifyDBCluster` API 직접 호출을 실행해야 합니다.
MVU를 수행하면 다음 파라미터에 직접적인 영향을 미칩니다.  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
유형: 부울  
필수 항목 여부: 아니요

 ** ApplyImmediately **   
클러스터의 `PreferredMaintenanceWindow` 설정과 관계없이, 이 요청의 변경 사항과 대기 중인 모든 변경 사항을 비동기적으로 최대한 빨리 적용할 것인지 여부를 지정하는 값입니다. 이 파라미터가 `false`로 설정되어 있으면 클러스터에 대한 변경 사항이 다음번 유지 관리 기간에 적용됩니다.  
`ApplyImmediately` 파라미터는 `NewDBClusterIdentifier` 및 `MasterUserPassword` 값에만 영향을 줍니다. 이 파라미터 값을 `false`로 설정한 경우, `NewDBClusterIdentifier` 및 `MasterUserPassword` 값의 변경 사항이 다음번 유지 관리 기간에 적용됩니다. 그 밖의 모든 변경 사항은 `ApplyImmediately` 파라미터 값과 관계없이 즉시 적용됩니다.  
기본값: `false`   
유형: 부울  
필수 항목 여부: 아니요

 ** BackupRetentionPeriod **   
자동 백업이 보존되는 일수입니다. 1 이상의 값을 지정해야 합니다.  
기본값: 1  
제약 조건:  
+ 1\$135의 값이어야 합니다.
유형: 정수  
필수 항목 여부: 아니요

 ** CloudwatchLogsExportConfiguration **   
특정 인스턴스 또는 클러스터에 대하여 Amazon CloudWatch Logs로 내보내기를 활성화할 로그 유형의 구성 설정입니다. `EnableLogTypes` 및 `DisableLogTypes` 배열이 CloudWatch Logs로 내보내는(또는 내보내지 않을) 로그를 결정합니다.  
유형: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)객체  
필수 여부: 아니요

 ** DBClusterParameterGroupName **   
클러스터에 사용할 클러스터 파라미터 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. `DeletionProtection`이 활성화되면 클러스터를 수정하고 `DeletionProtection` 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. `DeletionProtection`은 클러스터가 실수로 삭제되지 않도록 보호합니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** EngineVersion **   
업그레이드할 데이터베이스 엔진의 버전 번호입니다. 이 파라미터를 변경해도 작동이 중단되지 않습니다. `ApplyImmediately`를 활성화하지 않은 한, 변경 사항은 다음번 유지 관리 기간에 적용됩니다.  
Amazon DocumentDB에 대한 사용 가능한 모든 엔진 버전을 나열하려면 다음 명령을 사용합니다.  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
유형: 문자열  
필수 항목 여부: 아니요

 ** ManageMasterUserPassword **   
Amazon Web Services Secrets Manager를 사용하여 마스터 사용자 암호를 관리할지 여부를 지정합니다. 클러스터가 Amazon Web Services Secrets Manager를 사용하여 마스터 사용자 암호를 관리하지 않는 경우 이 관리를 켤 수 있습니다. 이 경우 `MasterUserPassword`를 지정할 수 없습니다. 클러스터가 이미 Amazon Web Services Secrets Manager로 마스터 사용자 암호를 관리하고 있고 마스터 사용자 암호가 Amazon Web Services Secrets Manager로 관리되지 않도록 지정하는 경우 `MasterUserPassword`를 지정해야 합니다. 이 경우 Amazon DocumentDB는 보안 암호를 삭제하고 `MasterUserPassword`에서 지정한 마스터 사용자의 새 암호를 사용합니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** MasterUserPassword **   
마스터 데이터베이스 사용자의 암호입니다. 이 암호에는 슬래시(/), 큰따옴표(") 또는 ‘앳’ 기호(@)를 제외한 인쇄 가능 ASCII 문자가 포함될 수 있습니다.  
제약: 8\$1100자여야 합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** MasterUserSecretKmsKeyId **   
Amazon Web Services Secrets Manager에서 자동으로 생성되고 관리되는 보안 암호를 암호화하기 위한 Amazon Web Services KMS 키 식별자입니다.  
다음 조건이 충족되는 경우에만 이 설정이 유효합니다.  
+ 클러스터가 Amazon Web Services Secrets Manager에서 마스터 사용자 암호를 관리하지 않습니다. 클러스터가 이미 Amazon Web Services Secrets Manager에서 마스터 사용자 암호를 관리하는 경우 보안 암호를 암호화하는 데 사용되는 KMS 키를 변경할 수 없습니다.
+ Amazon Web Services Secrets Manager에서 `ManageMasterUserPassword`를 활성화해 마스터 사용자 암호를 관리할 수 있습니다. `ManageMasterUserPassword`를 켜고 `MasterUserSecretKmsKeyId`를 지정하지 않으면 `aws/secretsmanager` KMS 키가 보안 암호를 암호화하는 데 사용됩니다. 보안 암호가 다른 Amazon Web Services 계정에 있는 경우 `aws/secretsmanager` KMS 키를 사용하여 보안 암호를 보안 암호화할 수 없으며 고객 관리형 KMS 키를 사용해야 합니다.
Amazon Web Services KMS 키 식별자는 KMS 키의 키 ARN, 키 ID, 별칭 ARN 또는 별칭 이름입니다. 다른 Amazon Web Services 계정에서 KMS 키를 사용하려면 키 ARN 또는 별칭 ARN을 지정하세요.  
Amazon Web Services 계정에 대한 기본 KMS 키가 있습니다. Amazon Web Services 계정에는 Amazon Web Services 리전마다 다른 기본 KMS 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** NetworkType **   
클러스터의 네트워크 유형입니다.  
네트워크 유형은 클러스터에 대해 지정된 `DBSubnetGroup`에 의해 결정됩니다. `DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(`DUAL`)만 지원할 수 있습니다.  
자세한 내용은 Amazon DocumentDB 개발자 안내서의 [VPC의 DocumentDB 클러스터](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)를 참조하세요.  
유효한 값: `IPV4` \$1 `DUAL`   
유형: 문자열  
필수 항목 여부: 아니요

 ** NewDBClusterIdentifier **   
클러스터의 이름을 변경할 때 클러스터의 새 클러스터 식별자입니다. 이 값은 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-cluster2`   
유형: 문자열  
필수 항목 여부: 아니요

 ** Port **   
 클러스터에서 연결을 허용하는 포트 번호입니다.  
제약 조건: 값이 `1150`\$1`65535`여야 합니다.  
기본값: 원래의 클러스터와 동일한 포트입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** PreferredBackupWindow **   
`BackupRetentionPeriod` 파라미터를 사용하여 자동 백업을 활성화한 경우, 자동 백업이 생성되는 일일 시간 범위입니다.  
기본값은 각각에 대해 8시간 블록 시간 중에서 임의로 선택한 30분 기간입니다 AWS 리전.  
제약 조건:  
+ `hh24:mi-hh24:mi` 형식이어야 합니다.
+ 협정 세계시(UTC)여야 합니다.
+ 원하는 유지 관리 기간과 충돌하지 않아야 합니다.
+ 30분 이상이어야 합니다.
유형: 문자열  
필수 항목 여부: 아니요

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

 ** RotateMasterUserPassword **   
Amazon Web Services Secrets Manager에서 관리하는 보안 암호를 마스터 사용자 암호로 교체할지 여부를 지정합니다.  
이 설정은 클러스터에 대한 Amazon Web Services Secrets Manager의 Amazon DocumentDB에서 마스터 사용자 암호를 관리하는 경우에만 유효합니다. 보안 암호 값에는 업데이트된 암호가 포함됩니다.  
제약 조건: 마스터 사용자 암호를 교체할 때 변경 사항을 즉시 적용해야 합니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 클러스터의 규모 조정 구성을 포함합니다.  
유형: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)객체  
필수 여부: 아니요

 ** StorageType **   
DB 클러스터와 연결할 스토리지 유형입니다.  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
클러스터가 속하게 될 Virtual Private Cloud(VPC) 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`는 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName`는 기존 클러스터 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`는 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBSecurityGroupState **   
보안 그룹의 상태로 인해 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidDBSubnetGroupStateFault **   
서브넷 그룹이 사용 중이므로 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** NetworkTypeNotSupported **   
네트워크 유형은 `DBSubnetGroup` 또는 DB 엔진 버전에서 지원되지 않습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

 DB 클러스터 파라미터 그룹의 파라미터를 수정합니다. 하나 이상의 파라미터를 수정하려면 `ParameterName`, `ParameterValue` 및 `ApplyMethod`의 목록을 제출하십시오. 요청 하나에서 최대 20개의 파라미터를 수정할 수 있습니다.

**참고**  
동적 파라미터의 변경 내용은 즉시 적용됩니다. 정적 매개변수를 변경한 경우 변경 내용을 적용하려면 재부팅 또는 유지 관리 기간이 필요합니다.

**중요**  
클러스터 파라미터 그룹을 생성한 후 해당 클러스터 파라미터 그룹을 기본 파라미터 그룹으로 사용하는 첫 번째 클러스터를 생성하기 전에 5분 이상 기다려야 합니다. 이렇게 하면 Amazon DocumentDB가 생성 작업을 완전히 마친 뒤에 해당 파라미터 그룹을 새 클러스터의 기본값으로 사용할 수 있습니다. 이 단계는 `character_set_database` 파라미터로 정의한 기본 데이터베이스의 문자 세트 등 클러스터의 기본 데이터베이스를 생성할 때 필요한 파라미터의 경우 특히 중요합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
수정할 클러스터 파라미터 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Parameters.Parameter.N**   
클러스터 파라미터 그룹에서 수정할 파라미터의 목록입니다.  
타입: [Parameter](API_Parameter.md)객체 배열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterParameterGroupName **   
클러스터 파라미터 그룹의 이름입니다.  
제약 조건:  
+ 1\$1255자의 문자 또는 숫자여야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
이 값은 소문자 문자열로 저장됩니다.
유형: 문자열

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBParameterGroupState **   
파라미터 그룹이 사용 중이거나 유효하지 않은 상태입니다. 파라미터 그룹을 삭제하려는 경우 파라미터 그룹이 이 상태일 때는 삭제할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

속성 및 값을 수동 클러스터 스냅샷에 추가하거나, 수동 DB 클러스터 스냅샷에서 속성 및 값을 제거합니다.

수동 클러스터 스냅샷을 다른와 공유하려면를 `restore`로 AWS 계정지정`AttributeName`하고 `ValuesToAdd` 파라미터를 사용하여 수동 클러스터 스냅샷을 복원할 권한이 AWS 계정 있는의 IDs 목록을 추가합니다. 수동 클러스터 스냅샷을 모든 AWS 계정에서 복사하거나 복원할 수 있는 퍼블릭 스냅샷으로 만들려면 `all` 값을 사용하십시오. 모든 AWS 계정에는 제공하지 않을 비공개 정보가 포함된 수동 클러스터 스냅샷에는 `all` 값을 추가하지 마십시오. 수동 클러스터 스냅샷이 암호화된 경우 `ValuesToAdd` 파라미터에 대한 AWS 계정 IDs 목록을 지정해야만 공유할 수 있습니다. 이 경우에는 해당 파라미터 값으로 `all`을 사용할 수 없습니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** AttributeName **   
수정할 클러스터 스냅샷 속성의 이름입니다.  
다른이 수동 클러스터 스냅샷을 복사하거나 복원 AWS 계정 할 수 있는 권한을 관리하려면이 값을 로 설정합니다`restore`.  
유형: 문자열  
필수 항목 여부: 예

 ** DBClusterSnapshotIdentifier **   
속성을 수정할 클러스터 스냅샷의 식별자입니다.  
유형: 문자열  
필수 항목 여부: 예

 **ValuesToAdd.AttributeValue.N**   
`AttributeName`에 지정된 속성에 추가할 클러스터 스냅샷 속성의 목록입니다.  
다른이 수동 클러스터 스냅샷을 복사하거나 복원 AWS 계정 하도록 승인하려면이 목록을 하나 이상의 AWS 계정 IDs를 포함하도록 설정합니다. 수동 클러스터 스냅샷을에서 복원할 수 있도록 하려면 로 AWS 계정설정합니다`all`. 모든 AWS 계정에는 제공하지 않을 비공개 정보가 포함된 수동 클러스터 스냅샷에는 `all` 값을 추가하지 마십시오.  
유형: 문자열 배열  
필수 여부: 아니요

 **ValuesToRemove.AttributeValue.N**   
`AttributeName`에 지정된 속성에서 제거할 클러스터 스냅샷 속성의 목록입니다.  
다른이 수동 클러스터 스냅샷을 복사하거나 복원 AWS 계정 할 수 있는 권한을 제거하려면이 목록을 하나 이상의 AWS 계정 식별자를 포함하도록 설정합니다. 클러스터 스냅샷을 복사하거나 복원 AWS 계정 할 수 있는 권한 부여를 제거하려면 `all` 로 설정합니다. `all`를 지정하더라도 `restore` 속성에 계정 ID AWS 계정 가 명시적으로 추가된는 수동 클러스터 스냅샷을 복사하거나 복원할 수 있습니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterSnapshotAttributesResult **   
클러스터 스냅샷과 관련된 특성에 대한 상세 정보입니다.  
타입: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 객체

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

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

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`은 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** SharedSnapshotQuotaExceeded **   
수동 DB 스냅샷을 공유할 수 있는 최대 계정 수를 초과했습니다.  
HTTP 상태 코드: 400

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

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

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

인스턴스의 설정을 수정합니다. 요청에 이러한 데이터베이스 구성 파라미터와 새 값을 지정하여 하나 이상의 파라미터를 변경할 수 있습니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBInstanceIdentifier **   
인스턴스 식별자입니다. 이 값은 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 기존 `DBInstance`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** ApplyImmediately **   
인스턴스의 `PreferredMaintenanceWindow` 설정과 관계없이, 이 요청의 수정 사항과 보류 중인 모든 수정 사항을 비동기적으로 최대한 빨리 적용할 것인지 여부를 지정합니다.  
 이 파라미터가 `false`로 설정되어 있으면 인스턴스에 대한 변경 사항이 다음번 유지 관리 기간에 적용됩니다. 일부 파라미터는 변경하면 중단이 발생하며, 다음번 재부팅 시 적용됩니다.  
기본값: `false`   
유형: 부울  
필수 항목 여부: 아니요

 ** AutoMinorVersionUpgrade **   
이 파라미터는 Amazon DocumentDB에는 적용되지 않습니다. Amazon DocumentDB는 값 세트에 관계없이 마이너 버전 업그레이드를 수행하지 않습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** CACertificateIdentifier **   
인스턴스와 연결해야 하는 인증서를 나타냅니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** CertificateRotationRestart **   
SSL/TLS 인증서를 교체할 때 DB 인스턴스를 다시 시작할지를 지정합니다.  
기본적으로 SSL/TLS 인증서를 교체하면 DB 인스턴스가 다시 시작됩니다. DB 인스턴스를 다시 시작할 때까지 인증서가 업데이트되지 않습니다.  
SSL/TLS를 사용하여 DB 인스턴스에 연결하지 *않는* 경우에만 이 파라미터를 설정합니다.
SSL/TLS를 사용하여 DB 인스턴스에 연결하는 경우, *Amazon DocumentDB 개발자 안내서*의 [Amazon DocumentDB TLS 인증서 업데이트](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) 및 [전송 중 데이터 암호화](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)를 참조하세요.  
유형: 부울  
필수 항목 여부: 아니요

 ** CopyTagsToSnapshot **   
모든 태그를 DB 인스턴스에서 DB 인스턴스의 스냅샷으로 복사할지 여부를 나타내는 값입니다. 태그는 기본적으로 복사되지 않습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** DBInstanceClass **   
인스턴스의 컴퓨팅 및 메모리 용량입니다(예: `db.r5.large`). 모든 AWS 리전에서 모든 인스턴스 클래스를 사용할 수 있는 것은 아닙니다.  
인스턴스 클래스를 수정하면 변경 중에 중단이 발생합니다. 이 요청에 대해 `ApplyImmediately`를 `true`로 지정하지 않은 한, 변경 사항은 다음번 유지 관리 기간에 적용됩니다.  
기본값: 기존 설정을 사용합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** EnablePerformanceInsights **   
DB 인스턴스에 Performance Insights를 활성화할지 여부를 나타내는 값입니다. 자세한 내용은 [Amazon 성능 개선 도우미 사용](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)을 참조하세요.  
유형: 부울  
필수 항목 여부: 아니요

 ** NewDBInstanceIdentifier **   
 인스턴스의 이름을 변경할 때 인스턴스의 새로운 인스턴스 식별자입니다. 인스턴스 식별자를 변경할 때 `Apply Immediately`을 `true`로 설정하면 인스턴스 식별자가 즉시 재부팅됩니다. `Apply Immediately`을 `false`로 설정하면 다음 유지 관리 기간에 발생합니다. 이 값은 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `mydbinstance`   
유형: 문자열  
필수 항목 여부: 아니요

 ** PerformanceInsightsKMSKeyId **   
성능 개선 도우미 데이터의 암호화를 위한 AWS KMS 키 식별자입니다.  
 AWS KMS 키 식별자는 KMS 키의 키 ARN, 키 ID, 별칭 ARN 또는 별칭 이름입니다.  
PerformanceInsightsKMSKeyId에 대한 값을 지정하지 않으면 Amazon DocumentDB에서는 기본 KMS 키를 사용합니다. Amazon Web Services 계정에 대한 기본 KMS 키가 있습니다. Amazon Web Services 계정에는 Amazon Web Services 리전마다 다른 기본 KMS 키가 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** PreferredMaintenanceWindow **   
중단으로 이어질 가능성이 있는 시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC)입니다. 다음 상황을 제외하고는 이 파라미터를 변경해도 중단되지 않으며, 변경 사항은 비동기적으로 최대한 빨리 적용됩니다. 재부팅해야 하는 작업이 대기 중이고 유지 관리 기간이 현재 시간을 포함하도록 변경된 경우, 이 파라미터를 변경하면 인스턴스가 재부팅됩니다. 이 기간을 현재 시간으로 옮기는 경우, 대기 중인 변경 사항이 적용될 수 있도록 현재 시간과 기간 종료 사이에 최소 30분의 시간을 두어야 합니다.  
기본값: 기존 설정을 사용합니다.  
형식: `ddd:hh24:mi-ddd:hh24:mi`   
유효한 요일: 월, 화, 수, 목, 금, 토, 일  
제약: 30분 이상이어야 합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** PromotionTier **   
기존 기본 인스턴스에 결함이 발생한 후 Amazon DocumentDB 복제본을 기본 인스턴스로 승격할 순서를 지정하는 값  
기본값: 1  
유효한 값: 0\$115  
유형: 정수  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBInstance **   
인스턴스에 대한 자세한 정보입니다.  
타입: [DBInstance](API_DBInstance.md) 객체

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

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

 ** AuthorizationNotFound **   
지정한 CIDR IP 또는 Amazon EC2 보안 그룹에 대해 지정한 보안 그룹에 대한 권한이 없습니다.  
Amazon DocumentDB는 또한 IAM을 사용하여 사용자를 대신하여 필요한 작업을 수행할 권한이 없을 수도 있습니다.  
HTTP 상태 코드: 404

 ** CertificateNotFound **   
 `CertificateIdentifier`는 기존 인증서를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBInstanceAlreadyExists **   
해당 식별자를 사용하는 인스턴스가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName`는 기존 보안 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBUpgradeDependencyFailure **   
종속 대상인 리소스를 수정할 수 없어 업그레이드에 실패했습니다.  
HTTP 상태 코드: 400

 ** InsufficientDBInstanceCapacity **   
지정한 인스턴스 클래스를 지정한 가용성 영역에서 사용할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBSecurityGroupState **   
보안 그룹의 상태로 인해 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** StorageTypeNotSupported **   
지정된 `StorageType`을 이 DB 인스턴스와 연결할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

기존 서브넷 그룹을 수정합니다. 서브넷 그룹은 AWS 리전에서 최소 두 개의 가용 영역에 적어도 하나의 서브넷을 포함해야 합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBSubnetGroupName **   
서브넷 그룹의 이름입니다. 이 값은 소문자 문자열로 저장됩니다. 기본 서브넷 그룹은 수정할 수 없습니다.  
제약: 기존의 `DBSubnetGroup` 이름과 일치해야 합니다. 기본값이 아니어야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 예

 **SubnetIds.SubnetIdentifier.N**   
서브넷 그룹의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 항목 여부: 예

 ** DBSubnetGroupDescription **   
서브넷 그룹에 대한 설명입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBSubnetGroup **   
서브넷 그룹에 대한 자세한 정보.  
타입: [DBSubnetGroup](API_DBSubnetGroup.md) 객체

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

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

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
가용 영역이 하나뿐인 경우를 제외하고, 서브넷 그룹의 서브넷은 최소한 두 개의 가용 영역을 포함해야 합니다.  
HTTP 상태 코드: 400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`은 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetQuotaExceededFault **   
이 요청으로 인해 서브넷 그룹에서 허용되는 서브넷 수를 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** SubnetAlreadyInUse **   
가용 영역에서 이미 사용 중인 서브넷입니다.  
HTTP 상태 코드: 400

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

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

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

기존 Amazon DocumentDB 이벤트 알림 구독을 수정합니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터를](CommonParameters.md) 참조하십시오.

 ** SubscriptionName **   
Amazon DocumentDB 이벤트 알림 구독의 이름.  
유형: 문자열  
필수 항목 여부: 예

 ** Enabled **   
 부울 값입니다. 구독을 활성화하려면 `true`로 설정합니다.  
유형: 부울  
필수 항목 여부: 아니요

 **EventCategories.EventCategory.N**   
 구독할 `SourceType`의 이벤트 범주 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** SnsTopicArn **   
이벤트 알림을 위해 생성한 SNS 주제의 Amazon 리소스 이름(ARN)입니다. 주제를 만들고 구독하면 Amazon SNS에서 ARN이 생성됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** SourceType **   
이벤트가 발생하는 소스의 유형입니다. 예를 들어, 인스턴스에서 생성되는 이벤트에 대한 알림을 받으려면 이 파라미터를 `db-instance`로 설정합니다. 이 값을 지정하지 않으면 모든 이벤트가 반환됩니다.  
유효한 값: `db-instance`, `db-parameter-group`, `db-security-group`   
유형: 문자열  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** EventSubscription **   
구독한 이벤트에 대한 세부 정보.  
타입: [EventSubscription](API_EventSubscription.md) 객체

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

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 단원을 참조하십시오.

 ** EventSubscriptionQuotaExceeded **   
최대 이벤트 구독 수에 도달했습니다.  
HTTP 상태 코드: 400

 ** SNSInvalidTopic **   
Amazon SNS에서 지정된 주제에 문제가 있다고 응답했습니다.  
HTTP 상태 코드: 400

 ** SNSNoAuthorization **   
SNS 주제 Amazon 리소스 이름(ARN) 에 게시할 권한이 없습니다.  
HTTP 상태 코드: 400

 ** SNSTopicArnNotFound **   
SNS 주제 Amazon 리소스 이름(ARN)이 존재하지 않습니다   
HTTP 상태 코드: 404

 ** SubscriptionCategoryNotFound **   
제공된 범주가 존재하지 않습니다.  
HTTP 상태 코드: 404

 ** SubscriptionNotFound **   
구독의 이름이 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

Amazon DocumentDB 글로벌 클러스터에 대한 설정을 수정합니다. 요청에서 이러한 파라미터와 새 값을 지정하여 하나 이상의 구성 파라미터 (예: 삭제 보호) 또는 글로벌 클러스터 식별자를 변경할 수 있습니다.

**참고**  
이 작업은 Amazon DocumentDB 클러스터에만 적용됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** GlobalClusterIdentifier **   
수정 중인 글로벌 클러스터의 식별자입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 글로벌 클러스터의 식별자와 일치해야 합니다.
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

 ** DeletionProtection **   
글로벌 클러스터의 삭제 방지 기능 활성화 여부를 나타냅니다. 삭제 방지 기능이 활성화되면 글로벌 클러스터가 삭제될 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** NewGlobalClusterIdentifier **   
글로벌 클러스터를 수정할 때 표시되는 글로벌 클러스터의 새 식별자. 이 값은 소문자 문자열로 저장됩니다.  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.

  첫 번째 자리는 문자여야 합니다.

  하이픈으로 끝나거나 하이픈이 2개 연속으로 이어져서는 안 됩니다.
예시: `my-cluster2`   
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

일반적으로 유지 관리를 이유로 인스턴스를 재부팅해야 할 수 있습니다. 예를 들어, 특정 내용을 변경하거나 인스턴스에 연결된 클러스터 파라미터 그룹을 변경하는 경우 인스턴스를 재부팅해야 변경 내용이 적용됩니다.

인스턴스를 재부팅하면 데이터베이스 엔진 서비스가 재시작됩니다. 인스턴스를 재부팅하면 인스턴스 상태가 *재부팅*으로 설정되면서 잠시 중단됩니다.

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

 모든 작업에 공통으로 적용되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBInstanceIdentifier **   
인스턴스 식별자입니다. 이 파라미터는 소문자 문자열로 저장됩니다.  
제약 조건:  
+ 기존 `DBInstance`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** ForceFailover **   
 `true`인 경우, Multi-AZ 장애 조치를 통해 재부팅이 이루어집니다.  
제약: 인스턴스가 Multi-AZ용으로 구성되지 않았으면 `true`로 지정할 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBInstance **   
인스턴스에 대한 자세한 정보입니다.  
타입: [DBInstance](API_DBInstance.md) 객체

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

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

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBInstanceState **   
 지정된 인스턴스는 *사용 가능* 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

Amazon DocumentDB 보조 클러스터를 글로벌 클러스터에서 분리합니다. 클러스터는 읽기 전용이고 다른 지역의 기본 클러스터로부터 데이터를 수신하는 대신 읽기-쓰기 기능을 갖춘 독립 실행형 클러스터가 됩니다.

**참고**  
이 작업은 Amazon DocumentDB 클러스터에만 적용됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DbClusterIdentifier **   
Amazon DocumentDB 글로벌 클러스터에서 분리된 클러스터를 식별하는 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** GlobalClusterIdentifier **   
Amazon DocumentDB 글로벌 클러스터에서 분리할 클러스터 식별자입니다.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

기존의 Amazon DocumentDB 이벤트 알림 구독에서 소스 식별자를 제거합니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** SourceIdentifier **   
 인스턴스의 인스턴스 식별자 또는 보안 그룹의 이름 등 구독에서 제거할 소스 식별자입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** SubscriptionName **   
소스 식별자를 제거하려는 Amazon DocumentDB 이벤트 알림 구독의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** EventSubscription **   
구독한 이벤트에 대한 세부 정보.  
타입: [EventSubscription](API_EventSubscription.md) 객체

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

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 단원을 참조하십시오.

 ** SourceNotFound **   
요청한 소스를 찾을 수 없습니다.  
HTTP 상태 코드: 404

 ** SubscriptionNotFound **   
구독의 이름이 존재하지 않습니다.  
HTTP 상태 코드: 404

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

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

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

Amazon DocumentDB 리소스에서 메타데이터 태그를 제거합니다.

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

 모든 작업에 공통되는 파라미터에 대한 자세한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** ResourceName **   
에서 태그를 제거한 Amazon DocumentDB 리소스입니다. 이 값은 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 예

 **TagKeys.member.N**   
제거할 태그의 태그 키(이름)입니다.  
유형: 문자열 배열  
필수 항목 여부: 예

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier`는 기존 인스턴스를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`는 기존 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

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

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

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 클러스터 파라미터 그룹의 파라미터를 기본값으로 수정합니다. 특정 파라미터를 재설정하려면 `ParameterName` 및 `ApplyMethod`의 목록을 제출해야 합니다. 클러스터 파라미터 그룹 전체를 재설정하려면 `DBClusterParameterGroupName` 및 `ResetAllParameters` 파라미터를 지정합니다.

 전체 그룹을 재설정하면 동적 파라미터가 즉시 업데이트되고 정적 파라미터는 `pending-reboot`로 설정되어 다음 DB 인스턴스 재시작 시 적용됩니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterParameterGroupName **   
재설정할 클러스터 파라미터 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 **Parameters.Parameter.N**   
기본값으로 재설정하려는 클러스터 파라미터 그룹의 파라미터 이름 목록입니다. `ResetAllParameters` 파라미터를 `true`로 설정한 경우 이 파라미터를 사용할 수 없습니다.  
타입: [Parameter](API_Parameter.md)객체 배열  
필수: 아니요

 ** ResetAllParameters **   
클러스터 파라미터 그룹의 모든 파라미터를 기본값으로 재설정하려면 이 값을 `true`로 설정하고, 그렇지 않으면 `false`로 설정합니다. `Parameters` 파라미터용으로 지정된 파라미터 이름 목록이 있는 경우에는 이 파라미터를 사용할 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBClusterParameterGroupName **   
클러스터 파라미터 그룹의 이름입니다.  
제약 조건:  
+ 1\$1255자의 문자 또는 숫자여야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
이 값은 소문자 문자열로 저장됩니다.
유형: 문자열

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

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

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName`은 기존 파라미터 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBParameterGroupState **   
파라미터 그룹이 사용 중이거나 유효하지 않은 상태입니다. 파라미터 그룹을 삭제하려는 경우 파라미터 그룹이 이 상태일 때는 삭제할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

스냅샷 또는 클러스터 스냅샷에서 새 클러스터를 생성합니다.

스냅샷을 지정하는 경우, 기본 구성과 기본 보안 그룹으로 원본 스냅샷에서 대상 DB 클러스터가 생성됩니다.

클러스터 스냅샷을 지정하는 경우, 원래의 원본 DB 클러스터와 동일한 구성으로 원본 클러스터의 복원 지점에서 대상 클러스터가 생성됩니다. 단, 새 클러스터가 기본 보안 그룹으로 생성된 경우는 예외입니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
스냅샷 또는 클러스터 스냅샷에서 생성할 클러스터의 이름입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
예시: `my-snapshot-id`   
유형: 문자열  
필수 항목 여부: 예

 ** Engine **   
새 클러스터에 사용할 데이터베이스 엔진입니다.  
기본값: 원본과 동일합니다.  
제약: 원본의 엔진과 호환되어야 합니다.  
유형: 문자열  
필수 항목 여부: 예

 ** SnapshotIdentifier **   
복원에 사용할 스냅샷 또는 클러스터 스냅샷의 식별자입니다.  
이름 또는 Amazon 리소스 이름(ARN)을 사용하여 클러스터 스냅샷을 지정할 수 있습니다. 그러나 스냅샷을 지정할 때는 ARN만 사용해야 합니다.  
제약 조건:  
+ 기존 스냅샷의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 **AvailabilityZones.AvailabilityZone.N**   
복원된 DB 클러스터의 인스턴스를 생성할 수 있는 Amazon EC2 가용 영역 목록을 알려 줍니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** DBClusterParameterGroupName **   
이 DB 클러스터와 연결할 DB 클러스터 파라미터 그룹의 이름입니다.  
 *유형*: 문자열.       *필수 항목 여부*: 아니요  
이 인수를 생략하면 기본 DB 클러스터 파라미터 그룹이 사용됩니다. 제공된 경우 기존 기본 DB 클러스터 파라미터 그룹의 이름과 일치해야 합니다. 문자열은 1\$1255개의 문자, 숫자 또는 하이픈으로 구성되어야 합니다. 첫 번째 문자는 문자이어야 하며 하이픈으로 끝나거나 두 개의 연속된 하이픈을 포함할 수 없습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** DBSubnetGroupName **   
새 클러스터에 사용할 서브넷 그룹의 이름입니다.  
제약: 입력 시 기존의 `DBSubnetGroup` 이름과 일치해야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. `DeletionProtection`이 활성화되면 클러스터를 수정하고 `DeletionProtection` 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. `DeletionProtection`은 클러스터가 실수로 삭제되지 않도록 보호합니다.  
유형: 부울  
필수 항목 여부: 아니요

 **EnableCloudwatchLogsExports.member.N**   
Amazon CloudWatch Logs 로 내보내려면 사용 설정해야 하는 로그 유형 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** EngineVersion **   
새 클러스터에 사용할 데이터베이스 엔진의 버전입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** KmsKeyId **   
DB 스냅샷 또는 클러스터 스냅샷에서 암호화된 클러스터를 복원할 때 사용할 AWS KMS 키 식별자입니다.  
 AWS KMS 키 식별자는 AWS KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 새 클러스터를 암호화하는 데 사용되는 AWS KMS 암호화 키를 소유 AWS 계정 한 동일한 로 클러스터를 복원하는 경우 AWS KMS 암호화 AWS KMS 키에 ARN 대신 키 별칭을 사용할 수 있습니다.  
`KmsKeyId` 파라미터 값을 지정하지 않으면 다음과 같이 진행됩니다.  
+ 의 스냅샷 또는 클러스터 스냅샷`SnapshotIdentifier`이 암호화된 경우 복원된 클러스터는 스냅샷 또는 클러스터 스냅샷을 암호화하는 데 사용된 AWS KMS 키를 사용하여 암호화됩니다.
+ `SnapshotIdentifier`의 스냅샷 또는 클러스터 스냅샷이 암호화되어 있지 않으면 복원된 DB 클러스터는 암호화되지 않습니다.
유형: 문자열  
필수 항목 여부: 아니요

 ** NetworkType **   
클러스터의 네트워크 유형입니다.  
네트워크 유형은 클러스터에 대해 지정된 `DBSubnetGroup`에 의해 결정됩니다. `DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(`DUAL`)만 지원할 수 있습니다.  
자세한 내용은 Amazon DocumentDB 개발자 안내서의 [VPC의 DocumentDB 클러스터](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)를 참조하세요.  
유효한 값: `IPV4` \$1 `DUAL`   
유형: 문자열  
필수 항목 여부: 아니요

 ** Port **   
새 클러스터에서 연결을 허용하는 포트 번호입니다.  
제약 조건: 값이 `1150`\$1`65535`여야 합니다.  
기본값: 원래의 클러스터와 동일한 포트입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 클러스터의 규모 조정 구성을 포함합니다.  
유형: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)객체  
필수 여부: 아니요

 ** StorageType **   
DB 클러스터와 연결할 스토리지 유형입니다.  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
복원된 클러스터에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
새 클러스터가 속하게 될 Virtual Private Cloud(VPC) 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBClusterQuotaExceededFault **   
클러스터의 최대 허용 할당량에 도달했기 때문에 클러스터를 생성할 수 없습니다.  
HTTP 상태 코드: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`는 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier`는 기존 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`는 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`는 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InsufficientDBClusterCapacityFault **   
현재의 작업을 하기에는 클러스터의 용량이 부족합니다.  
HTTP 상태 코드: 403

 ** InsufficientStorageClusterCapacity **   
현재의 작업에 사용할 스토리지가 부족합니다. 사용 가능한 스토리지가 더 많은 다른 가용 영역을 사용하도록 서브넷 그룹을 업데이트하여 이 오류를 해결할 수 있습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBSnapshotState **   
스냅샷의 상태로 인해 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidRestoreFault **   
Virtual Private Cloud(VPC) 백업에서 VPC가 아닌 DB 인스턴스로 복원할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** KMSKeyNotAccessibleFault **   
 AWS KMS 키에 액세스할 때 오류가 발생했습니다.  
HTTP 상태 코드: 400

 ** NetworkTypeNotSupported **   
네트워크 유형은 `DBSubnetGroup` 또는 DB 엔진 버전에서 지원되지 않습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

클러스터를 임의의 시점으로 복원합니다. 사용자는 `LatestRestorableTime` 이전의 최대 `BackupRetentionPeriod`일까지 원하는 시점으로 복원할 수 있습니다. 원래의 클러스터와 동일한 구성으로 원본 클러스터에서 대상 클러스터가 생성됩니다. 단, 새 클러스터가 기본 보안 그룹으로 생성된 경우는 예외입니다.

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

 모든 작업에 공통되는 파라미터에 관한 정보는 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
생성할 새 클러스터의 이름입니다.  
제약 조건:  
+ 1\$163자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.
+ 첫 자는 문자여야 합니다.
+ 하이픈으로 끝나거나 하이픈이 2개 연속으로 포함되어서는 안 됩니다.
유형: 문자열  
필수 항목 여부: 예

 ** SourceDBClusterIdentifier **   
복원할 소스 클러스터의 식별자입니다.  
제약 조건:  
+ 기존 `DBCluster`의 식별자와 일치해야 합니다.
유형: 문자열  
필수 항목 여부: 예

 ** DBSubnetGroupName **   
새 클러스터에 사용할 서브넷 그룹 이름입니다.  
제약: 입력 시 기존의 `DBSubnetGroup` 이름과 일치해야 합니다.  
예시: `mySubnetgroup`   
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. `DeletionProtection`이 활성화되면 클러스터를 수정하고 `DeletionProtection` 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. `DeletionProtection`은 클러스터가 실수로 삭제되지 않도록 보호합니다.  
유형: 부울  
필수 항목 여부: 아니요

 **EnableCloudwatchLogsExports.member.N**   
Amazon CloudWatch Logs 로 내보내려면 사용 설정해야 하는 로그 유형 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** KmsKeyId **   
암호화된 클러스터에서 암호화된 클러스터를 복원할 때 사용할 AWS KMS 키 식별자입니다.  
 AWS KMS 키 식별자는 AWS KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 새 클러스터를 암호화하는 데 사용되는 AWS KMS 암호화 키를 소유 AWS 계정 한 동일한 로 클러스터를 복원하는 경우 AWS KMS 암호화 AWS KMS 키에 ARN 대신 키 별칭을 사용할 수 있습니다.  
새 클러스터로 복원하고 소스 클러스터를 암호화하는 데 사용된 AWS KMS 키와 다른 AWS KMS 키를 사용하여 새 클러스터를 암호화할 수 있습니다. 새 DB 클러스터는 `KmsKeyId` 파라미터로 식별되는 AWS KMS 키로 암호화됩니다.  
`KmsKeyId` 파라미터 값을 지정하지 않으면 다음과 같이 진행됩니다.  
+ 클러스터가 암호화된 경우 복원된 클러스터는 소스 클러스터를 암호화하는 데 사용된 AWS KMS 키를 사용하여 암호화됩니다.
+ 클러스터가 암호화되어 있지 않으면 복원된 클러스터도 암호화되지 않습니다.
`DBClusterIdentifier`가 암호화되지 않은 DB 클러스터를 가리키는 경우, 복원 요청이 거부됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** NetworkType **   
클러스터의 네트워크 유형입니다.  
네트워크 유형은 클러스터에 대해 지정된 `DBSubnetGroup`에 의해 결정됩니다. `DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(`DUAL`)만 지원할 수 있습니다.  
자세한 내용은 Amazon DocumentDB 개발자 안내서의 [VPC의 DocumentDB 클러스터](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)를 참조하세요.  
유효한 값: `IPV4` \$1 `DUAL`   
유형: 문자열  
필수 항목 여부: 아니요

 ** Port **   
새 클러스터에서 연결을 허용하는 포트 번호입니다.  
제약 조건: 값이 `1150`\$1`65535`여야 합니다.  
기본값: 엔진의 기본 포트입니다.  
유형: 정수  
필수 항목 여부: 아니요

 ** RestoreToTime **   
클러스터를 복원할 날짜 및 시간입니다.  
유효한 값: 협정 세계시(UTC) 형식의 시간.  
제약 조건:  
+ 인스턴스의 최근 복원 가능 시간보다 이전이어야 합니다.
+ `UseLatestRestorableTime` 파라미터를 제공하지 않은 경우에 지정해야 합니다.
+ `UseLatestRestorableTime` 파라미터가 `true`인 경우에는 지정할 수 없습니다.
+ `RestoreType` 파라미터가 `copy-on-write`인 경우에는 지정할 수 없습니다.
예시: `2015-03-07T23:45:00Z`   
유형: 타임스탬프  
필수 여부: 아니요

 ** RestoreType **   
수행할 복원의 유형입니다. 다음 값 중 하나를 지정할 수 있습니다.  
+  `full-copy` - 새 DB 클러스터가 소스 DB 클러스터의 전체 복사로서 복구됩니다.
+  `copy-on-write` - 새 DB 클러스터가 소스 DB 클러스터의 복제로서 복구됩니다.
제약: 소스 DB 클러스터의 엔진 버전이 1.11 이하인 경우 `copy-on-write`를 지정할 수 없습니다.  
`RestoreType` 값을 지정하지 않으면 새 DB 클러스터가 소스 DB 클러스터의 전체 복사로서 복구됩니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 클러스터의 규모 조정 구성을 포함합니다.  
유형: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)객체  
필수 여부: 아니요

 ** StorageType **   
DB 클러스터와 연결할 스토리지 유형입니다.  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 **Tags.Tag.N**   
복원된 클러스터에 할당할 태그입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수: 아니요

 ** UseLatestRestorableTime **   
클러스터를 복원 가능한 마지막 백업 시간으로 복원하려면 이 값을 `true`로 설정하고, 그렇지 않으면 `false`로 설정합니다.  
기본값: `false`   
제약 조건: `RestoreToTime` 파라미터를 제공한 경우에는 지정할 수 없습니다.  
유형: 부울  
필수 항목 여부: 아니요

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
새 클러스터가 속해 있는 VPC 보안 그룹의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterAlreadyExistsFault **   
해당 식별자를 사용하는 클러스터가 이미 있습니다.  
HTTP 상태 코드: 400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`는 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBClusterQuotaExceededFault **   
클러스터의 최대 허용 할당량에 도달했기 때문에 클러스터를 생성할 수 없습니다.  
HTTP 상태 코드: 403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier`는 기존 클러스터 스냅샷을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName`는 기존 서브넷 그룹을 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InsufficientDBClusterCapacityFault **   
현재의 작업을 하기에는 클러스터의 용량이 부족합니다.  
HTTP 상태 코드: 403

 ** InsufficientStorageClusterCapacity **   
현재의 작업에 사용할 스토리지가 부족합니다. 사용 가능한 스토리지가 더 많은 다른 가용 영역을 사용하도록 서브넷 그룹을 업데이트하여 이 오류를 해결할 수 있습니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterSnapshotStateFault **   
제공된 값은 유효한 클러스터 스냅샷 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBClusterStateFault **   
클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBSnapshotState **   
스냅샷의 상태로 인해 삭제할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidRestoreFault **   
Virtual Private Cloud(VPC) 백업에서 VPC가 아닌 DB 인스턴스로 복원할 수 없습니다.  
HTTP 상태 코드: 400

 ** InvalidSubnet **   
요청한 서브넷이 올바르지 않거나 공통 Virtual Private Cloud(VPC)에 모두 포함되지 않은 여러 서브넷이 요청되었습니다.  
HTTP 상태 코드: 400

 ** InvalidVPCNetworkStateFault **   
서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.  
HTTP 상태 코드: 400

 ** KMSKeyNotAccessibleFault **   
 AWS KMS 키에 액세스할 때 오류가 발생했습니다.  
HTTP 상태 코드: 400

 ** NetworkTypeNotSupported **   
네트워크 유형은 `DBSubnetGroup` 또는 DB 엔진 버전에서 지원되지 않습니다.  
HTTP 상태 코드: 400

 ** StorageQuotaExceeded **   
요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.  
HTTP 상태 코드: 400

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

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

# StartDBCluster
<a name="API_StartDBCluster"></a>

`DBClusterIdentifier`에서 지정한 중지된 클러스터를 다시 시작합니다. 자세한 내용은 [Amazon DocumentDB 클러스터 중단 및 시작](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) 섹션을 참조하십시오.

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

 모든 작업에 공통되는 파라미터에 관한 정보는 범용 [파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
재시작 클러스터의 식별자입니다. 예시: `docdb-2019-05-28-15-24-52`   
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# StopDBCluster
<a name="API_StopDBCluster"></a>

`DBClusterIdentifier`에서 지정한 실행 중인 클러스터를 중지합니다. 클러스터가 *사용 가능* 상태여야 합니다. 자세한 내용은 [Amazon DocumentDB 클러스터 중단 및 시작](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html) 섹션을 참조하십시오.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** DBClusterIdentifier **   
중지할 클러스터의 식별자입니다. 예시: `docdb-2019-05-28-15-24-52`   
유형: 문자열  
필수 항목 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** DBCluster **   
클러스터에 관한 자세한 정보입니다.  
타입: [DBCluster](API_DBCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidDBInstanceState **   
 지정된 인스턴스가 *사용 가능*한 상태가 아닙니다.  
HTTP 상태 코드: 400

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

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

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

지정된 보조 Amazon DocumentDB 클러스터를 글로벌 데이터베이스 클러스터의 새 기본 Amazon DocumentDB 클러스터로 전환합니다.

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

 모든 작업에 공통되는 파라미터에 대한 내용은 [공통 파라미터](CommonParameters.md)를 참조하십시오.

 ** GlobalClusterIdentifier **   
전환할 Amazon DocumentDB 글로벌 데이터베이스 클러스터의 식별자입니다. 식별자는 클러스터가 생성될 때 사용자가 할당한 고유 키입니다. 즉, 글로벌 클러스터의 이름입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.  
제약 조건:  
+ 기존 글로벌 클러스터(Amazon DocumentDB 글로벌 데이터베이스)의 식별자와 일치해야 합니다.
+ 최소 길이는 1이고, 최대 길이는 255.
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

 ** TargetDbClusterIdentifier **   
글로벌 데이터베이스 클러스터의 새 기본으로 승격할 보조 Amazon DocumentDB 클러스터의 식별자입니다. Amazon DocumentDB가 해당 리전에서 클러스터를 찾을 수 있도록 식별자에 Amazon 리소스 이름(ARN)을 사용합니다. AWS   
제약 조건:  
+ 기존 보조 클러스터의 식별자와 일치해야 합니다.
+ 최소 길이는 1이고, 최대 길이는 255.
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 예

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

서비스에서 다음 요소를 반환합니다.

 ** GlobalCluster **   
Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.  
타입: [GlobalCluster](API_GlobalCluster.md) 객체

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

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

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`은 기존 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier`는 기존 글로벌 클러스터를 참조하지 않습니다.  
HTTP 상태 코드: 404

 ** InvalidDBClusterStateFault **   
DB 클러스터가 유효한 상태가 아닙니다.  
HTTP 상태 코드: 400

 ** InvalidGlobalClusterStateFault **   
클러스터가 이 상태인 동안에는 요청된 작업을 수행할 수 없습니다.  
HTTP 상태 코드: 400

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

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

# 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) 

# 데이터 타입
<a name="API_Types"></a>

다음 데이터 형식은 Amazon DocumentDB (with MongoDB compatibility)에서 지원됩니다.
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

Amazon DocumentDB Elastic Clusters에서 지원되는 데이터 유형은 다음과 같습니다.
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Types_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

다음 데이터 형식은 Amazon DocumentDB (with MongoDB compatibility)에서 지원됩니다.
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [Certificate](API_Certificate.md) 
+  [CertificateDetails](API_CertificateDetails.md) 
+  [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 
+  [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 
+  [DBCluster](API_DBCluster.md) 
+  [DBClusterMember](API_DBClusterMember.md) 
+  [DBClusterParameterGroup](API_DBClusterParameterGroup.md) 
+  [DBClusterRole](API_DBClusterRole.md) 
+  [DBClusterSnapshot](API_DBClusterSnapshot.md) 
+  [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 
+  [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 
+  [DBEngineVersion](API_DBEngineVersion.md) 
+  [DBInstance](API_DBInstance.md) 
+  [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 
+  [DBSubnetGroup](API_DBSubnetGroup.md) 
+  [Endpoint](API_Endpoint.md) 
+  [EngineDefaults](API_EngineDefaults.md) 
+  [Event](API_Event.md) 
+  [EventCategoriesMap](API_EventCategoriesMap.md) 
+  [EventSubscription](API_EventSubscription.md) 
+  [FailoverState](API_FailoverState.md) 
+  [Filter](API_Filter.md) 
+  [GlobalCluster](API_GlobalCluster.md) 
+  [GlobalClusterMember](API_GlobalClusterMember.md) 
+  [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 
+  [Parameter](API_Parameter.md) 
+  [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 
+  [PendingMaintenanceAction](API_PendingMaintenanceAction.md) 
+  [PendingModifiedValues](API_PendingModifiedValues.md) 
+  [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 
+  [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 
+  [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 
+  [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 
+  [Subnet](API_Subnet.md) 
+  [Tag](API_Tag.md) 
+  [UpgradeTarget](API_UpgradeTarget.md) 
+  [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

가용 영역과 관련된 정보입니다.

## 내용
<a name="API_AvailabilityZone_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 설명되어 있습니다.

 ** Name **   
가용 영역의 이름입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

# Certificate
<a name="API_Certificate"></a>

에 대한 인증 기관 (CA) 인증서입니다AWS 계정.

## 내용
<a name="API_Certificate_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 설명되어 있습니다.

 ** CertificateArn **   
인증서에 대한 Amazon 리소스 이름(ARN)입니다.  
예시: `arn:aws:rds:us-east-1::cert:rds-ca-2019`   
유형: 문자열  
필수 여부: 아니요

 ** CertificateIdentifier **   
인증서를 식별하는 고유한 키입니다.  
예시: `rds-ca-2019`   
유형: 문자열  
필수 여부: 아니요

 ** CertificateType **   
인증서의 유형입니다.  
예시: `CA`   
유형: 문자열  
필수 여부: 아니요

 ** Thumbprint **   
인증서의 지문.  
유형: 문자열  
필수 여부: 아니요

 ** ValidFrom **   
인증서가 유효한 시작 날짜/시간입니다.  
예시: `2019-07-31T17:57:09Z`   
유형: 타임스탬프  
필수 여부: 아니요

 ** ValidTill **   
인증서가 더 이상 유효하지 않은 날짜-시간입니다.  
예시: `2024-07-31T17:57:09Z`   
유형: 타임스탬프  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) 

# CertificateDetails
<a name="API_CertificateDetails"></a>

DB 인스턴스의 서버 인증서 세부 정보를 반환합니다.

자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 [Amazon DocumentDB TLS 인증서 업데이트](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) 및 [전송 중 데이터 암호화](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)를 참조하십시오.

## 내용
<a name="API_CertificateDetails_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 설명되어 있습니다.

 ** CAIdentifier **   
DB 인스턴스의 서버 인증서에 사용되는 CA 인증서의 CA 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** ValidTill **   
DB 인스턴스 서버 인증서의 만료 날짜.  
유형: 타임스탬프  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) 

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

특정 인스턴스 또는 클러스터에 대하여 Amazon CloudWatch Logs로 내보내기를 활성화할 로그 유형의 구성 설정입니다.

`EnableLogTypes` 및 `DisableLogTypes` 배열이 CloudWatch Logs로 내보내는(또는 내보내지 않을) 로그를 결정합니다. 이러한 배열 내의 값은 사용 중인 엔진에 따라 달라집니다.

## 내용
<a name="API_CloudwatchLogsExportConfiguration_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 설명되어 있습니다.

 ** DisableLogTypes.member.N **   
비활성화할 로그 유형의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** EnableLogTypes.member.N **   
활성화할 로그 유형의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

마스터 사용자 암호용으로 AWS Secrets Manager에서 Amazon DocumentDB가 관리하는 보안 암호를 포함합니다.

## 내용
<a name="API_ClusterMasterUserSecret_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** KmsKeyId **   
보안 암호를 암호화하는 데 사용되는 AWS KMS 키 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** SecretArn **   
보안 암호의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** SecretStatus **   
비밀의 상태입니다.  
가능한 상태 값에는 다음이 포함됩니다.  
+ 생성 - 비밀이 생성 중입니다.
+ 활성 - 비밀의 일반적 사용 및 교체가 가능합니다.
+ 교체 - 비밀이 교체 중입니다.
+ 손상 - 비밀을 데이터베이스 보안 인증 정보에 액세스하는 데 사용할 수 있지만 교체할 수는 없습니다. 예를 들어 권한이 변경되어 Amazon DocumentDB가 더 이상 보안 암호 또는 보안 암호의 KMS 키에 액세스할 수 없는 경우 보안 비밀이 이 상태가 될 수 있습니다.

  암호가 이 상태인 경우 상태를 초래한 조건을 수정할 수 있습니다. 또는 인스턴스를 수정하여 데이터베이스 보안 인증 정보 자동 관리를 해제한 다음 인스턴스를 다시 수정하여 데이터베이스 보안 인증 정보 자동 관리를 켤 수 있습니다.
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) 

# DBCluster
<a name="API_DBCluster"></a>

클러스터에 관한 자세한 정보.

## 내용
<a name="API_DBCluster_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터에 대해 먼저 설명합니다.

 ** AssociatedRoles.DBClusterRole.N **   
클러스터와 연결된 AWS Identity and Access Management (IAM) 역할의 목록을 제공합니다. 클러스터와 연결된 IAM 역할은 사용자 대신 다른 AWS 서비스에 액세스할 수 있도록 클러스터에 대한 권한을 부여합니다.  
타입: [DBClusterRole](API_DBClusterRole.md)객체 배열  
필수 여부: 아니요

 ** AvailabilityZones.AvailabilityZone.N **   
클러스터의 인스턴스를 생성할 수 있는 Amazon EC2 가용 영역의 목록을 제공합니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** BackupRetentionPeriod **   
자동 스냅샷이 보관되는 일수를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** CloneGroupId **   
DB 클러스터와 연결되어 있는 복제 그룹을 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** ClusterCreateTime **   
클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** DBClusterArn **   
클러스터의 Amazon 리소스 이름(ARN).  
유형: 문자열  
필수 여부: 아니요

 ** DBClusterIdentifier **   
사용자가 제공한 클러스터 식별자가 포함되어 있습니다. 이 식별자는 클러스터를 식별하는 고유한 키입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBClusterMembers.DBClusterMember.N **   
클러스터를 구성하는 인스턴스의 목록을 제공합니다.  
타입: [DBClusterMember](API_DBClusterMember.md)객체 배열  
필수 여부: 아니요

 ** DBClusterParameterGroup **   
클러스터에 사용할 클러스터 파라미터 그룹의 이름을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DbClusterResourceId **   
클러스터의 AWS 리전별로 고유하며 변경 불가능한 식별자. 클러스터의 AWS KMS 키에 액세스할 때마다 AWS CloudTrail 로그 항목에 이 식별자가 나타납니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBSubnetGroup **   
이름, 설명 및 서브넷 그룹 내의 서브넷 등 클러스터와 연결된 서브넷 그룹에 대한 정보를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DeletionProtection **   
이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. `DeletionProtection`이 활성화되면 클러스터를 수정하고 `DeletionProtection` 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. `DeletionProtection`은 클러스터가 실수로 삭제되지 않도록 보호합니다.  
유형: 부울  
필수 여부: 아니요

 ** EarliestRestorableTime **   
특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 이른 시간.  
유형: 타임스탬프  
필수 여부: 아니요

 ** EnabledCloudwatchLogsExports.member.N **   
이 클러스터에서 Amazon CloudWatch Logs로 내보내도록 구성된 로그 유형의 목록.  
유형: 문자열 배열  
필수 여부: 아니요

 ** Endpoint **   
클러스터의 기본 인스턴스에 대한 연결 엔드포인트를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** Engine **   
이 클러스터에 사용할 데이터베이스 엔진의 이름을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
데이터베이스 엔진의 버전을 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** HostedZoneId **   
호스팅 영역을 생성할 때 Amazon Route 53에서 할당하는 ID를 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** IOOptimizedNextAllowedModificationTime **   
다음번에 Amazon DocumentDB 클러스터를 수정하여 iopt1 스토리지 유형을 사용하도록 할 수 있습니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** KmsKeyId **   
`StorageEncrypted`이 `true`인 경우, 암호화된 클러스터의 AWS KMS 키 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** LatestRestorableTime **   
특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 늦은 시간을 지정합니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** MasterUsername **   
클러스터의 마스터 사용자 이름이 포함되어 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** MasterUserSecret **   
마스터 사용자 암호용으로 AWS Secrets Manager에서 Amazon DocumentDB가 관리하는 보안 암호입니다.  
유형: [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)객체  
필수 여부: 아니요

 ** MultiAZ **   
클러스터에 여러 가용 영역의 인스턴스가 있는지 여부를 나타냅니다.  
유형: 부울  
필수 여부: 아니요

 ** NetworkType **   
클러스터의 네트워크 유형입니다.  
네트워크 유형은 클러스터에 대해 지정된 `DBSubnetGroup`에 의해 결정됩니다. `DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(`DUAL`)만 지원할 수 있습니다.  
자세한 내용은 Amazon DocumentDB 개발자 안내서의 [VPC의 DocumentDB 클러스터](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)를 참조하세요.  
유효한 값: `IPV4` \$1 `DUAL`   
유형: 문자열  
필수 여부: 아니요

 ** PercentProgress **   
작업의 진행 상황을 백분율로 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** Port **   
데이터베이스 엔진이 수신 대기하는 포트를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** PreferredBackupWindow **   
자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위를 나타내며, `BackupRetentionPeriod` 속성에 의해 결정됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** PreferredMaintenanceWindow **   
시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** ReaderEndpoint **   
클러스터에 대한 리더 엔드포인트입니다. 클러스터의 리더 엔드포인트는 클러스터에서 사용 가능한 Amazon DocumentDB 복제본 간의 연결을 로드 밸런싱합니다. 클라이언트가 리더 엔드포인트에 대한 새로운 연결을 요청하면 Amazon DocumentDB는 클러스터 내의 Amazon DocumentDB 복제본 간에 연결 요청을 분배합니다. 이 기능은 클러스터 내의 여러 Amazon DocumentDB 복제본 간에 읽기 워크로드의 균형을 유지하는 데 도움이 됩니다.  
장애 조치가 발생하고 사용자와 연결된 Amazon DocumentDB 복제본이 기본 인스턴스로 승격되면 연결이 끊어집니다. 읽기 워크로드를 클러스터 내의 다른 Amazon DocumentDB 복제본으로 계속 전송하려면 리더 엔드포인트에 다시 연결하면 됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
이 클러스터와 연결된 보조 클러스터의 식별자를 하나 이상 포함합니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** ReplicationSourceIdentifier **   
이 클러스터가 보조 클러스터인 경우 소스 클러스터의 식별자를 포함합니다.  
유형: 문자열  
필수 여부: 아니요

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 클러스터의 조정 구성입니다.  
유형: [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)객체  
필수 여부: 아니요

 ** Status **   
이 클러스터의 현재 상태를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** StorageEncrypted **   
클러스터의 암호화 여부를 지정합니다.  
유형: 부울  
필수 여부: 아니요

 ** StorageType **   
클러스터와 연결된 스토리지 유형  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
유형: 문자열  
필수 여부: 아니요

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
클러스터가 속한 Virtual Private Cloud(VPC) 보안 그룹의 목록을 제공합니다.  
타입: [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) 

# DBClusterMember
<a name="API_DBClusterMember"></a>

클러스터에 포함된 인스턴스에 관한 정보가 나와 있습니다.

## 내용
<a name="API_DBClusterMember_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 먼저 설명되어 있습니다.

 ** DBClusterParameterGroupStatus **   
이 DB 클러스터 멤버에 사용할 클러스터 파라미터 그룹의 상태를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceIdentifier **   
이 클러스터 멤버의 인스턴스 식별자를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** IsClusterWriter **   
클러스터 멤버가 클러스터의 기본 인스턴스이면 `true`이고, 그렇지 않으면 `false`인 값입니다.  
유형: 부울  
필수 여부: 아니요

 ** PromotionTier **   
기존 기본 인스턴스에 결함이 발생한 후 Amazon DocumentDB 복제본을 기본 인스턴스로 승격할 순서를 지정하는 값   
유형: Integer  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) 

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

클러스터 파라미터 그룹의 상세 정보입니다.

## 내용
<a name="API_DBClusterParameterGroup_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** DBClusterParameterGroupArn **   
클러스터 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBClusterParameterGroupName **   
클러스터 파라미터 그룹의 이름을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBParameterGroupFamily **   
이 클러스터 파라미터 그룹과 호환되는 파라미터 그룹 패밀리의 이름을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** Description **   
이 클러스터 파라미터 그룹에 대한 고객 설명을 제공합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) 

# DBClusterRole
<a name="API_DBClusterRole"></a>

클러스터와 연결되어 있는 AWS Identity and Access Management (IAM) 역할을 설명합니다.

## 내용
<a name="API_DBClusterRole_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** RoleArn **   
DB 클러스터와 연결되어 있는 IAMrole의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Status **   
IAMrole과 클러스터 간의 연결 상태를 설명합니다. `Status` 속성은 다음 값 중 하나를 반환합니다.  
+  `ACTIVE` - IAMrole ARN은 클러스터와 연결되어 있고, 이를 통해 사용자 대신 다른 AWS 서비스에 액세스할 수 있습니다.
+  `PENDING` - IAMrole ARN을 클러스터와 연결하는 중입니다.
+  `INVALID` - IAMrole ARN은 클러스터와 연결되어 있지만, 사용자 대신 다른 AWS 서비스에 액세스하기 위해 클러스터가 그 IAMrole을 맡을 수 없습니다.
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) 

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

클러스터 스냅샷에 대한 세부 정보입니다.

## 내용
<a name="API_DBClusterSnapshot_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AvailabilityZones.AvailabilityZone.N **   
클러스터 스냅샷의 인스턴스를 복원할 수 있는 Amazon EC2 가용 영역 목록을 제공합니다.  
유형: 문자열 배열  
필수 항목 여부: 아니요

 ** ClusterCreateTime **   
클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** DBClusterIdentifier **   
이 클러스터 스냅샷을 생성한 클러스터의 클러스터 식별자를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBClusterSnapshotArn **   
클러스터의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBClusterSnapshotIdentifier **   
클러스터 스냅샷의 식별자를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** Engine **   
데이터베이스 엔진의 이름을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
이 클러스터 스냅샷에 사용할 데이터베이스 엔진의 버전을 알려 줍니다.  
유형: 문자열  
필수 여부: 아니요

 ** KmsKeyId **   
`StorageEncrypted`가 `true`인 경우, 암호화된 클러스터 스냅샷의 AWS KMS 키 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** MasterUsername **   
클러스터 스냅샷의 마스터 사용자 이름을 알려 줍니다.  
유형: 문자열  
필수 여부: 아니요

 ** PercentProgress **   
전송된 데이터의 추정 백분율을 나타냅니다.  
유형: Integer  
필수 여부: 아니요

 ** Port **   
스냅샷 생성 시점에 클러스터가 수신하던 포트를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** SnapshotCreateTime **   
스냅샷이 생성된 시간을 나타냅니다(협정 세계시(UTC)).  
유형: 타임스탬프  
필수 여부: 아니요

 ** SnapshotType **   
클러스터 스냅샷의 유형을 알려 줍니다.  
유형: 문자열  
필수 여부: 아니요

 ** SourceDBClusterSnapshotArn **   
클러스터 스냅샷을 소스 클러스터 스냅샷에서 복사한 경우 그 소스 클러스터 스냅샷의 ARN이고, 그렇지 않으면 null 값입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Status **   
이 클러스터 스냅샷의 상태를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** StorageEncrypted **   
클러스터 스냅샷의 암호화 여부를 지정합니다.  
유형: 부울  
필수 여부: 아니요

 ** StorageType **   
클러스터 스냅샷과 연결된 스토리지 유형  
Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 클러스터 스토리지 구성을 참조하세요.  
스토리지 유형에 유효한 값 - `standard | iopt1`   
기본값은 `standard `입니다.  
유형: 문자열  
필수 여부: 아니요

 ** VpcId **   
클러스터 스냅샷과 연결된 Virtual Private Cloud(VPC) ID를 제공합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) 

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

수동 클러스터 스냅샷 속성의 이름과 값이 포함되어 있습니다.

수동 클러스터 스냅샷 속성은 다른 AWS 계정에서 수동 클러스터 스냅샷을 복원할 수 있도록 승인하는 데 사용됩니다.

## 내용
<a name="API_DBClusterSnapshotAttribute_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AttributeName **   
수동 클러스터 스냅샷 속성의 이름입니다.  
`restore`라는 속성은 수동 클러스터 스냅샷을 복사하거나 복원할 권한이 있는 AWS 계정의 목록을 가리킵니다.  
유형: 문자열  
필수 여부: 아니요

 ** AttributeValues.AttributeValue.N **   
수동 클러스터 스냅샷 속성의 값  
`AttributeName` 필드가 `restore`로 설정된 경우, 이 요소는 수동 클러스터 스냅샷을 복사하거나 복원할 권한이 있는 AWS 계정의 ID 목록을 반환합니다. 이 목록에 `all` 값이 있으면 수동 클러스터 스냅샷은 퍼블릭 스냅샷이며 모든 AWS 계정에서 복사하거나 복원할 수 있습니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) 

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

클러스터 스냅샷과 관련된 속성에 대한 세부 정보입니다.

## 내용
<a name="API_DBClusterSnapshotAttributesResult_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
클러스터 스냅샷의 속성과 값 목록입니다.  
타입: [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)객체 배열  
필수 여부: 아니요

 ** DBClusterSnapshotIdentifier **   
해당 속성이 적용되는 클러스터 스냅샷의 식별자입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 엔진 버전에 대한 상세 정보입니다.

## 내용
<a name="API_DBEngineVersion_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** DBEngineDescription **   
데이터베이스 엔진에 대한 설명입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBEngineVersionDescription **   
데이터베이스 엔진 버전에 대한 설명입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBParameterGroupFamily **   
데이터베이스 엔진에 사용할 파라미터 그룹 패밀리의 이름입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Engine **   
데이터베이스 엔진의 이름입니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
데이터베이스 엔진의 버전 번호입니다.  
유형: 문자열  
필수 여부: 아니요

 ** ExportableLogTypes.member.N **   
데이터베이스 엔진에서 Amazon CloudWatch Logs로 내보낼 수 있는 로그 유형입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** ServerlessV2FeaturesSupport **   
Amazon DocumentDB 엔진 버전마다 다른 Amazon DocumentDB Serverless 속성 또는 제한을 지정합니다. 새 클러스터 또는 업그레이드된 클러스터에서 사용할 Amazon DocumentDB 버전을 결정할 때 이 속성의 값을 테스트할 수 있습니다. 기존 클러스터의 버전을 검색하고 해당 버전을 사용하기 전에 해당 버전이 특정 Amazon DocumentDB Serverless 기능을 지원하는지 확인할 수도 있습니다.  
유형: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)객체  
필수 여부: 아니요

 ** SupportedCACertificateIdentifiers.member.N **   
지원되는 CA 인증서 식별자 목록  
자세한 내용은 *Amazon DocumentDB 개발자 안내서*의 [Amazon DocumentDB TLS 인증서 업데이트](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) 및 [전송 중 데이터 암호화](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)를 참조하십시오.  
유형: 문자열 배열  
필수 여부: 아니요

 ** SupportsCertificateRotationWithoutRestart **   
엔진 버전이 DB 인스턴스를 재부팅하지 않고 서버 인증서 교체를 지원하는지를 나타냅니다.  
유형: 부울  
필수 여부: 아니요

 ** SupportsLogExportsToCloudwatchLogs **   
CloudWatch Logs로 내보내도록 `ExportableLogTypes`에 지정된 로그 유형을 해당 엔진 버전에서 지원하는지 여부를 나타내는 값입니다.  
유형: 부울  
필수 여부: 아니요

 ** ValidUpgradeTarget.UpgradeTarget.N **   
이 데이터베이스 엔진 버전을 업그레이드할 수 있는 엔진 버전의 목록입니다.  
타입: [UpgradeTarget](API_UpgradeTarget.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) 

# DBInstance
<a name="API_DBInstance"></a>

인스턴스에 대한 자세한 정보입니다.

## 내용
<a name="API_DBInstance_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AutoMinorVersionUpgrade **   
적용되지 않습니다. 이 파라미터는 Amazon DocumentDB에는 적용되지 않습니다. Amazon DocumentDB는 값 세트에 관계없이 마이너 버전 업그레이드를 수행하지 않습니다.  
유형: 부울  
필수 여부: 아니요

 ** AvailabilityZone **   
인스턴스가 있는 가용 영역의 이름을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** BackupRetentionPeriod **   
자동 스냅샷이 보관되는 일수를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** CACertificateIdentifier **   
이 DB 인스턴스의 CA 인증서 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** CertificateDetails **   
DB 인스턴스의 서버 인증서의 세부 정보입니다.  
유형: [CertificateDetails](API_CertificateDetails.md)객체  
필수 여부: 아니요

 ** CopyTagsToSnapshot **   
태그를 DB 인스턴스에서 DB 인스턴스의 스냅샷으로 복사할지 여부를 나타내는 값입니다. 태그는 기본적으로 복사되지 않습니다.  
유형: 부울  
필수 여부: 아니요

 ** DBClusterIdentifier **   
해당 인스턴스가 어떤 클러스터의 멤버인 경우, 그 인스턴스가 속해 있는 클러스터의 이름이 나와 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceArn **   
인스턴스의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceClass **   
인스턴스의 컴퓨팅 및 메모리 용량 클래스 이름을 포함합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceIdentifier **   
사용자가 제공한 데이터베이스 ID가 포함되어 있습니다. 이 ID는 인스턴스를 식별하는 고유한 키입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceStatus **   
이 데이터베이스의 현재 상태를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DbiResourceId **   
AWS 리전별로 고유하며 변경 불가능한 인스턴스 식별자입니다. 인스턴스의 AWS KMS 키에 액세스할 때마다 AWS CloudTrail 로그 항목에 이 식별자가 나타납니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBSubnetGroup **   
이름, 설명, 그리고 서브넷 그룹 내의 서브넷 등 인스턴스와 연결된 서브넷 그룹에 대한 정보를 지정합니다.  
유형: [DBSubnetGroup](API_DBSubnetGroup.md)객체  
필수 여부: 아니요

 ** EnabledCloudwatchLogsExports.member.N **   
이 인스턴스에서 CloudWatch Logs로 내보내도록 구성된 로그 유형의 목록입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** Endpoint **   
연결 엔드포인트를 지정합니다.  
유형: [Endpoint](API_Endpoint.md)객체  
필수 여부: 아니요

 ** Engine **   
이 인스턴스에 사용할 데이터베이스 엔진의 이름을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
데이터베이스 엔진의 버전을 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** InstanceCreateTime **   
인스턴스를 생성한 날짜 및 시간입니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** KmsKeyId **   
 `StorageEncrypted`가 `true`인 경우, 암호화된 DB 인스턴스의 AWS KMS 키 식별자입니다.  
유형: 문자열  
필수 여부: 아니요

 ** LatestRestorableTime **   
특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 늦은 시간을 지정합니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** PendingModifiedValues **   
인스턴스에 대한 변경 사항이 대기 중임을 나타냅니다. 이 요소는 변경 사항이 대기 중일 때만 포함됩니다. 구체적인 변경 사항은 하위 요소로 식별됩니다.  
유형: [PendingModifiedValues](API_PendingModifiedValues.md)객체  
필수 여부: 아니요

 ** PerformanceInsightsEnabled **   
DB 인스턴스에 대해 Amazon RDS Performance Insights가 활성 상태이면 `true`이고, 그렇지 않으면 `false`로 설정합니다.  
유형: 부울  
필수 여부: 아니요

 ** PerformanceInsightsKMSKeyId **   
성능 개선 도우미 데이터의 암호화를 위한 AWS KMS 키 식별자 AWS KMS 키 ID는 Amazon 리소스 이름(ARN), AWS KMS 키 식별자 또는 AWS KMS 암호화 키에 대한 AWS KMS 키 별칭입니다.  
유형: 문자열  
필수 여부: 아니요

 ** PreferredBackupWindow **   
 자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위를 나타내며, `BackupRetentionPeriod` 속성에 의해 결정됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** PreferredMaintenanceWindow **   
시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** PromotionTier **   
기존 기본 인스턴스에 결함이 발생한 후 Amazon DocumentDB 복제본을 기본 인스턴스로 승격할 순서를 지정하는 값  
유형: Integer  
필수 여부: 아니요

 ** PubliclyAccessible **   
지원하지 않음. Amazon DocumentDB는 현재 퍼블릭 엔드포인트를 지원하지 않습니다. `PubliclyAccessible` 값은 항상 `false`입니다.  
유형: 부울  
필수 여부: 아니요

 ** StatusInfos.DBInstanceStatusInfo.N **   
읽기 전용 복제본의 상태입니다. 인스턴스가 읽기 전용 복제본이 아닌 경우 비어 있습니다.  
타입: [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)객체 배열  
필수 여부: 아니요

 ** StorageEncrypted **   
인스턴스의 암호화 여부를 지정합니다.  
유형: 부울  
필수 여부: 아니요

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
인스턴스가 속해 있는 VPC 보안 그룹 요소의 목록을 제공합니다.  
타입: [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) 

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

인스턴스에 대한 상태 정보 목록을 제공합니다.

## 내용
<a name="API_DBInstanceStatusInfo_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** Message **   
인스턴스에 오류가 있는 경우, 오류에 대한 세부 정보입니다. 인스턴스가 오류 상태가 아니면 이 값은 비어 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** Normal **   
인스턴스가 정상 작동 중이면 `true`이고 인스턴스가 오류 상태이면 `false`인 부울 값입니다.  
유형: 부울  
필수 여부: 아니요

 ** Status **   
인스턴스의 상태입니다. 읽기 전용 `StatusType` 복제본의 경우 값은 `replicating`, error, `stopped` 또는 `terminated`일 수 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** StatusType **   
현재 이 값은 “`read replication`“입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) 

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

서브넷 그룹에 대한 자세한 정보.

## 내용
<a name="API_DBSubnetGroup_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** DBSubnetGroupArn **   
DB 서브넷 그룹의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBSubnetGroupDescription **   
서브넷 그룹에 대한 설명을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBSubnetGroupName **   
서브넷 그룹의 이름입니다.  
유형: 문자열  
필수 여부: 아니요

 ** SubnetGroupStatus **   
서브넷 그룹의 상태를 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** Subnets.Subnet.N **   
서브넷 그룹에 있는 하나 이상의 서브넷에 대한 세부적인 정보입니다.  
타입: [Subnet](API_Subnet.md)객체 배열  
필수 여부: 아니요

 ** SupportedNetworkTypes.member.N **   
DB 서브넷 그룹의 네트워크 유형입니다.  
유효한 값: `IPV4` \$1 `DUAL`   
`DBSubnetGroup`은 IPv4 프로토콜 또는 IPv4 및 IPv6 프로토콜(DUAL)만 지원할 수 있습니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** VpcId **   
서브넷 그룹의 Virtual Private Cloud (VPC)의 ID를 제공합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) 

# Endpoint
<a name="API_Endpoint"></a>

클러스터 또는 인스턴스에 액세스하기 위한 네트워크 정보. 클라이언트 프로그램이 이러한 Amazon DocumentDB 리소스에 액세스하려면 유효한 엔드포인트를 지정해야 합니다.

## 내용
<a name="API_Endpoint_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** Address **   
인스턴스의 DNS 주소를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** HostedZoneId **   
호스팅 영역을 생성할 때 Amazon Route 53에서 할당하는 ID를 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** Port **   
데이터베이스 엔진이 수신 대기하는 포트를 지정합니다.  
유형: Integer  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) 

# EngineDefaults
<a name="API_EngineDefaults"></a>

`DescribeEngineDefaultClusterParameters` 작업의 성공적인 간접 호출의 결과가 포함되어 있습니다.

## 내용
<a name="API_EngineDefaults_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터에 대해 먼저 설명합니다.

 ** DBParameterGroupFamily **   
엔진 파라미터 정보를 반환할 클러스터 파라미터 그룹 패밀리의 이름입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Marker **   
이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 `MaxRecords`에 지정된 값까지의 레코드만 응답에 포함됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** Parameters.Parameter.N **   
특정 클러스터 파라미터 그룹 패밀리의 파라미터.  
타입: [Parameter](API_Parameter.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) 

# Event
<a name="API_Event"></a>

이벤트에 대한 자세한 정보.

## 내용
<a name="API_Event_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터에 대해 먼저 설명합니다.

 ** Date **   
이벤트 날짜 및 시간을 지정합니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** EventCategories.EventCategory.N **   
이 이벤트의 범주를 지정합니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** Message **   
이 이벤트의 텍스트를 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** SourceArn **   
이벤트의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** SourceIdentifier **   
이벤트 소스의 식별자를 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** SourceType **   
이 이벤트의 소스 유형을 지정합니다.  
타입: 문자열  
유효 값: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) 

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

하나 이상의 이벤트 범주 이름이 포함된 이벤트 소스 유형입니다.

## 내용
<a name="API_EventCategoriesMap_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** EventCategories.EventCategory.N **   
지정된 소스 유형의 이벤트 범주입니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** SourceType **   
반환된 범주의 소스 유형입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) 

# EventSubscription
<a name="API_EventSubscription"></a>

구독한 이벤트에 대한 세부 정보.

## 내용
<a name="API_EventSubscription_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터에 대해 먼저 설명합니다.

 ** CustomerAwsId **   
Amazon DocumentDB 이벤트 알림 구독과 관련된 AWS 고객 계정.  
유형: 문자열  
필수 여부: 아니요

 ** CustSubscriptionId **   
Amazon DocumentDB 이벤트 알림 구독 ID.  
유형: 문자열  
필수 여부: 아니요

 ** Enabled **   
구독의 활성화 여부를 나타내는 부울 값. `true`의 값은 구독이 활성화되었음을 나타냅니다.  
유형: 부울  
필수 여부: 아니요

 ** EventCategoriesList.EventCategory.N **   
Amazon DocumentDB 이벤트 알림 구독에 대한 이벤트 카테고리의 목록.  
유형: 문자열 배열  
필수 여부: 아니요

 ** EventSubscriptionArn **   
이벤트 구독의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 여부: 아니요

 ** SnsTopicArn **   
Amazon DocumentDB 이벤트 알림 구독의 주제 ARN.  
유형: 문자열  
필수 여부: 아니요

 ** SourceIdsList.SourceId.N **   
Amazon DocumentDB 이벤트 알림 구독의 소스 ID 목록.  
유형: 문자열 배열  
필수 여부: 아니요

 ** SourceType **   
Amazon DocumentDB 이벤트 알림 구독의 소스 유형.  
유형: 문자열  
필수 여부: 아니요

 ** Status **   
Amazon DocumentDB 이벤트 알림 구독의 상태.  
제약 조건:  
`creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist` 중 하나가 될 수 있습니다.  
`no-permission` 상태는 Amazon DocumentDB가 더 이상 SNS 주제에 게시할 수 있는 권한이 없음을 나타냅니다. `topic-not-exist` 상태는 구독이 생성된 후 주제가 삭제되었음을 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** SubscriptionCreationTime **   
Amazon DocumentDB 이벤트 알림 구독이 생성된 시간.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) 

# FailoverState
<a name="API_FailoverState"></a>

Amazon DocumentDB 글로벌 클러스터에서 예약된 작업 또는 진행 중인 작업의 상태를 포함합니다. 이 데이터 유형은 글로벌 클러스터에서 전환 또는 장애 조치 작업이 예약되거나 진행 중이 아닌 한 비어 있습니다.

## 내용
<a name="API_FailoverState_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** FromDbClusterArn **   
현재 강등되고 있으며이 상태와 연결된 Amazon DocumentDB 클러스터의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** IsDataLossAllowed **   
작업이 글로벌 전환인지 글로벌 장애 조치인지 나타냅니다. 데이터 손실이 허용되는 경우 작업은 글로벌 장애 조치입니다. 그렇지 않으면 전환입니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Status **   
글로벌 클러스터의 현재 상태입니다. 가능한 값은 다음과 같습니다.  
+  **보류 중** - 서비스가 글로벌 클러스터를 전환하거나 장애 조치하라는 요청을 받았습니다. 작업이 시작되기 전에 글로벌 클러스터의 기본 클러스터와 지정된 보조 클러스터가 확인되고 있습니다.
+  **장애 조치 -** 선택한 보조 클러스터가 글로벌 클러스터를 장애 조치할 새 기본 클러스터로 승격되고 있습니다.
+  **취소 **- 글로벌 클러스터를 전환하거나 장애 조치하라는 요청이 취소되었으며 기본 클러스터와 선택한 보조 클러스터가 이전 상태로 돌아갑니다.
타입: 문자열  
유효 값: `pending | failing-over | cancelling`   
필수 여부: 아니요

 ** ToDbClusterArn **   
현재 승격 중이고이 상태와 연결된 Amazon DocumentDB 클러스터의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDKs
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) 

# Filter
<a name="API_Filter"></a>

보다 구체적인 결과 목록을 반환하는 데 사용되는 이름이 지정된 필터 값 세트. 필터를 사용하여 ID와 같은 특정 기준에 따라 리소스 집합을 일치시킬 수 있습니다.

와일드카드는 필터에서 지원되지 않습니다.

## 내용
<a name="API_Filter_Contents"></a>

**참고**  
다음 목록에서 필요한 파라미터가 먼저 설명되어 있습니다.

 ** Name **   
필터의 이름. 필터 이름은 대/소문자를 구분합니다.  
유형: 문자열  
필수 항목 여부: 예

 ** Values.Value.N **   
하나 이상의 필터 값. 필터 값은 대소문자를 구분합니다.  
유형: 문자열 배열  
필수 여부: 예

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) 

# GlobalCluster
<a name="API_GlobalCluster"></a>

Amazon DocumentDB 글로벌 클러스터를 나타내는 데이터 유형.

## 내용
<a name="API_GlobalCluster_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 먼저 설명되어 있습니다.

 ** DatabaseName **   
새 글로벌 클러스터 내의 기본 데이터베이스 이름.  
유형: 문자열  
필수 항목 여부: 아니요

 ** DeletionProtection **   
새 글로벌 클러스터에 대한 삭제 방지 설정.  
유형: 부울  
필수 항목 여부: 아니요

 ** Engine **   
글로벌 클러스터에서 사용하는 Amazon DocumentDB 데이터베이스 엔진.  
유형: 문자열  
필수 항목 여부: 아니요

 ** EngineVersion **   
데이터베이스 엔진의 버전을 나타냅니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** FailoverState **   
이 글로벌 클러스터에 대해 진행 중이거나 보류 중인 전환 또는 장애 조치 프로세스의 현재 상태에 대한 모든 속성을 포함하는 데이터 객체입니다. 이 글로벌 클러스터에서 `SwitchoverGlobalCluster` 또는 `FailoverGlobalCluster` 작업을 호출하지 않는 한이 객체는 비어 있습니다.  
유형: [FailoverState](API_FailoverState.md)객체  
필수 여부: 아니요

 ** GlobalClusterArn **   
글로벌 클러스터의 Amazon 리소스 이름(ARN).  
유형: 문자열  
필수 항목 여부: 아니요

 ** GlobalClusterIdentifier **   
사용자가 제공한 글로벌 클러스터 식별자가 포함되어 있습니다. 이 식별자는 글로벌 클러스터를 식별하는 고유한 키입니다.  
유형: 문자열  
길이 제약: 최소 길이는 1. 최대 길이는 255.  
패턴: `[A-Za-z][0-9A-Za-z-:._]*`   
필수 여부: 아니요

 ** GlobalClusterMembers.GlobalClusterMember.N **   
글로벌 클러스터 내 보조 클러스터의 클러스터 ID 목록. 현재 한 항목으로 제한됨.  
타입: [GlobalClusterMember](API_GlobalClusterMember.md)객체 배열  
필수: 아니요

 ** GlobalClusterResourceId **   
글로벌 데이터베이스 클러스터의 AWS 리전리전 고유하고 변경 불가능한 식별자입니다. 이 식별자는 클러스터의 AWS KMS 고객 마스터 키(CMK)에 액세스할 때마다 AWS CloudTrail 로그 항목에서 찾을 수 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** Status **   
이 글로벌 클러스터의 현재 상태를 지정합니다.  
유형: 문자열  
필수 항목 여부: 아니요

 ** StorageEncrypted **   
글로벌 클러스터의 스토리지 암호화 설정.  
유형: 부울  
필수 항목 여부: 아니요

 ** TagList.Tag.N **   
글로벌 클러스터 태그 목록입니다.  
타입: [Tag](API_Tag.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDKs
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) 

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

Amazon DocumentDB 글로벌 클러스터와 관련된 모든 기본 및 보조 클러스터에 대한 정보가 포함된 데이터 구조입니다.

## 내용
<a name="API_GlobalClusterMember_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** DBClusterArn **   
각 Amazon DocumentDB 클러스터의 Amazon 리소스 이름(ARN)  
유형: 문자열  
필수 항목 여부: 아니요

 ** IsWriter **   
 Amazon DocumentDB 클러스터가 해당 클러스터와 연결된 Amazon DocumentDB 글로벌 클러스터의 기본 클러스터인지 (즉, 읽기-쓰기 기능이 있는지) 여부를 지정합니다.  
유형: 부울  
필수 항목 여부: 아니요

 ** Readers.member.N **   
Amazon DocumentDB 글로벌 클러스터와 연결되어 있는 각 읽기 전용 보조 클러스터에 대한 Amazon 리소스 이름(ARN)  
유형: 문자열 배열  
필수 여부: 아니요

 ** SynchronizationStatus **   
글로벌 클러스터에 있는 각 Amazon DocumentDB 클러스터의 동기화 상태입니다.  
타입: 문자열  
유효 값: `connected | pending-resync`   
필수 여부: 아니요

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

언어별 AWS SDKs
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) 

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

인스턴스에 사용할 수 있는 옵션.

## 내용
<a name="API_OrderableDBInstanceOption_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AvailabilityZones.AvailabilityZone.N **   
인스턴스의 가용 영역 목록입니다.  
타입: [AvailabilityZone](API_AvailabilityZone.md)객체 배열  
필수 여부: 아니요

 ** DBInstanceClass **   
인스턴스의 인스턴스 클래스입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Engine **   
인스턴스의 엔진 유형입니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
인스턴스의 엔진 버전입니다.  
유형: 문자열  
필수 여부: 아니요

 ** LicenseModel **   
인스턴스의 라이선스 모델입니다.  
유형: 문자열  
필수 여부: 아니요

 ** StorageType **   
DB 클러스터와 연결할 스토리지 유형  
유형: 문자열  
필수 여부: 아니요

 ** Vpc **   
인스턴스가 Virtual Private Cloud(VPC)에 있는지 여부를 나타냅니다.  
유형: 부울  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) 

# Parameter
<a name="API_Parameter"></a>

개별 파라미터에 대한 상세 정보

## 내용
<a name="API_Parameter_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AllowedValues **   
파라미터의 유효한 값 범위를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** ApplyMethod **   
파라미터 업데이트의 적용 시점을 나타냅니다.  
타입: 문자열  
유효 값: `immediate | pending-reboot`   
필수 여부: 아니요

 ** ApplyType **   
엔진별 파라미터 유형을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DataType **   
파라미터의 유효한 데이터 형식을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** Description **   
파라미터의 설명을 제공합니다.  
유형: 문자열  
필수 여부: 아니요

 ** IsModifiable **   
 파라미터를 수정할 수 있는지 여부(`true`) 또는 (`false`)를 나타냅니다. 일부 파라미터에는 보안 또는 작동상의 의미가 있어 변경할 수 없습니다.  
유형: 부울  
필수 여부: 아니요

 ** MinimumEngineVersion **   
파라미터를 적용할 수 있는 가장 빠른 엔진 버전입니다.  
유형: 문자열  
필수 여부: 아니요

 ** ParameterName **   
파라미터의 이름을 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** ParameterValue **   
파라미터의 값을 지정합니다. CSV 형식의 클러스터 파라미터의 `AllowedValues` 중 하나 이상이어야 합니다.  
유효한 값은 다음과 같습니다.  
+  `enabled`: 클러스터는 TLS 버전 1.0\$11.3을 사용한 보안 연결을 허용합니다.
+  `disabled`: 클러스터는 TLS를 사용한 보안 연결을 허용하지 않습니다.
+  `fips-140-3`: 클러스터는 연방 정보 처리 표준(FIPS) 간행물 140-3의 요구 사항에 따라 보안 연결만 허용합니다. 다음 지역의 Amazon DocumentDB 5.0(엔진 버전 3.0.3727) 클러스터에서만 지원됩니다: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
+  `tls1.2+`: 클러스터는 TLS 버전 1.2 이상을 사용한 보안 연결을 허용합니다. Amazon DocumentDB 4.0(엔진 버전 2.0.10980) 및 Amazon DocumentDB 5.0(엔진 버전 3.0.11051)부터만 지원됩니다.
+  `tls1.3+`: 클러스터는 TLS 버전 1.3 이상을 사용한 보안 연결을 허용합니다. Amazon DocumentDB 4.0(엔진 버전 2.0.10980) 및 Amazon DocumentDB 5.0(엔진 버전 3.0.11051)부터만 지원됩니다.
유형: 문자열  
필수 여부: 아니요

 ** Source **   
파라미터 값의 소스를 나타냅니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) 

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

구성이 계속 보류 중인 로그 유형의 목록입니다. 이러한 로그 유형은 활성화되거나 비활성화되는 중입니다.

## 내용
<a name="API_PendingCloudwatchLogsExports_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** LogTypesToDisable.member.N **   
활성화되는 중인 로그 유형입니다. 활성화된 후에는 이러한 로그 유형은 Amazon CloudWatch Logs로 내보냅니다.  
유형: 문자열 배열  
필수 여부: 아니요

 ** LogTypesToEnable.member.N **   
비활성화되는 중인 로그 유형입니다. 비활성화된 후에는 이러한 로그 유형은 CloudWatch Logs로 내보내지 않습니다.  
유형: 문자열 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) 

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.

## 내용
<a name="API_PendingMaintenanceAction_Contents"></a>

**참고**  
다음 목록에는 필요한 파라미터가 먼저 설명되어 있습니다.

 ** Action **   
해당 리소스에 사용 가능한 대기 중 유지 관리 작업의 유형입니다.  
유형: 문자열  
필수 여부: 아니요

 ** AutoAppliedAfterDate **   
작업을 적용할 유지 관리 기간의 날짜입니다. 이 날짜 이후의 첫 번째 유지 관리 기간에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 `next-maintenance` 옵트인 요청은 무시됩니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** CurrentApplyDate **   
대기 중 유지 관리 작업을 리소스에 적용한 발효 날짜입니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** Description **   
유지 관리 작업에 대한 세부 정보를 담은 설명입니다.  
유형: 문자열  
필수 여부: 아니요

 ** ForcedApplyDate **   
유지 관리 작업이 자동으로 적용되는 날짜입니다. 해당 리소스의 유지 관리 기간과 관계없이 이 날짜에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 `immediate` 옵트인 요청은 무시됩니다.  
유형: 타임스탬프  
필수 여부: 아니요

 ** OptInStatus **   
해당 리소스에 대해 수신된 옵트인 요청의 유형을 나타냅니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) 

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 인스턴스에 대한 하나 이상의 수정된 설정 이러한 수정된 설정이 요청되었지만 아직 적용되지 않았습니다.

## 내용
<a name="API_PendingModifiedValues_Contents"></a>

**참고**  
다음 목록에는, 필수 파라미터가 먼저 설명되어 있습니다.

 ** AllocatedStorage **   
 현재 적용 중이거나 적용할 예정인 인스턴스의 새로운 `AllocatedStorage` 크기가 포함되어 있습니다.  
유형: Integer  
필수 여부: 아니요

 ** BackupRetentionPeriod **   
자동 백업이 보관되는 대기 중 일수를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** CACertificateIdentifier **   
DB 인스턴스의 인증 기관(CA) 인증서 식별자를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceClass **   
 현재 적용 중이거나 적용할 예정인 인스턴스의 새로운 `DBInstanceClass`가 포함되어 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBInstanceIdentifier **   
 현재 적용 중이거나 적용할 예정인 인스턴스의 새로운 `DBInstanceIdentifier`가 포함되어 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** DBSubnetGroupName **   
인스턴스의 새 서브넷 그룹입니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
데이터베이스 엔진의 버전을 나타냅니다.  
유형: 문자열  
필수 여부: 아니요

 ** Iops **   
현재 적용 중이거나 적용할 예정인 인스턴스의 새로운 프로비저닝된 IOPS 값을 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** LicenseModel **   
인스턴스의 라이선스 모델입니다.  
유효한 값: `license-included`, `bring-your-own-license`, `general-public-license`   
유형: 문자열  
필수 여부: 아니요

 ** MasterUserPassword **   
대기 중이거나 현재 진행 중인 인스턴스의 마스터 보안 인증에 대한 변경 사항이 포함되어 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** MultiAZ **   
단일 AZ 인스턴스를 다중 AZ 배포로 변경할 것인지를 나타냅니다.  
유형: 부울  
필수 여부: 아니요

 ** PendingCloudwatchLogsExports **   
구성이 계속 보류 중인 로그 유형의 목록입니다. 이러한 로그 유형은 활성화되거나 비활성화되는 중입니다.  
유형: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)객체  
필수 여부: 아니요

 ** Port **   
인스턴스에 대한 대기 중 포트를 지정합니다.  
유형: Integer  
필수 여부: 아니요

 ** StorageType **   
인스턴스와 연결할 스토리지 유형을 지정합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) 

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

의 출력을 나타냅니다[ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md).

## 내용
<a name="API_ResourcePendingMaintenanceActions_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
리소스에 대해 대기 중인 유지 관리 작업의 세부 정보를 담은 목록입니다.  
타입: [PendingMaintenanceAction](API_PendingMaintenanceAction.md)객체 배열  
필수 여부: 아니요

 ** ResourceIdentifier **   
보류 중인 유지 관리 작업이 있는 리소스의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

Amazon DocumentDB 엔진 버전마다 다른 Amazon DocumentDB Serverless 속성 또는 제한을 지정합니다. 새 클러스터 또는 업그레이드된 클러스터에서 사용할 Amazon DocumentDB 버전을 결정할 때 이 속성의 값을 테스트할 수 있습니다. 기존 클러스터의 버전을 검색하고 해당 버전을 사용하기 전에 해당 버전이 특정 Amazon DocumentDB Serverless 기능을 지원하는지 확인할 수도 있습니다.

## 내용
<a name="API_ServerlessV2FeaturesSupport_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** MaxCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최대 Amazon DocumentDB 용량 단위(DCU) 수입니다. 32, 32.5, 33 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

 ** MinCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최소 Amazon DocumentDB 용량 단위(DCU) 수입니다. 8, 8.5, 9 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

Amazon DocumentDB Serverless 클러스터의 조정 구성을 설정합니다.

## 내용
<a name="API_ServerlessV2ScalingConfiguration_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** MaxCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최대 Amazon DocumentDB 용량 단위(DCU) 수입니다. 32, 32.5, 33 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

 ** MinCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최소 Amazon DocumentDB 용량 단위(DCU) 수입니다. 8, 8.5, 9 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

Amazon DocumentDB Serverless 클러스터에 대한 조정 구성을 검색합니다.

## 내용
<a name="API_ServerlessV2ScalingConfigurationInfo_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** MaxCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최대 Amazon DocumentDB 용량 단위(DCU) 수입니다. 32, 32.5, 33 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

 ** MinCapacity **   
Amazon DocumentDB Serverless 클러스터의 인스턴스에 대한 최소 Amazon DocumentDB 용량 단위(DCU) 수입니다. 8, 8.5, 9 등과 같이 반단계 증분으로 DCU 값을 지정할 수 있습니다.  
유형: 더블  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 

# Subnet
<a name="API_Subnet"></a>

 서브넷에 대한 세부 정보입니다.

## 내용
<a name="API_Subnet_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** SubnetAvailabilityZone **   
서브넷에 대한 가용 영역을 사용합니다.  
유형: [AvailabilityZone](API_AvailabilityZone.md)객체  
필수 여부: 아니요

 ** SubnetIdentifier **   
서브넷의 식별자를 지정합니다.  
유형: 문자열  
필수 여부: 아니요

 ** SubnetStatus **   
서브넷의 상태를 지정합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) 

# Tag
<a name="API_Tag"></a>

키-값 페어로 구성된 Amazon DocumentDB 리소스에 할당되는 메타데이터입니다.

## 내용
<a name="API_Tag_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** Key **   
태그의 필수 이름입니다. 문자열 값은 길이가 1\$1128자(유니코드 문자)이며 "`aws:`" 또는 "`rds:`"로 시작할 수 없습니다. 문자열에는 유니코드 문자 집합, 숫자, 공백, '\$1', '.', '/', '=', '\$1', '-'(Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1")만 포함될 수 있습니다.  
유형: 문자열  
필수 여부: 아니요

 ** Value **   
태그의 선택적 값입니다. 문자열 값은 길이가 1\$1256자(유니코드 문자)이며 "`aws:`" 또는 "`rds:`"로 시작할 수 없습니다. 문자열에는 유니코드 문자 집합, 숫자, 공백, '\$1', '.', '/', '=', '\$1', '-'(Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1")만 포함될 수 있습니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) 

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

인스턴스를 업그레이드할 수 있는 데이터베이스 엔진의 버전입니다.

## 내용
<a name="API_UpgradeTarget_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 설명되어 있습니다.

 ** AutoUpgrade **   
`AutoMinorVersionUpgrade`가 `true`로 설정되어 있는 소스 DB 인스턴스에 대상 버전을 적용할 것인지 여부를 나타내는 값입니다.  
유형: 부울  
필수 여부: 아니요

 ** Description **   
인스턴스를 업그레이드할 수 있는 데이터베이스 엔진의 버전입니다.  
유형: 문자열  
필수 여부: 아니요

 ** Engine **   
업그레이드 대상인 데이터베이스 엔진의 이름입니다.  
유형: 문자열  
필수 여부: 아니요

 ** EngineVersion **   
업그레이드 대상인 데이터베이스 엔진의 버전 번호입니다.  
유형: 문자열  
필수 여부: 아니요

 ** IsMajorVersionUpgrade **   
데이터베이스 엔진을 메이저 버전으로 업그레이드할 것인지 여부를 나타내는 값입니다.  
유형: 부울  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) 

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

Virtual Private Cloud (VPC) 보안 그룹 멤버십에 대한 쿼리의 응답 요소로 사용됩니다.

## 내용
<a name="API_VpcSecurityGroupMembership_Contents"></a>

**참고**  
다음 목록에서는 필수 파라미터가 먼저 설명되어 있습니다.

 ** Status **   
VPC 보안 그룹의 상태입니다.  
유형: 문자열  
필수 여부: 아니요

 ** VpcSecurityGroupId **   
VPC 보안 그룹의 이름입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) 

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

Amazon DocumentDB Elastic Clusters에서 지원되는 데이터 유형은 다음과 같습니다.
+  [Cluster](API_elastic_Cluster.md) 
+  [ClusterInList](API_elastic_ClusterInList.md) 
+  [ClusterSnapshot](API_elastic_ClusterSnapshot.md) 
+  [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 
+  [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 
+  [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 
+  [Shard](API_elastic_Shard.md) 
+  [ValidationExceptionField](API_elastic_ValidationExceptionField.md) 

# Cluster
<a name="API_elastic_Cluster"></a>

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

## 내용
<a name="API_elastic_Cluster_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
탄성 클러스터 관리자의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
탄력적 클러스터의 인증 유형입니다.  
타입: 문자열  
유효 값: `PLAIN_TEXT | SECRET_ARN`   
필수 여부: 예

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
탄력적 클러스터에 연결하는 데 사용되는 URL입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
Elastic 클러스터의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
탄력적 클러스터가 생성된 시간(협정 세계시(UTC)).  
유형: 문자열  
필수 항목 여부: 예

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
탄력적 클러스터를 암호화하는 데 사용할 KMS 키 식별자입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)입니다.  
 *형식*: `ddd:hh24:mi-ddd:hh24:mi`   
유형: 문자열  
필수 항목 여부: 예

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

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
탄력적 클러스터에 할당된 샤드 수. 최대 값은 32입니다.  
유형: 정수  
필수 여부: 예

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
Elastic 클러스터의 상태입니다.  
타입: 문자열  
유효 값: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
필수 여부: 예

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
탄력적 클러스터의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 여부: 예

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
탄력적 클러스터와 연결된 EC2 VPC 보안 그룹 목록입니다.  
유형: 문자열 배열  
필수 여부: 예

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
자동 스냅샷이 보관되는 일수입니다.  
유형: Integer  
필수 여부: 아니요

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

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

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
클러스터의 샤드 총 개수입니다.  
타입: [Shard](API_elastic_Shard.md)객체 배열  
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Amazon DocumentDB Elastic Clusters.

## 내용
<a name="API_elastic_ClusterInList_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterInList-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** clusterName **   <a name="documentdb-Type-elastic_ClusterInList-clusterName"></a>
Elastic 클러스터의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-status"></a>
Elastic 클러스터의 상태입니다.  
타입: 문자열  
유효 값: `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`   
필수 여부: 예

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) 

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

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

## 내용
<a name="API_elastic_ClusterSnapshot_Contents"></a>

**참고**  
다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
탄성 클러스터 관리자의 이름입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
탄력적 클러스터가 생성된 시간(협정 세계시(UTC)).  
유형: 문자열  
필수 항목 여부: 예

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

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
탄력적 클러스터 스냅샷의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
탄력적 클러스터 스냅샷이 생성된 시간(협정 세계시(UTC)).  
유형: 문자열  
필수 항목 여부: 예

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
탄력적 클러스터 스냅샷의 이름.  
유형: 문자열  
필수 항목 여부: 예

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
탄력적 클러스터 스냅샷의 상태.  
타입: 문자열  
유효 값: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
필수 여부: 예

 ** subnetIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
탄력적 클러스터의 Amazon EC2 서브넷 ID입니다.  
유형: 문자열 배열  
필수 여부: 예

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
탄력적 클러스터에 연결할 EC2 VPC 보안 그룹의 목록.  
유형: 문자열 배열  
필수 여부: 예

 ** snapshotType **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.  
+  `automated` - Amazon DocumentDB가 사용자 AWS 계정에 대해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다. 
+  `manual`- AWS 계정용으로 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다.
타입: 문자열  
유효 값: `MANUAL | AUTOMATED`   
필수 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

탄력적 클러스터 스냅샷의 목록.

## 내용
<a name="API_elastic_ClusterSnapshotInList_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-clusterArn"></a>
탄력적 클러스터의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotArn"></a>
탄력적 클러스터 스냅샷의 ARN 식별자.  
유형: 문자열  
필수 항목 여부: 예

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotCreationTime"></a>
탄력적 클러스터 스냅샷이 생성된 시간(협정 세계시(UTC)).  
유형: 문자열  
필수 항목 여부: 예

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotName"></a>
탄력적 클러스터 스냅샷의 이름.  
유형: 문자열  
필수 항목 여부: 예

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-status"></a>
탄력적 클러스터 스냅샷의 상태.  
타입: 문자열  
유효 값: `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`   
필수 여부: 예

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) 

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

보류 중인 유지 관리 작업의 세부 정보를 검색합니다.

## 내용
<a name="API_elastic_PendingMaintenanceActionDetails_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
보류 중인 유지 관리 작업의 특정 작업을 표시합니다.  
유형: 문자열  
필수 항목 여부: 예

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
작업을 적용할 유지 관리 기간의 날짜를 표시합니다. 이 날짜 이후의 첫 번째 유지 관리 기간에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 `NEXT_MAINTENANCE` `optInType` 요청은 무시됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
대기 중 유지 관리 작업을 리소스에 적용한 발효 날짜를 표시합니다.  
유형: 문자열  
필수 여부: 아니요

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
유지 관리 작업에 대한 세부 정보를 담은 설명을 표시합니다.  
유형: 문자열  
필수 여부: 아니요

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
유지 관리 작업이 자동으로 적용되는 날짜를 표시합니다. 해당 리소스의 유지 관리 기간과 관계없이 이 날짜에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 `IMMEDIATE` `optInType` 요청은 무시됩니다.  
유형: 문자열  
필수 여부: 아니요

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
해당 리소스에 대해 수신된 `optInType` 요청의 유형을 표시합니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.

## 내용
<a name="API_elastic_ResourcePendingMaintenanceAction_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.  
타입: [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)객체 배열  
필수 여부: 아니요

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
보류 중인 유지 관리 작업이 적용되는 리소스의 Amazon DocumentDB Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
필수 항목 여부: 아니요

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 

# Shard
<a name="API_elastic_Shard"></a>

샤드의 이름입니다.

## 내용
<a name="API_elastic_Shard_Contents"></a>

**참고**  
필수 파라미터는 다음 표에 처음으로 설명되어 있습니다.

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
샤드가 생성된 시간(협정 세계시(UTC))입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
샤드의 ID입니다.  
유형: 문자열  
필수 항목 여부: 예

 ** status **   <a name="documentdb-Type-elastic_Shard-status"></a>
샤드의 현재 상태.  
타입: 문자열  
유효 값: `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`   
필수 여부: 예

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) 

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

지정된 유효성 검사 예외가 발생한 특정 필드.

## 내용
<a name="API_elastic_ValidationExceptionField_Contents"></a>

**참고**  
필수 파라미터는 다음 목록에 먼저 설명되어 있습니다.

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
이 필드의 유효성 검사 예외를 설명하는 오류 메시지.  
유형: 문자열  
필수 항목 여부: 예

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
유효성 검사 예외가 발생한 필드의 이름.  
유형: 문자열  
필수 항목 여부: 예

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

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField) 

# 일반적인 오류
<a name="CommonErrors"></a>

이 단원에는 모든 AWS서비스의 API 작업에 대한 일반 오류가 나와 있습니다. 이 서비스의 API 작업에 대한 오류는 해당 API 작업 항목을 참조하세요.

 **AccessDeniedException**   
이 작업을 수행할 수 있는 충분한 액세스 권한이 없습니다.  
HTTP 상태 코드: 400

 **IncompleteSignature**   
요청 서명이 AWS표준을 준수하지 않습니다.  
HTTP 상태 코드: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
알 수 없는 오류, 예외 또는 장애 때문에 요청 처리가 실패했습니다.  
HTTP 상태 코드: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
요청된 동작 또는 작업이 유효하지 않습니다. 작업을 올바로 입력했는지 확인합니다.  
HTTP 상태 코드: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
제공된 X.509 인증서 또는 AWS액세스 키 ID가 AWS의 레코드에 존재하지 않습니다.  
HTTP 상태 코드: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
이 작업을 수행하려면 권한이 있어야 합니다.  
HTTP 상태 코드: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
AWS 액세스 키 ID는 서비스에 대한 구독이 필요합니다.  
HTTP 상태 코드: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
요청이 요청상의 날짜 스탬프로부터 15분 이상, 또는 요청 만료 날짜(예: 미리 서명된 URL)로부터 15분 이상 경과한 후 서비스에 도달했거나, 요청상의 날짜 스탬프가 15분 이상 미래입니다.  
HTTP 상태 코드: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
서버의 일시적 장애로 인해 요청이 실패했습니다.  
HTTP 상태 코드: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
요청 제한 때문에 요청이 거부되었습니다.  
HTTP 상태 코드: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
입력이 AWS서비스에서 지정한 제약에 충족되지 않습니다.  
HTTP 상태 코드: 400

# 공통 파라미터
<a name="CommonParameters"></a>

다음 목록에는 모든 작업이 쿼리 문자열을 사용하여 Signature Version 4 요청에 서명하는 데 사용하는 파라미터가 포함되어 있습니다. 작업별 파라미터는 그 작업에 대한 항목에 나열되어 있습니다. Signature Version 4에 대한 자세한 내용은 **IAM 사용 설명서의 [AWSAPI 요청에 서명](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)을 참조하세요.

 **Action**   <a name="CommonParameters-Action"></a>
수행할 작업입니다.  
타입: 문자열  
필수 항목 여부: 예

 **Version**   <a name="CommonParameters-Version"></a>
요청이 작성되는 API 버전으로 YYYY-MM-DD 형식으로 표시됩니다.  
타입: 문자열  
필수 항목 여부: 예

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
요청 서명을 생성하는 데 사용된 해시 알고리즘입니다.  
조건: HTTP 권한 부여 헤더 대신 쿼리 문자열에 인증 정보를 포함하는 경우 이 파라미터를 지정합니다.  
타입: 문자열  
유효 값: `AWS4-HMAC-SHA256`   
필수 항목 여부: 조건부

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
자격 증명 범위 값이며 액세스 키, 날짜, 대상으로 하는 리전, 요청하는 서비스 및 종료 문자열("aws4\$1request")이 포함된 문자열입니다. 값은 다음 형식으로 표시됩니다. *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.  
자세한 내용은 **IAM 사용 설명서의 [서명된 AWSAPI 요청 생성](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)을 참조하세요.  
조건: HTTP 권한 부여 헤더 대신 쿼리 문자열에 인증 정보를 포함하는 경우 이 파라미터를 지정합니다.  
타입: 문자열  
필수 항목 여부: 조건부

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
서명을 만드는 데 사용되는 날짜입니다. 형식은 ISO 8601 기본 형식(YYYYMMDD'T'HHMMSS'Z')이어야 합니다. 예를 들어 다음 날짜 시간은 유효한 X-Amz-Date 값: `20120325T120000Z`.  
조건: X-Amz-Date는 모든 요청에서 옵션이지만 서명 요청에 사용되는 날짜보다 우선할 때 사용됩니다. 날짜 헤더가 ISO 8601 기본 형식으로 지정된 경우 X-Amz-Date가 필요하지 않습니다. X-Amz-Date를 사용하는 경우 항상 Date 헤더의 값을 재정의합니다. 자세한 내용은 **IAM 사용 설명서의 [AWSAPI 요청 서명의 요소](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)를 참조하세요.  
타입: 문자열  
필수 항목 여부: 조건부

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
AWS Security Token Service(AWS STS)에 대한 호출을 통해 받은 임시 보안 토큰입니다. AWS STS의 임시 보안 인증 정보를 지원하는 서비스 목록은 **IAM 사용 설명서의 [IAM으로 작업하는 AWS 서비스](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)를 참조하세요.  
조건: AWS STS의 임시 보안 인증 정보를 사용하는 경우 보안 토큰을 포함시켜야 합니다.  
타입: 문자열  
필수 항목 여부: 조건부

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
서명할 문자열과 파생된 서명 키에서 계산된 16진수로 인코딩된 서명을 지정합니다.  
조건: HTTP 권한 부여 헤더 대신 쿼리 문자열에 인증 정보를 포함하는 경우 이 파라미터를 지정합니다.  
타입: 문자열  
필수 항목 여부: 조건부

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
표준 요청의 일부로 포함된 모든 HTTP 헤더를 지정합니다. 서명된 헤더 지정에 대한 자세한 내용은 **IAM 사용 설명서의 [서명된 AWSAPI 요청 생성](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)을 참조하세요.  
조건: HTTP 권한 부여 헤더 대신 쿼리 문자열에 인증 정보를 포함하는 경우 이 파라미터를 지정합니다.  
타입: 문자열  
필수 항목 여부: 조건부