RestoreDBClusterToPointInTime - Amazon DocumentDB

RestoreDBClusterToPointInTime

클러스터를 임의의 시점으로 복원합니다. 사용자는 LatestRestorableTime 이전의 최대 BackupRetentionPeriod일까지 원하는 시점으로 복원할 수 있습니다. 원래의 클러스터와 동일한 구성으로 원본 클러스터에서 대상 클러스터가 생성됩니다. 단, 새 클러스터가 기본 보안 그룹으로 생성된 경우는 예외입니다.

요청 파라미터

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

DBClusterIdentifier

생성할 새 클러스터의 이름입니다.

제약 조건:

  • 1~63자의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.

  • 첫 자는 문자여야 합니다.

  • 하이픈으로 끝나거나 하이픈이 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 암호화 키의 ARN 대신 AWS KMS 키 별칭을 사용할 수 있습니다.

새 클러스터로 복원한 다음, 원본 클러스터를 암호화할 때 사용한 AWS KMS 키와 다른 AWS KMS 키로 새 클러스터를 암호화할 수 있습니다. 새 DB 클러스터는 KmsKeyId 파라미터로 알 수 있는 AWS KMS 키로 암호화합니다.

KmsKeyId 파라미터 값을 지정하지 않으면 다음과 같이 진행됩니다.

  • 클러스터가 암호화되어 있는 경우, 복원된 클러스터는 원본 클러스터를 암호화할 때 사용한 AWS KMS 키로 암호화됩니다.

  • 클러스터가 암호화되어 있지 않으면 복원된 클러스터도 암호화되지 않습니다.

DBClusterIdentifier가 암호화되지 않은 DB 클러스터를 가리키는 경우, 복원 요청이 거부됩니다.

유형: 문자열

필수 항목 여부: 아니요

Port

새 클러스터에서 연결을 허용하는 포트 번호입니다.

제약 조건: 값이 1150~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 클러스터의 전체 복사로서 복구됩니다.

유형: 문자열

필수 항목 여부: 아니요

StorageType

DB 클러스터와 연결할 스토리지 유형입니다.

Amazon DocumentDB 클러스터의 스토리지 유형에 관한 자세한 내용은 Amazon DocumentDB 개발자 안내서의 클러스터 스토리지 구성을 참조하세요.

스토리지 유형에 유효한 값 - standard | iopt1

기본값은 standard 입니다.

유형: 문자열

필수 항목 여부: 아니요

Tags.Tag.N

복원된 클러스터에 할당할 태그입니다.

유형: Tag 객체 배열

필수 항목 여부: 아니요

UseLatestRestorableTime

클러스터를 복원 가능한 마지막 백업 시간으로 복원하려면 이 값을 true로 설정하고, 그렇지 않으면 false로 설정합니다.

기본값: false

제약 조건: RestoreToTime 파라미터를 제공한 경우에는 지정할 수 없습니다.

타입: 부울

필수 항목 여부: 아니요

VpcSecurityGroupIds.VpcSecurityGroupId.N

새 클러스터가 속해 있는 VPC 보안 그룹의 목록입니다.

유형: 문자열 배열

필수 항목 여부: 아니요

응답 요소

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

DBCluster

클러스터에 관한 자세한 정보입니다.

유형: DBCluster 객체

오류

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

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

StorageQuotaExceeded

요청으로 인해 모든 인스턴스에서 사용 가능한 스토리지 허용량을 초과하게 됩니다.

HTTP 상태 코드: 400

참고

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