ModifyDBCluster - Amazon DocumentDB

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

ModifyDBCluster

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

요청 파라미터

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

DBClusterIdentifier

수정 중인 클러스터의 클러스터 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.

제약 조건:

  • 기존 DBCluster의 식별자와 일치해야 합니다.

유형: 문자열

필수 항목 여부: 예

AllowMajorVersionUpgrade

메이저 버전 업그레이드가 허용되는지 여부를 나타내는 값입니다.

제약 조건: DB 클러스터의 현재 버전과 다른 주 버전인 EngineVersion 파라미터 값을 지정하는 경우 주 버전 업그레이드를 허용해야 합니다.

유형: 부울

필수 항목 여부: 아니요

ApplyImmediately

클러스터의 PreferredMaintenanceWindow 설정과 관계없이, 이 요청의 변경 사항과 대기 중인 모든 변경 사항을 비동기적으로 최대한 빨리 적용할 것인지 여부를 지정하는 값입니다. 이 파라미터가 false로 설정되어 있으면 클러스터에 대한 변경 사항이 다음번 유지 관리 기간에 적용됩니다.

ApplyImmediately 파라미터는 NewDBClusterIdentifierMasterUserPassword 값에만 영향을 줍니다. 이 파라미터 값을 false로 설정한 경우, NewDBClusterIdentifierMasterUserPassword 값의 변경 사항이 다음번 유지 관리 기간에 적용됩니다. 그 밖의 모든 변경 사항은 ApplyImmediately 파라미터 값과 관계없이 즉시 적용됩니다.

기본값: false

유형: 부울

필수 항목 여부: 아니요

BackupRetentionPeriod

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

기본값: 1

제약 조건:

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

유형: 정수

필수 항목 여부: 아니요

CloudwatchLogsExportConfiguration

특정 인스턴스 또는 클러스터에 대해 Amazon CloudWatch Logs로 내보내기를 활성화할 로그 유형의 구성 설정입니다. EnableLogTypesDisableLogTypes 배열은 로그로 내보내는(또는 내보내지 않는) CloudWatch 로그를 결정합니다.

유형: CloudwatchLogsExportConfiguration 객체

필수 여부: 아니요

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

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

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

유형: 문자열

필수 항목 여부: 아니요

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 수 있습니다. 를 켜고 MasterUserSecretKmsKeyId를 지정ManageMasterUserPassword하지 않으면 aws/secretsmanager KMS 키가 보안 암호를 암호화하는 데 사용됩니다. 보안 암호가 다른 Amazon Web Services 계정에 있는 경우 aws/secretsmanager KMS 키를 사용하여 보안 암호를 암호화할 수 없으며 고객 관리형 KMS 키를 사용해야 합니다.

Amazon Web Services KMS 키 식별자는 키 ARN, 키 ID, 별칭 ARN또는 KMS 키의 별칭 이름입니다. 다른 Amazon Web Services 계정에서 KMS 키를 사용하려면 키 ARN 또는 별칭을 지정합니다ARN.

Amazon Web Services 계정에는 기본 KMS 키가 있습니다. Amazon Web Services 계정에는 각 Amazon Web Services 리전마다 다른 기본 KMS 키가 있습니다.

유형: 문자열

필수 항목 여부: 아니요

NewDBClusterIdentifier

클러스터의 이름을 변경할 때 클러스터의 새 클러스터 식별자입니다. 이 값은 소문자 문자열로 저장됩니다.

제약 조건:

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

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

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

예제: my-cluster2

유형: 문자열

필수 항목 여부: 아니요

Port

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

제약 조건: 값이 1150~65535여야 합니다.

기본값: 원래의 클러스터와 동일한 포트입니다.

유형: 정수

필수 항목 여부: 아니요

PreferredBackupWindow

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

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

제약 조건:

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

  • Universal Coordinated Time()이어야 합니다UTC.

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

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

유형: 문자열

필수 항목 여부: 아니요

PreferredMaintenanceWindow

시스템 유지 관리가 발생할 수 있는 주간 시간 범위로, Universal Coordinated Time()입니다UTC.

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

기본값은 각에 대해 8시간 블록에서 임의로 선택된 30분 기간으로 AWS 리전, 요일에 무작위로 발생합니다.

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

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

유형: 문자열

필수 항목 여부: 아니요

RotateMasterUserPassword

Amazon Web Services Secrets Manager에서 관리하는 보안 암호를 마스터 사용자 암호로 교체할지 여부를 지정합니다.

이 설정은 클러스터에 대한 Amazon Web Services Secrets Manager의 Amazon DocumentDB에서 마스터 사용자 암호를 관리하는 경우에만 유효합니다. 보안 암호 값에는 업데이트된 암호가 포함됩니다.

제약: 마스터 사용자 암호를 교체할 때 변경 사항을 즉시 적용해야 합니다.

유형: 부울

필수 항목 여부: 아니요

StorageType

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

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

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

기본값은 standard 입니다.

유형: 문자열

필수 항목 여부: 아니요

VpcSecurityGroupIds.VpcSecurityGroupId.N

클러스터가 속할 가상 프라이빗 클라우드(VPC) 보안 그룹의 목록입니다.

유형: 문자열 배열

필수 여부: 아니요

응답 요소

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

DBCluster

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

유형: DBCluster 객체

오류

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

DBClusterAlreadyExistsFault

해당 식별자를 사용하는 클러스터가 이미 있습니다.

HTTP 상태 코드: 400

DBClusterNotFoundFault

DBClusterIdentifier은 기존 클러스터를 참조하지 않습니다.

HTTP 상태 코드: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupName는 기존 클러스터 파라미터 그룹을 참조하지 않습니다.

HTTP 상태 코드: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName은 기존 서브넷 그룹을 참조하지 않습니다.

HTTP 상태 코드: 404

InvalidDBClusterStateFault

클러스터가 유효한 상태가 아닙니다.

HTTP 상태 코드: 400

InvalidDBInstanceState

지정된 인스턴스가 사용 가능한 상태가 아닙니다.

HTTP 상태 코드: 400

InvalidDBSecurityGroupState

보안 그룹의 상태로 인해 삭제할 수 없습니다.

HTTP 상태 코드: 400

InvalidDBSubnetGroupStateFault

서브넷 그룹이 사용 중이므로 삭제할 수 없습니다.

HTTP 상태 코드: 400

InvalidSubnet

요청된 서브넷이 유효하지 않거나 공통 가상 프라이빗 클라우드()에 없는 여러 서브넷이 요청되었습니다VPC.

HTTP 상태 코드: 400

InvalidVPCNetworkStateFault

서브넷 그룹이 생성된 후에는 변경 사항으로 인해 모든 가용 영역에 적용되지 않습니다.

HTTP 상태 코드: 400

StorageQuotaExceeded

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

HTTP 상태 코드: 400

참고

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