ClusterSnapshot - Amazon DocumentDB

ClusterSnapshot

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

내용

참고

다음 목록에는 필수 파라미터가 먼저 설명되어 있습니다.

adminUserName

탄성 클러스터 관리자의 이름입니다.

유형: 문자열

필수 항목 여부: 예

clusterArn

탄력적 클러스터의 ARN 식별자.

유형: 문자열

필수 항목 여부: 예

clusterCreationTime

탄력적 클러스터가 생성된 시간(협정 세계시(UTC)).

유형: 문자열

필수 항목 여부: 예

kmsKeyId

KMS 키 식별자는 KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 이 KMS 암호화 키를 소유하고 있는 동일한 Amazon 계정을 사용하여 클러스터를 생성하는 경우, ARN 대신 KMS 키 별칭을 KMS 암호화 키로 사용할 수 있습니다. 여기에 암호화 키가 지정되지 않은 경우 Amazon DocumentDB는 KMS가 사용자 계정에 대해 생성하는 기본 암호화 키를 사용합니다. 계정에는 Amazon 리전마다 다른 기본 암호화 키가 있습니다.

유형: 문자열

필수 항목 여부: 예

snapshotArn

탄력적 클러스터 스냅샷의 ARN 식별자.

유형: 문자열

필수 항목 여부: 예

snapshotCreationTime

탄력적 클러스터 스냅샷이 생성된 시간(협정 세계시(UTC)).

유형: 문자열

필수 항목 여부: 예

snapshotName

탄력적 클러스터 스냅샷의 이름.

유형: 문자열

필수 항목 여부: 예

status

탄력적 클러스터 스냅샷의 상태.

타입: 문자열

유효 값: CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE

필수 여부: 예

subnetIds

탄력적 클러스터의 Amazon EC2 서브넷 ID입니다.

유형: 문자열 배열

필수 여부: 예

vpcSecurityGroupIds

탄력적 클러스터에 연결할 EC2 VPC 보안 그룹의 목록.

유형: 문자열 배열

필수 여부: 예

snapshotType

반환되는 클러스터 스냅샷의 유형. 다음 값 중 하나를 지정할 수 있습니다.

  • automated - Amazon DocumentDB가 사용자 AWS 계정에 대해 자동으로 생성한 모든 클러스터 스냅샷을 반환합니다.

  • manual- AWS 계정용으로 수동으로 생성한 모든 클러스터 스냅샷을 반환합니다.

타입: 문자열

유효 값: MANUAL | AUTOMATED

필수 여부: 아니요

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.