ModifyDBInstance - Amazon DocumentDB

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

ModifyDBInstance

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

요청 파라미터

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

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 인증서 업데이트전송 중 데이터 암호화를 참조하세요.

타입: 부울

필수 항목 여부: 아니요

CopyTagsToSnapshot

모든 태그를 DB 인스턴스에서 DB 인스턴스의 스냅샷으로 복사할지 여부를 나타내는 값입니다. 태그는 기본적으로 복사되지 않습니다.

타입: 부울

필수 항목 여부: 아니요

DBInstanceClass

인스턴스의 컴퓨팅 및 메모리 용량입니다(예: db.r5.large). 모든 AWS 리전에서 모든 인스턴스 클래스를 사용할 수 있는 것은 아닙니다.

인스턴스 클래스를 수정하면 변경 중에 중단이 발생합니다. 이 요청에 대해 ApplyImmediatelytrue로 지정하지 않은 한, 변경 사항은 다음번 유지 관리 기간에 적용됩니다.

기본값: 기존 설정을 사용합니다.

타입: 문자열

필수사항: 아니요

EnablePerformanceInsights

DB 인스턴스에 Performance Insights를 활성화할지 여부를 나타내는 값입니다. 자세한 내용은 Amazon 성능 개선 도우미 사용을 참조하세요.

타입: 부울

필수 항목 여부: 아니요

NewDBInstanceIdentifier

인스턴스의 이름을 변경할 때 인스턴스의 새로운 인스턴스 식별자입니다. 인스턴스 식별자를 변경할 때 Apply Immediatelytrue로 설정하면 인스턴스 식별자가 즉시 재부팅됩니다. Apply Immediatelyfalse로 설정하면 다음 유지 관리 기간에 발생합니다. 이 값은 소문자 문자열로 저장됩니다.

제약 조건:

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

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

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

예제: mydbinstance

타입: 문자열

필수사항: 아니요

PerformanceInsightsKMSKeyId

Performance Insights 데이터 암호화를 위한 AWS KMS 키 식별자입니다.

AWS KMS 키 식별자는 KMS 키의 키 ARN, 키 ID, 별칭 ARN 또는 별칭 이름입니다.

KMS 값을 지정하지 않으면 Amazon DocumentDB는 기본 PerformanceInsights KMS KeyId 키를 사용합니다. 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~15.

유형: 정수

필수 항목 여부: 아니요

Response Elements

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

DBInstance

인스턴스에 대한 자세한 정보.

유형: DBInstance객체

Errors

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

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

참고

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