CreateDBCluster - Amazon DocumentDB

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

CreateDBCluster

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

요청 파라미터

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

DBClusterIdentifier

클러스터 식별자입니다. 이 파라미터는 소문자 문자열로 저장됩니다.

제약 조건:

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

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

  • 하이픈으로 끝나거나 하이픈이 2개 연속으로 이어져서는 안 됩니다.

예시: my-cluster

유형: 문자열

필수 항목 여부: 예

Engine

이 클러스터에 사용할 데이터베이스 엔진의 이름입니다.

유효값: docdb

유형: 문자열

필수 항목 여부: 예

AvailabilityZones.AvailabilityZone.N

클러스터의 인스턴스를 생성할 수 있는 Amazon EC2 가용 영역의 목록입니다.

유형: 문자열 배열

필수 항목 여부: 아니요

BackupRetentionPeriod

자동 백업이 보관되는 일수입니다. 1 이상의 값을 지정해야 합니다.

기본값: 1

제약 조건:

  • 1~35의 값이어야 합니다.

유형: 정수

필수 항목 여부: 아니요

DBClusterParameterGroupName

이 클러스터와 연결할 클러스터 파라미터 그룹의 이름입니다.

유형: 문자열

필수 항목 여부: 아니요

DBSubnetGroupName

이 클러스터와 연결할 서브넷 그룹입니다.

제약: 기존의 DBSubnetGroup 이름과 일치해야 합니다. 기본값이 아니어야 합니다.

예시: mySubnetgroup

유형: 문자열

필수 항목 여부: 아니요

DeletionProtection

이 클러스터를 삭제할 수 있는지 없는지를 지정합니다. DeletionProtection이 활성화되면 클러스터를 수정하고 DeletionProtection 를 비활성화하지 않는 한 클러스터를 삭제할 수 없습니다. DeletionProtection은 클러스터가 실수로 삭제되지 않도록 보호합니다.

타입: 부울

필수 항목 여부: 아니요

EnableCloudwatchLogsExports.member.N

Amazon CloudWatch Logs로 내보내기에 대해 활성화해야 하는 로그 유형의 목록입니다. 감사 로그 또는 프로파일러 로그를 활성화할 수 있습니다. 자세한 내용은 Amazon DocumentDB 이벤트 감사Amazon DocumentDB 작업 프로파일링을 참조하십시오.

유형: 문자열 배열

필수 항목 여부: 아니요

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 암호화 키의 ARN 대신 AWS KMS 키 별칭을 사용할 수 있습니다.

KmsKeyId에 암호화 키가 지정되어 있지 않은 경우:

  • StorageEncrypted 파라미터가 true인 경우 Amazon DocumentDB는 기본 암호화 키를 사용합니다.

AWS KMS에서는 AWS 계정을 위한 기본 암호화 키를 생성합니다. AWS 계정에는 AWS 리전마다 다른 기본 암호화 키가 있습니다.

유형: 문자열

필수 항목 여부: 아니요

MasterUsername

클러스터의 마스터 사용자 이름입니다.

제약 조건:

  • 1~63자의 문자 또는 숫자여야 합니다.

  • 첫 번째 자리는 문자여야 합니다.

  • 선택한 데이터베이스 엔진의 예약어는 사용할 수 없습니다.

유형: 문자열

필수 항목 여부: 아니요

MasterUserPassword

마스터 데이터베이스 사용자의 암호입니다. 이 암호에는 슬래시(/), 큰따옴표(") 또는 ‘앳’ 기호(@)를 제외한 인쇄 가능 ASCII 문자가 포함될 수 있습니다.

제약: 8~100자여야 합니다.

유형: 문자열

필수 항목 여부: 아니요

Port

클러스터의 인스턴스가 연결을 허용하는 포트 번호입니다.

유형: 정수

필수 항목 여부: 아니요

PreferredBackupWindow

BackupRetentionPeriod 파라미터를 사용하여 자동 백업을 활성화한 경우, 자동 백업이 생성되는 일일 시간 범위입니다.

기본값은 AWS 리전별로 8시간의 시간 블록 중 임의로 선택한 30분의 기간입니다.

제약 조건:

  • hh24:mi-hh24:mi 형식이어야 합니다.

  • 협정 세계시(UTC)여야 합니다.

  • 원하는 유지 관리 기간과 충돌하지 않아야 합니다.

  • 30분 이상이어야 합니다.

유형: 문자열

필수 항목 여부: 아니요

PreferredMaintenanceWindow

시스템 유지 관리를 실행할 수 있는 주 단위 기간(UTC, 협정 세계시)입니다.

형식: ddd:hh24:mi-ddd:hh24:mi

기본값은 AWS 리전별로 8시간의 시간 블록 중 임의로 선택한 30분의 기간이며, 발생하는 요일은 무작위입니다.

유효한 요일: 월, 화, 수, 목, 금, 토, 일

제약 조건: 최소 30분의 기간.

유형: 문자열

필수 항목 여부: 아니요

PreSignedUrl

현재 지원되지 않습니다.

유형: 문자열

필수 항목 여부: 아니요

StorageEncrypted

클러스터의 암호화 여부를 지정합니다.

타입: 부울

필수 항목 여부: 아니요

StorageType

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

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

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

기본값은 standard 입니다.

참고

스토리지 유형이 iopt1로 설정된 DocumentDB DB 클러스터를 생성하면 스토리지 유형이 응답에 반환됩니다. 스토리지 유형을 standard로 설정하면 스토리지 유형이 반환되지 않습니다.

유형: 문자열

필수 항목 여부: 아니요

Tags.Tag.N

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

유형: Tag 객체 배열

필수 항목 여부: 아니요

VpcSecurityGroupIds.VpcSecurityGroupId.N

이 클러스터와 연결할 EC2 VPC 보안 그룹 목록입니다.

유형: 문자열 배열

필수 항목 여부: 아니요

응답 요소

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

DBCluster

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

유형: DBCluster 객체

오류

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

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

StorageQuotaExceeded

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

HTTP 상태 코드: 400

참고

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