Neptune 스냅샷 API - Amazon Neptune

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

Neptune 스냅샷 API

작업:

구조:

CreateDBClusterSnapshot(작업)

        이 API의 AWS CLI 이름은 create-db-cluster-snapshot입니다.

DB 클러스터의 스냅샷을 생성합니다.

요청

  • DBClusterIdentifier(CLI의 경우: --db-cluster-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    스냅샷을 만들 DB 클러스터의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.

    제약 조건:

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

    예제: my-cluster1

  • DBClusterSnapshotIdentifier(CLI의 경우: --db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    제약 조건:

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

    • 첫 번째 문자는 글자이어야 합니다.

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

    예제: my-cluster1-snapshot1

  • Tags(CLI의 경우: --tags) - Tag 객체의 배열입니다.

    새 DB 클러스터 스냅샷에 할당할 태그입니다.

응답

Amazon Neptune DB 클러스터 스냅샷에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusterSnapshots(작업) 작업에서 응답 요소로 사용됩니다.

  • AllocatedStorage - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    기가바이트(GiB) 단위의 할당된 스토리지 크기를 지정합니다.

  • AvailabilityZones - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 인스턴스를 복원할 수 있는 EC2 가용 영역 목록을 제공합니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • DBClusterIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷을 생성한 DB 클러스터의 DB 클러스터 식별자를 지정합니다.

  • DBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterSnapshotIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 식별자를 지정합니다. 기존 스냅샷의 식별자와 일치해야 합니다.

    DBClusterSnapshotIdentifier를 사용하여 DB 클러스터를 복원한 후에는 DB 클러스터에 대한 향후 업데이트 시 동일한 DBClusterSnapshotIdentifier를 지정해야 합니다. 이 속성을 업데이트에 지정할 경우 DB 클러스터가 스냅샷에서 다시 복원되지 않고 데이터베이스 내 데이터가 변경되지 않습니다.

    그러나 DBClusterSnapshotIdentifier를 지정하지 않을 경우 빈 DB 클러스터가 생성되고 원래 DB 클러스터가 삭제됩니다. 이전 스냅샷 복원 속성과 다른 속성을 지정할 경우 DB 클러스터가 DBClusterSnapshotIdentifier에서 지정한 스냅샷에서 복원되고 원래 DB 클러스터는 삭제됩니다.

  • Engine - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 이름을 지정합니다.

  • EngineVersion - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 데이터베이스 엔진의 버전을 알려 줍니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • KmsKeyId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터 스냅샷의 Amazon KMS 키 식별자입니다.

  • LicenseModel - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 라이선스 모델 정보를 알려 줍니다.

  • PercentProgress - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    전송된 데이터의 추정 백분율을 나타냅니다.

  • Port - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    스냅샷 생성 시점에 DB 클러스터가 수신하던 포트를 지정합니다.

  • SnapshotCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    스냅샷이 생성된 시간을 나타냅니다(협정 세계시(UTC)).

  • SnapshotType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 유형을 알려 줍니다.

  • SourceDBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷을 소스 DB 클러스터 스냅샷에서 복사한 경우 그 소스 DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이고, 그렇지 않으면 null 값입니다.

  • Status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷의 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 스토리지 유형입니다.

  • VpcId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 VPC ID를 알려 줍니다.

DeleteDBClusterSnapshot(작업)

        이 API의 AWS CLI 이름은 delete-db-cluster-snapshot입니다.

DB 클러스터 스냅샷을 삭제합니다. 스냅샷을 복사 중인 경우, 복사 작업이 종료됩니다.

참고

DB 클러스터 스냅샷을 삭제하려면 available 상태여야 합니다.

요청

  • DBClusterSnapshotIdentifier(CLI의 경우: --db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    삭제할 DB 클러스터 스냅샷의 식별자입니다.

    제약: available 상태인 기존 DB 클러스터 스냅샷의 이름이어야 합니다.

응답

Amazon Neptune DB 클러스터 스냅샷에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusterSnapshots(작업) 작업에서 응답 요소로 사용됩니다.

  • AllocatedStorage - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    기가바이트(GiB) 단위의 할당된 스토리지 크기를 지정합니다.

  • AvailabilityZones - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 인스턴스를 복원할 수 있는 EC2 가용 영역 목록을 제공합니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • DBClusterIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷을 생성한 DB 클러스터의 DB 클러스터 식별자를 지정합니다.

  • DBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterSnapshotIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 식별자를 지정합니다. 기존 스냅샷의 식별자와 일치해야 합니다.

    DBClusterSnapshotIdentifier를 사용하여 DB 클러스터를 복원한 후에는 DB 클러스터에 대한 향후 업데이트 시 동일한 DBClusterSnapshotIdentifier를 지정해야 합니다. 이 속성을 업데이트에 지정할 경우 DB 클러스터가 스냅샷에서 다시 복원되지 않고 데이터베이스 내 데이터가 변경되지 않습니다.

    그러나 DBClusterSnapshotIdentifier를 지정하지 않을 경우 빈 DB 클러스터가 생성되고 원래 DB 클러스터가 삭제됩니다. 이전 스냅샷 복원 속성과 다른 속성을 지정할 경우 DB 클러스터가 DBClusterSnapshotIdentifier에서 지정한 스냅샷에서 복원되고 원래 DB 클러스터는 삭제됩니다.

  • Engine - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 이름을 지정합니다.

  • EngineVersion - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 데이터베이스 엔진의 버전을 알려 줍니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • KmsKeyId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터 스냅샷의 Amazon KMS 키 식별자입니다.

  • LicenseModel - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 라이선스 모델 정보를 알려 줍니다.

  • PercentProgress - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    전송된 데이터의 추정 백분율을 나타냅니다.

  • Port - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    스냅샷 생성 시점에 DB 클러스터가 수신하던 포트를 지정합니다.

  • SnapshotCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    스냅샷이 생성된 시간을 나타냅니다(협정 세계시(UTC)).

  • SnapshotType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 유형을 알려 줍니다.

  • SourceDBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷을 소스 DB 클러스터 스냅샷에서 복사한 경우 그 소스 DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이고, 그렇지 않으면 null 값입니다.

  • Status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷의 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 스토리지 유형입니다.

  • VpcId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 VPC ID를 알려 줍니다.

CopyDBClusterSnapshot(작업)

        이 API의 AWS CLI 이름은 copy-db-cluster-snapshot입니다.

DB 클러스터의 스냅샷을 복사합니다.

공유된 수동 DB 클러스터 스냅샷에서 DB 클러스터 스냅샷을 복사하려면 SourceDBClusterSnapshotIdentifier가 공유된 DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이어야 합니다.

요청

  • CopyTags(CLI의 경우: --copy-tags) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    원본 DB 클러스터 스냅샷의 모든 태그를 대상 DB 클러스터 스냅샷으로 복사하려면 true이고, 그렇지 않으면 false입니다. 기본값은 false입니다.

  • KmsKeyId(CLI의 경우: --kms-key-id) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    암호화된 DB 클러스터 스냅샷의 Amazon KMS 키 ID입니다. KMS 키 ID는 Amazon 리소스 이름(ARN), KMS 키 식별자 또는 KMS 암호화 키에 대한 KMS 키 별칭입니다.

    Amazon 계정에서 암호화된 DB 클러스터 스냅샷을 복사하는 경우, KmsKeyId 값을 지정하여 새 KMS 암호화 키로 사본을 암호화할 수 있습니다. KmsKeyId 값을 지정하지 않으면 DB 클러스터 스냅샷의 사본을 원본 DB 스냅샷과 동일한 KMS 키로 암호화합니다.

    다른 Amazon 계정에서 공유한 암호화된 DB 클러스터 스냅샷을 복사하는 경우, KmsKeyId 값을 지정해야 합니다.

    KMS 암호화 키는 해당 키를 만든 Amazon 리전에서 고유하며, 한 Amazon 리전의 암호화 키를 다른 Amazon 리전에서 사용할 수는 없습니다.

    암호화되지 않은 DB 클러스터 스냅샷을 복사할 때에는 암호화할 수 없습니다. 암호화되지 않은 DB 클러스터 스냅샷의 복사하고 KmsKeyId에 대한 값을 지정하려고 시도하면 오류가 반환됩니다.

  • PreSignedUrl(CLI의 경우: --pre-signed-url) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    현재 지원되지 않습니다.

  • SourceDBClusterSnapshotIdentifier(CLI의 경우: --source-db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복사할 DB 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.

    제약 조건:

    • "사용 가능"한 상태의 유효한 시스템 스냅샷을 지정해야 합니다.

    • 유효한 DB 스냅샷 식별자를 나타냅니다.

    예제: my-cluster-snapshot1

  • Tags(CLI의 경우: --tags) - Tag 객체의 배열입니다.

    새 DB 클러스터 스냅샷 사본에 할당할 태그입니다.

  • TargetDBClusterSnapshotIdentifier(CLI의 경우: --target-db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    소스 DB 클러스터 스냅샷에서 생성할 새 DB 클러스터 스냅샷의 식별자입니다. 이 파라미터는 대소문자를 구분하지 않습니다.

    제약 조건:

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

    • 첫 번째 문자는 글자이어야 합니다.

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

    예제: my-cluster-snapshot2

응답

Amazon Neptune DB 클러스터 스냅샷에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusterSnapshots(작업) 작업에서 응답 요소로 사용됩니다.

  • AllocatedStorage - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    기가바이트(GiB) 단위의 할당된 스토리지 크기를 지정합니다.

  • AvailabilityZones - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 인스턴스를 복원할 수 있는 EC2 가용 영역 목록을 제공합니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • DBClusterIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷을 생성한 DB 클러스터의 DB 클러스터 식별자를 지정합니다.

  • DBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterSnapshotIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 식별자를 지정합니다. 기존 스냅샷의 식별자와 일치해야 합니다.

    DBClusterSnapshotIdentifier를 사용하여 DB 클러스터를 복원한 후에는 DB 클러스터에 대한 향후 업데이트 시 동일한 DBClusterSnapshotIdentifier를 지정해야 합니다. 이 속성을 업데이트에 지정할 경우 DB 클러스터가 스냅샷에서 다시 복원되지 않고 데이터베이스 내 데이터가 변경되지 않습니다.

    그러나 DBClusterSnapshotIdentifier를 지정하지 않을 경우 빈 DB 클러스터가 생성되고 원래 DB 클러스터가 삭제됩니다. 이전 스냅샷 복원 속성과 다른 속성을 지정할 경우 DB 클러스터가 DBClusterSnapshotIdentifier에서 지정한 스냅샷에서 복원되고 원래 DB 클러스터는 삭제됩니다.

  • Engine - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 이름을 지정합니다.

  • EngineVersion - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 데이터베이스 엔진의 버전을 알려 줍니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • KmsKeyId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터 스냅샷의 Amazon KMS 키 식별자입니다.

  • LicenseModel - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 라이선스 모델 정보를 알려 줍니다.

  • PercentProgress - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    전송된 데이터의 추정 백분율을 나타냅니다.

  • Port - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    스냅샷 생성 시점에 DB 클러스터가 수신하던 포트를 지정합니다.

  • SnapshotCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    스냅샷이 생성된 시간을 나타냅니다(협정 세계시(UTC)).

  • SnapshotType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 유형을 알려 줍니다.

  • SourceDBClusterSnapshotArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷을 소스 DB 클러스터 스냅샷에서 복사한 경우 그 소스 DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이고, 그렇지 않으면 null 값입니다.

  • Status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷의 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 스토리지 유형입니다.

  • VpcId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 VPC ID를 알려 줍니다.

ModifyDBClusterSnapshotAttribute(작업)

        이 API의 AWS CLI 이름은 modify-db-cluster-snapshot-attribute입니다.

속성 및 값을 수동 DB 클러스터 스냅샷에 추가하거나, 수동 DB 클러스터 스냅샷에서 속성 및 값을 제거합니다.

수동 DB 클러스터 스냅샷을 다른 Amazon 계정과 공유하려면 restoreAttributeName으로 지정하고 ValuesToAdd 파라미터를 사용하여 수동 DB 클러스터 스냅샷을 복원할 권한이 있는 Amazon 계정의 ID 목록을 추가합니다. 수동 DB 클러스터 스냅샷을 모든 Amazon 계정에서 복사하거나 복원할 수 있는 퍼블릭 스냅샷으로 만들려면 all 값을 사용합니다. 일부 Amazon 계정에서의 사용을 원치 않는 프라이빗 정보가 포함된 수동 DB 클러스터 스냅샷에는 all 값을 추가하지 않습니다. 수동 DB 클러스터 스냅샷이 암호화되어 있으면 공유할 수 있지만, 그러려면 반드시 ValuesToAdd 파라미터에 대한 권한이 있는 Amazon 계정의 ID 목록을 지정해야 합니다. 이 경우에는 해당 파라미터 값으로 all을 사용할 수 없습니다.

수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있는 Amazon 계정을 확인하거나, 수동 DB 클러스터 스냅샷이 퍼블릭인지 아니면 프라이빗인지 확인하려면 DescribeDBClusterSnapshotAttributes(작업) API 작업을 사용합니다.

요청

  • AttributeName(CLI의 경우: --attribute-name) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    수정할 DB 클러스터 스냅샷 속성의 이름입니다.

    다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있도록 권한 부여를 관리하려면 이 값을 restore로 설정합니다.

  • DBClusterSnapshotIdentifier(CLI의 경우: --db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    속성을 수정할 DB 클러스터 스냅샷의 식별자입니다.

  • ValuesToAdd(CLI의 경우: --values-to-add) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    AttributeName에 지정된 속성에 추가할 DB 클러스터 스냅샷 속성의 목록입니다.

    수동 DB 클러스터 스냅샷을 복사하거나 복원할 권한을 다른 Amazon 계정에 부여하려면 이 목록에 둘 이상의 Amazon 계정 ID를 포함시키거나, all을 사용하여 모든 Amazon 계정에서 이 수동 DB 클러스터 스냅샷을 복원할 수 있도록 합니다. 일부 Amazon 계정에서의 사용을 원치 않는 프라이빗 정보가 포함된 수동 DB 클러스터 스냅샷에는 all 값을 추가하지 않습니다.

  • ValuesToRemove(CLI의 경우: --values-to-remove) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    AttributeName에 지정된 속성에서 제거할 DB 클러스터 스냅샷 속성의 목록입니다.

    다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사하거나 복원할 권한을 제거하려면 이 목록에 둘 이상의 Amazon 계정 식별자를 포함시키거나, all을 사용하여 이 DB 클러스터 스냅샷을 복사하거나 복원할 권한을 모든 Amazon 계정에서 제거합니다. all을 지정하더라도 restore 속성에 계정 ID가 명시적으로 추가되어 있는 Amazon 계정은 여전히 수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있습니다.

응답

성공적인 DescribeDBClusterSnapshotAttributes(작업) API 작업 호출의 결과가 포함되어 있습니다.

수동 DB 클러스터 스냅샷 속성은 다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있도록 승인하는 데 사용됩니다. 자세한 내용은 ModifyDBClusterSnapshotAttribute(작업) API 작업을 참조하십시오.

  • DBClusterSnapshotAttributesDBClusterSnapshotAttribute 객체의 배열입니다.

    수동 DB 클러스터 스냅샷의 속성과 값 목록입니다.

  • DBClusterSnapshotIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    해당 속성이 적용되는 수동 DB 클러스터 스냅샷의 식별자입니다.

RestoreDBClusterFromSnapshot(작업)

        이 API의 AWS CLI 이름은 restore-db-cluster-from-snapshot입니다.

DB 스냅샷 또는 DB 클러스터 스냅샷에서 새 DB 클러스터를 생성합니다.

DB 스냅샷을 지정하는 경우, 기본 구성과 기본 보안 그룹으로 원본 DB 스냅샷에서 대상 DB 클러스터가 생성됩니다.

DB 클러스터 스냅샷을 지정하는 경우, 원래의 원본 DB 클러스터와 동일한 구성으로 원본 DB 클러스터의 복원 지점에서 대상 DB 클러스터가 생성됩니다. 단, 새 DB 클러스터가 기본 보안 그룹으로 생성된 경우는 예외입니다.

요청

  • AvailabilityZones(CLI의 경우: --availability-zones) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복원된 DB 클러스터의 인스턴스를 생성할 수 있는 EC2 가용 영역 목록을 알려 줍니다.

  • CopyTagsToSnapshot(CLI의 경우: --copy-tags-to-snapshot) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    true로 설정하면 생성된 복원 DB 클러스터의 모든 스냅샷에 태그가 복사됩니다.

  • DatabaseName(CLI의 경우: --database-name) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    지원하지 않음.

  • DBClusterIdentifier(CLI의 경우: --db-cluster-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 스냅샷 또는 DB 클러스터 스냅샷에서 생성할 DB 클러스터의 이름입니다. 이 파라미터는 대/소문자를 구분하지 않습니다.

    제약 조건:

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

    • 첫 번째 문자는 글자이어야 합니다

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

    예제: my-snapshot-id

  • DBClusterParameterGroupName(CLI의 경우: --db-cluster-parameter-group-name) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    제약 조건:

    • 입력하는 경우, 기존의 DBClusterParameterGroup 이름과 일치해야 합니다.

  • DBSubnetGroupName(CLI의 경우: --db-subnet-group-name) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    새 DB 클러스터에 사용할 DB 서브넷 그룹의 이름입니다.

    제약: 입력하는 경우 기존의 DBSubnetGroup 이름과 일치해야 합니다.

    예제: mySubnetgroup

  • DeletionProtection(CLI의 경우: --deletion-protection) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터의 삭제 방지 기능 활성화 여부를 나타내는 값입니다. 삭제 방지 기능이 활성화되면 데이터베이스가 삭제될 수 없습니다. 기본적으로 삭제 방지 기능은 비활성화됩니다.

  • EnableCloudwatchLogsExports(CLI의 경우: --enable-cloudwatch-logs-exports) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복구된 DB 클러스터가 Amazon CloudWatch Logs로 내보낼 로그 목록입니다.

  • EnableIAMDatabaseAuthentication(CLI의 경우: --enable-iam-database-authentication) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    AWS Identity and Access Management(AWS IAM) 계정을 데이터베이스 계정에 매핑하려면 true이고, 그렇지 않으면 false입니다.

    기본값: false

  • Engine(CLI의 경우: --engine) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    기본값: 원본과 동일합니다.

    제약: 원본의 엔진과 호환되어야 합니다.

  • EngineVersion(CLI의 경우: --engine-version) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    새 DB 클러스터에 사용할 데이터베이스 엔진의 버전입니다.

  • KmsKeyId(CLI의 경우: --kms-key-id) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 스냅샷 또는 DB 클러스터 스냅샷에서 암호화된 DB 클러스터를 복원할 때 사용할 Amazon KMS 키 식별자입니다.

    KMS 키 식별자는 KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 새 DB 클러스터를 암호화하는 데 사용되는 KMS 암호화 키를 소유 중인 바로 그 Amazon 계정으로 DB 클러스터를 복원하는 경우, KMS 암호화 키의 ARN 대신 KMS 키 별칭을 사용할 수 있습니다.

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

    • SnapshotIdentifier의 DB 스냅샷 또는 DB 클러스터 스냅샷이 암호화되어 있다면 그 DB 스냅샷 또는 DB 클러스터 스냅샷을 암호화할 때 사용한 KMS 키로 복원된 DB 클러스터를 암호화합니다.

    • SnapshotIdentifier의 DB 스냅샷 또는 DB 클러스터 스냅샷이 암호화되어 있지 않으면 복원된 DB 클러스터는 암호화되지 않습니다.

  • Port(CLI의 경우: --port) - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

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

    제약: 값은 1150-65535여야 합니다.

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

  • ServerlessV2ScalingConfiguration(CLI의 경우: --serverless-v2-scaling-configuration) - ServerlessV2ScalingConfiguration 객체입니다.

    Neptune 서버리스 DB 클러스터의 규모 조정 구성이 포함됩니다.

    자세한 내용을 알아보려면 Amazon Neptune 사용 설명서에 나와 있는 Amazon Neptune 서버리스 사용을 참조합니다.

  • SnapshotIdentifier(CLI의 경우: --snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복원에 사용할 DB 스냅샷 또는 DB 클러스터 스냅샷의 식별자입니다.

    DB 클러스터 스냅샷을 지정할 때는 이름 또는 Amazon 리소스 이름(ARN)을 사용할 수 있습니다. 그러나 DB 스냅샷을 지정할 때는 ARN만 사용해야 합니다.

    제약 조건:

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

  • StorageType(CLI의 경우: --storage-type) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    유효값: standard, iopt1

    기본값: standard

  • Tags(CLI의 경우: --tags) - Tag 객체의 배열입니다.

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

  • VpcSecurityGroupIds(CLI의 경우: --vpc-security-group-ids) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    새 DB 클러스터가 속하게 될 VPC 보안 그룹의 목록입니다.

응답

Amazon Neptune DB 클러스터에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusters(작업)에서 응답 요소로 사용됩니다.

  • AllocatedStorage - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    AllocatedStorage는 항상 1을 반환합니다. Neptune DB 클러스터는 크기가 고정되어 있지 않고 필요에 따라 자동으로 조정되기 때문입니다.

  • AssociatedRolesDBClusterRole 객체의 배열입니다.

    DB 클러스터와 연결되어 있는 Amazon Identity and Access Management(IAM) 역할의 목록을 제공합니다. DB 클러스터와 연결된 IAM 역할은 사용자 대신 다른 Amazon 서비스에 액세스할 수 있도록 DB 클러스터에 대한 권한을 부여합니다.

  • AutomaticRestartTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 자동으로 재시작되는 시각입니다.

  • AvailabilityZones - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 인스턴스를 만들 수 있는 EC2 가용 영역 목록을 제공합니다.

  • BacktrackConsumedChangeRecords - LongOptional, 유형은 long(64비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • BacktrackWindow - LongOptional, 유형은 long(64비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • BackupRetentionPeriod - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    자동 DB 스냅샷이 보관되는 일수를 지정합니다.

  • Capacity - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • CloneGroupId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터와 연결되어 있는 복제 그룹을 나타냅니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • CopyTagsToSnapshot - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    true로 설정하면 생성된 DB 클러스터의 모든 스냅샷에 태그가 복사됩니다.

  • CrossAccountClone - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    true로 설정하면 여러 계정에서 DB 클러스터를 복제할 수 있습니다.

  • DatabaseName - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터를 생성할 때 데이터베이스 이름을 지정한 경우, DB 클러스터 생성 시점에 입력한 최초 데이터베이스의 이름이 포함되어 있습니다. DB 클러스터의 수명 기간 동안 이 이름이 동일하게 반환됩니다.

  • DBClusterArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    사용자가 제공한 DB 클러스터 식별자가 포함되어 있습니다. 이 식별자는 DB 클러스터를 식별하는 고유한 키입니다.

  • DBClusterMembersDBClusterMember 객체의 배열입니다.

    DB 클러스터를 구성하는 인스턴스의 목록을 제공합니다.

  • DBClusterParameterGroup - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에 사용할 DB 클러스터 파라미터 그룹의 이름을 지정합니다.

  • DbClusterResourceId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Amazon 리전별로 고유하며 변경 불가능한 DB 클러스터의 식별자입니다. DB 클러스터의 Amazon KMS 키에 액세스할 때마다 Amazon CloudTrail 로그 항목에 이 식별자가 나타납니다.

  • DBSubnetGroup - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이름, 설명, 그리고 서브넷 그룹 내의 서브넷 등 DB 클러스터와 연결된 서브넷 그룹에 대한 정보를 지정합니다.

  • DeletionProtection - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터의 삭제 방지 기능 활성화 여부를 나타냅니다. 삭제 방지 기능이 활성화되면 데이터베이스가 삭제될 수 없습니다.

  • EarliestBacktrackTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    Neptune에서 지원되지 않습니다.

  • EarliestRestorableTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 이른 시간을 지정합니다.

  • EnabledCloudwatchLogsExports - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터에서 CloudWatch Logs로 내보내도록 구성된 로그 유형의 목록입니다. 유효한 로그 유형은 audit(CloudWatch에 감사 로그를 게시하는 경우) 및 slowquery(CloudWatch에 slowquery 로그를 게시하는 경우)입니다. 자세한 내용은 Amazon CloudWatch Logs에 Neptune 로그 게시를 참조하시기 바랍니다.

  • Endpoint - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 기본 인스턴스에 대한 연결 엔드포인트를 지정합니다.

  • Engine - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터에 사용할 데이터베이스 엔진의 이름을 제공합니다.

  • EngineVersion - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 버전을 나타냅니다.

  • GlobalClusterIdentifier - GlobalClusterIdentifier, 유형은 string(UTF-8 인코딩 문자열)이며, 이 정규식 [A-Za-z][0-9A-Za-z-:._]* 형식과 일치하고 1~255자를 초과하면 안 됩니다.

    사용자가 제공한 글로벌 데이터베이스 클러스터 식별자가 포함되어 있습니다. 이 식별자는 글로벌 데이터베이스를 식별하는 고유한 키입니다.

  • HostedZoneId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    호스팅 영역을 생성할 때 Amazon Route 53에서 할당하는 ID를 나타냅니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • IOOptimizedNextAllowedModificationTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    다음번에 DB 클러스터를 수정하여 iopt1 스토리지 유형을 사용하도록 할 수 있습니다.

  • KmsKeyId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터의 Amazon KMS 키 식별자입니다.

  • LatestRestorableTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 늦은 시간을 지정합니다.

  • MultiAZ - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터에 여러 가용 영역의 인스턴스가 있는지 여부를 나타냅니다.

  • PendingModifiedValuesClusterPendingModifiedValues 객체입니다.

    이 데이터 형식은 ModifyDBCluster 작업에서 응답 요소로 사용되며, 다음 유지 관리 기간에 적용되는 변경 사항이 포함되어 있습니다.

  • PercentProgress - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    작업의 진행 상황을 백분율로 나타냅니다.

  • Port - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    데이터베이스 엔진이 수신 대기하는 포트를 지정합니다.

  • PreferredBackupWindow - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위를 나타내며, BackupRetentionPeriod 속성에 의해 결정됩니다.

  • PreferredMaintenanceWindow - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

  • ReaderEndpoint - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에 대한 리더 엔드포인트입니다. DB 클러스터에서 사용 가능한 읽기 전용 복제본 간의 연결을 로드 밸런싱하는 DB 클러스터의 리더 엔드포인트입니다. 클라이언트가 리더 엔드포인트에 대한 새로운 연결을 요청하면 Neptune은 DB 클러스터 내의 읽기 전용 복제본 간에 연결 요청을 분배합니다. 이 기능은 DB 클러스터 내의 여러 읽기 전용 복제본 간에 읽기 워크로드의 균형을 유지하는 데 도움이 됩니다.

    장애 조치가 발생하고 사용자와 연결된 읽기 전용 복제본이 기본 인스턴스로 승격되면 연결이 끊어집니다. 읽기 워크로드를 클러스터 내의 다른 읽기 전용 복제본으로 계속 전송하려면 리더 엔드포인트에 다시 연결하면 됩니다.

  • ReadReplicaIdentifiers - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터와 연결된 읽기 전용 복제본의 식별자가 하나 이상 포함되어 있습니다.

  • ReplicationSourceIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Neptune에서 지원되지 않습니다.

  • ReplicationType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Neptune에서 지원되지 않습니다.

  • ServerlessV2ScalingConfigurationServerlessV2ScalingConfigurationInfo 객체입니다.

    Neptune 서버리스 DB 클러스터의 규모 조정 구성을 보여 줍니다.

    자세한 내용을 알아보려면 Amazon Neptune 사용 설명서에 나와 있는 Amazon Neptune 서버리스 사용을 참조하시기 바랍니다.

  • Status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터의 현재 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에서 사용하는 스토리지 유형입니다.

    유효한 값:

    • standard - (기본값) I/O 사용량이 보통이거나 적은 애플리케이션을 위해 비용 효율적인 데이터베이스 스토리지를 제공합니다.

    • iopt1 - 예측 가능한 요금으로 짧은 I/O 지연 시간과 일관된 I/O 처리량을 제공해야 하는 I/O 집약적 그래프 워크로드의 요구 사항을 충족하도록 설계된 I/O 최적화 스토리지를 활성화합니다.

      Neptune I/O 최적화 스토리지는 엔진 릴리스 1.3.0.0부터 사용할 수 있습니다.

  • VpcSecurityGroupsVpcSecurityGroupMembership 객체의 배열입니다.

    DB 클러스터가 속해 있는 VPC 보안 그룹의 목록을 제공합니다.

RestoreDBClusterToPointInTime(작업)

        이 API의 AWS CLI 이름은 restore-db-cluster-to-point-in-time입니다.

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

참고

이 작업은 DB 클러스터만 복원하고 그 DB 클러스터의 DB 인스턴스는 복원하지 않습니다. 복원된 DB 클러스터의 식별자를 DBClusterIdentifier로 지정하여 복원된 DB 클러스터의 DB 인스턴스를 생성하려면 CreateDBInstance(작업) 작업을 호출해야 합니다. RestoreDBClusterToPointInTime 작업이 완료되고 DB 클러스터를 사용할 수 있어야만 DB 인스턴스를 생성할 수 있습니다.

요청

  • DBClusterIdentifier(CLI의 경우: --db-cluster-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    제약 조건:

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

    • 첫 번째 문자는 글자이어야 합니다

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

  • DBClusterParameterGroupName(CLI의 경우: --db-cluster-parameter-group-name) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    제약 조건:

    • 입력하는 경우, 기존의 DBClusterParameterGroup 이름과 일치해야 합니다.

  • DBSubnetGroupName(CLI의 경우: --db-subnet-group-name) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    새 DB 클러스터에 사용할 DB 서브넷 그룹의 이름입니다.

    제약: 입력하는 경우 기존의 DBSubnetGroup 이름과 일치해야 합니다.

    예제: mySubnetgroup

  • DeletionProtection(CLI의 경우: --deletion-protection) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터의 삭제 방지 기능 활성화 여부를 나타내는 값입니다. 삭제 방지 기능이 활성화되면 데이터베이스가 삭제될 수 없습니다. 기본적으로 삭제 방지 기능은 비활성화됩니다.

  • EnableCloudwatchLogsExports(CLI의 경우: --enable-cloudwatch-logs-exports) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복구된 DB 클러스터가 CloudWatch Logs로 내보낼 로그 목록입니다.

  • EnableIAMDatabaseAuthentication(CLI의 경우: --enable-iam-database-authentication) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    AWS Identity and Access Management(AWS IAM) 계정을 데이터베이스 계정에 매핑하려면 true이고, 그렇지 않으면 false입니다.

    기본값: false

  • KmsKeyId(CLI의 경우: --kms-key-id) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    암호화된 DB 클러스터에서 암호화된 DB 클러스터를 복원할 때 사용할 Amazon KMS 키 식별자입니다.

    KMS 키 식별자는 KMS 암호화 키의 Amazon 리소스 이름(ARN)입니다. 새 DB 클러스터를 암호화하는 데 사용되는 KMS 암호화 키를 소유 중인 바로 그 Amazon 계정으로 DB 클러스터를 복원하는 경우, KMS 암호화 키의 ARN 대신 KMS 키 별칭을 사용할 수 있습니다.

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

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

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

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

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

  • Port(CLI의 경우: --port) - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

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

    제약: 값은 1150-65535여야 합니다.

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

  • RestoreToTime(CLI의 경우: --restore-to-time) - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터를 복원할 날짜와 시간입니다.

    유효한 값: 값은 협정 세계시(UTC) 형식의 시간이어야 합니다.

    제약 조건:

    • DB 인스턴스의 최근 복원 가능 시간보다 이전이어야 합니다.

    • UseLatestRestorableTime 파라미터를 제공하지 않은 경우에 지정해야 합니다.

    • UseLatestRestorableTime 파라미터가 true인 경우에는 지정할 수 없습니다.

    • RestoreType 파라미터가 copy-on-write인 경우에는 지정할 수 없습니다.

    예제: 2015-03-07T23:45:00Z

  • RestoreType(CLI의 경우: --restore-type) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    수행할 복원의 유형입니다. 다음 값 중 하나를 지정할 수 있습니다.

    • full-copy - 새 DB 클러스터가 소스 DB 클러스터의 전체 복사로서 복구됩니다.

    • copy-on-write - 새 DB 클러스터가 소스 DB 클러스터의 복제로서 복구됩니다.

    RestoreType 값을 지정하지 않으면 새 DB 클러스터가 소스 DB 클러스터의 전체 복사로서 복구됩니다.

  • ServerlessV2ScalingConfiguration(CLI의 경우: --serverless-v2-scaling-configuration) - ServerlessV2ScalingConfiguration 객체입니다.

    Neptune 서버리스 DB 클러스터의 규모 조정 구성이 포함됩니다.

    자세한 내용을 알아보려면 Amazon Neptune 사용 설명서에 나와 있는 Amazon Neptune 서버리스 사용을 참조합니다.

  • SourceDBClusterIdentifier(CLI의 경우: --source-db-cluster-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복원에 사용할 원본 DB 클러스터의 식별자입니다.

    제약 조건:

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

  • StorageType(CLI의 경우: --storage-type) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    유효값: standard, iopt1

    기본값: standard

  • Tags(CLI의 경우: --tags) - Tag 객체의 배열입니다.

    복원된 DB 클러스터에 적용할 태그입니다.

  • UseLatestRestorableTime(CLI의 경우: --use-latest-restorable-time) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

    기본값: false

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

  • VpcSecurityGroupIds(CLI의 경우: --vpc-security-group-ids) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

응답

Amazon Neptune DB 클러스터에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusters(작업)에서 응답 요소로 사용됩니다.

  • AllocatedStorage - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    AllocatedStorage는 항상 1을 반환합니다. Neptune DB 클러스터는 크기가 고정되어 있지 않고 필요에 따라 자동으로 조정되기 때문입니다.

  • AssociatedRolesDBClusterRole 객체의 배열입니다.

    DB 클러스터와 연결되어 있는 Amazon Identity and Access Management(IAM) 역할의 목록을 제공합니다. DB 클러스터와 연결된 IAM 역할은 사용자 대신 다른 Amazon 서비스에 액세스할 수 있도록 DB 클러스터에 대한 권한을 부여합니다.

  • AutomaticRestartTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 자동으로 재시작되는 시각입니다.

  • AvailabilityZones - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 인스턴스를 만들 수 있는 EC2 가용 영역 목록을 제공합니다.

  • BacktrackConsumedChangeRecords - LongOptional, 유형은 long(64비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • BacktrackWindow - LongOptional, 유형은 long(64비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • BackupRetentionPeriod - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    자동 DB 스냅샷이 보관되는 일수를 지정합니다.

  • Capacity - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    Neptune에서 지원되지 않습니다.

  • CloneGroupId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터와 연결되어 있는 복제 그룹을 나타냅니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • CopyTagsToSnapshot - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    true로 설정하면 생성된 DB 클러스터의 모든 스냅샷에 태그가 복사됩니다.

  • CrossAccountClone - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    true로 설정하면 여러 계정에서 DB 클러스터를 복제할 수 있습니다.

  • DatabaseName - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터를 생성할 때 데이터베이스 이름을 지정한 경우, DB 클러스터 생성 시점에 입력한 최초 데이터베이스의 이름이 포함되어 있습니다. DB 클러스터의 수명 기간 동안 이 이름이 동일하게 반환됩니다.

  • DBClusterArn - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    사용자가 제공한 DB 클러스터 식별자가 포함되어 있습니다. 이 식별자는 DB 클러스터를 식별하는 고유한 키입니다.

  • DBClusterMembersDBClusterMember 객체의 배열입니다.

    DB 클러스터를 구성하는 인스턴스의 목록을 제공합니다.

  • DBClusterParameterGroup - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에 사용할 DB 클러스터 파라미터 그룹의 이름을 지정합니다.

  • DbClusterResourceId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Amazon 리전별로 고유하며 변경 불가능한 DB 클러스터의 식별자입니다. DB 클러스터의 Amazon KMS 키에 액세스할 때마다 Amazon CloudTrail 로그 항목에 이 식별자가 나타납니다.

  • DBSubnetGroup - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이름, 설명, 그리고 서브넷 그룹 내의 서브넷 등 DB 클러스터와 연결된 서브넷 그룹에 대한 정보를 지정합니다.

  • DeletionProtection - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터의 삭제 방지 기능 활성화 여부를 나타냅니다. 삭제 방지 기능이 활성화되면 데이터베이스가 삭제될 수 없습니다.

  • EarliestBacktrackTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    Neptune에서 지원되지 않습니다.

  • EarliestRestorableTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 이른 시간을 지정합니다.

  • EnabledCloudwatchLogsExports - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터에서 CloudWatch Logs로 내보내도록 구성된 로그 유형의 목록입니다. 유효한 로그 유형은 audit(CloudWatch에 감사 로그를 게시하는 경우) 및 slowquery(CloudWatch에 slowquery 로그를 게시하는 경우)입니다. 자세한 내용은 Amazon CloudWatch Logs에 Neptune 로그 게시를 참조하시기 바랍니다.

  • Endpoint - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터의 기본 인스턴스에 대한 연결 엔드포인트를 지정합니다.

  • Engine - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터에 사용할 데이터베이스 엔진의 이름을 제공합니다.

  • EngineVersion - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 버전을 나타냅니다.

  • GlobalClusterIdentifier - GlobalClusterIdentifier, 유형은 string(UTF-8 인코딩 문자열)이며, 이 정규식 [A-Za-z][0-9A-Za-z-:._]* 형식과 일치하고 1~255자를 초과하면 안 됩니다.

    사용자가 제공한 글로벌 데이터베이스 클러스터 식별자가 포함되어 있습니다. 이 식별자는 글로벌 데이터베이스를 식별하는 고유한 키입니다.

  • HostedZoneId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    호스팅 영역을 생성할 때 Amazon Route 53에서 할당하는 ID를 나타냅니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • IOOptimizedNextAllowedModificationTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    다음번에 DB 클러스터를 수정하여 iopt1 스토리지 유형을 사용하도록 할 수 있습니다.

  • KmsKeyId - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터의 Amazon KMS 키 식별자입니다.

  • LatestRestorableTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    특정 시점으로 복원을 사용하여 데이터베이스를 복원할 수 있는 가장 늦은 시간을 지정합니다.

  • MultiAZ - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터에 여러 가용 영역의 인스턴스가 있는지 여부를 나타냅니다.

  • PendingModifiedValuesClusterPendingModifiedValues 객체입니다.

    이 데이터 형식은 ModifyDBCluster 작업에서 응답 요소로 사용되며, 다음 유지 관리 기간에 적용되는 변경 사항이 포함되어 있습니다.

  • PercentProgress - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    작업의 진행 상황을 백분율로 나타냅니다.

  • Port - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    데이터베이스 엔진이 수신 대기하는 포트를 지정합니다.

  • PreferredBackupWindow - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    자동 백업이 활성화된 경우 자동 백업이 생성되는 일일 시간 범위를 나타내며, BackupRetentionPeriod 속성에 의해 결정됩니다.

  • PreferredMaintenanceWindow - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

  • ReaderEndpoint - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에 대한 리더 엔드포인트입니다. DB 클러스터에서 사용 가능한 읽기 전용 복제본 간의 연결을 로드 밸런싱하는 DB 클러스터의 리더 엔드포인트입니다. 클라이언트가 리더 엔드포인트에 대한 새로운 연결을 요청하면 Neptune은 DB 클러스터 내의 읽기 전용 복제본 간에 연결 요청을 분배합니다. 이 기능은 DB 클러스터 내의 여러 읽기 전용 복제본 간에 읽기 워크로드의 균형을 유지하는 데 도움이 됩니다.

    장애 조치가 발생하고 사용자와 연결된 읽기 전용 복제본이 기본 인스턴스로 승격되면 연결이 끊어집니다. 읽기 워크로드를 클러스터 내의 다른 읽기 전용 복제본으로 계속 전송하려면 리더 엔드포인트에 다시 연결하면 됩니다.

  • ReadReplicaIdentifiers - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터와 연결된 읽기 전용 복제본의 식별자가 하나 이상 포함되어 있습니다.

  • ReplicationSourceIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Neptune에서 지원되지 않습니다.

  • ReplicationType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    Neptune에서 지원되지 않습니다.

  • ServerlessV2ScalingConfigurationServerlessV2ScalingConfigurationInfo 객체입니다.

    Neptune 서버리스 DB 클러스터의 규모 조정 구성을 보여 줍니다.

    자세한 내용을 알아보려면 Amazon Neptune 사용 설명서에 나와 있는 Amazon Neptune 서버리스 사용을 참조하시기 바랍니다.

  • Status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터의 현재 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터에서 사용하는 스토리지 유형입니다.

    유효한 값:

    • standard - (기본값) I/O 사용량이 보통이거나 적은 애플리케이션을 위해 비용 효율적인 데이터베이스 스토리지를 제공합니다.

    • iopt1 - 예측 가능한 요금으로 짧은 I/O 지연 시간과 일관된 I/O 처리량을 제공해야 하는 I/O 집약적 그래프 워크로드의 요구 사항을 충족하도록 설계된 I/O 최적화 스토리지를 활성화합니다.

      Neptune I/O 최적화 스토리지는 엔진 릴리스 1.3.0.0부터 사용할 수 있습니다.

  • VpcSecurityGroupsVpcSecurityGroupMembership 객체의 배열입니다.

    DB 클러스터가 속해 있는 VPC 보안 그룹의 목록을 제공합니다.

DescribeDBClusterSnapshots(작업)

        이 API의 AWS CLI 이름은 describe-db-cluster-snapshots입니다.

DB 클러스터 스냅샷에 대한 정보를 반환합니다. 이 API 작업은 페이지 매김을 지원합니다.

요청

  • DBClusterIdentifier(CLI의 경우: --db-cluster-identifier) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷 목록에서 검색할 DB 클러스터의 ID입니다. 이 파라미터는 DBClusterSnapshotIdentifier 파라미터와 함께 사용할 수 없습니다. 이 파라미터는 대소문자를 구분하지 않습니다.

    제약 조건:

    • 입력하는 경우, 기존 DB 클러스터의 식별자와 일치해야 합니다.

  • DBClusterSnapshotIdentifier(CLI의 경우: --db-cluster-snapshot-identifier) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    설명할 구체적인 DB 클러스터 스냅샷의 식별자입니다. 이 파라미터는 DBClusterIdentifier 파라미터와 함께 사용할 수 없습니다. 이 값은 소문자 문자열로 저장됩니다.

    제약 조건:

    • 입력하는 경우, 기존 DBClusterSnapshot의 식별자와 일치해야 합니다.

    • 이 식별자가 자동화된 스냅샷의 식별자인 경우, SnapshotType 파라미터도 지정해야 합니다.

  • Filters(CLI의 경우: --filters) - Filter 객체의 배열입니다.

    현재 지원되지 않는 파라미터입니다.

  • IncludePublic(CLI의 경우: --include-public) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    수동 DB 클러스터 스냅샷이 모든 Amazon 계정에서 복사 또는 복원할 수 있는 퍼블릭 스냅샷이면 true이고, 그렇지 않으면 false입니다. 기본값은입니다false. 기본값은 false입니다.

    ModifyDBClusterSnapshotAttribute(작업) API 작업을 사용하여 수동 DB 클러스터 스냅샷을 퍼블릭으로 만들어 공유할 수 있습니다.

  • IncludeShared(CLI의 경우: --include-shared) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    이 Amazon 계정에 복사 또는 복원 권한이 있으며 다른 Amazon 계정에서 공유한 수동 DB 클러스터 스냅샷을 포함시키려면 true이고, 그렇지 않으면 false입니다. 기본값은입니다false.

    ModifyDBClusterSnapshotAttribute(작업) API 작업으로 다른 Amazon 계정의 수동 DB 클러스터 스냅샷에 대한 복원 권한을 Amazon 계정에 부여할 수 있습니다.

  • Marker(CLI의 경우: --marker) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이전의 DescribeDBClusterSnapshots 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

  • MaxRecords(CLI의 경우: --max-records) - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    응답에 포함되는 최대 레코드 수입니다. 지정된 MaxRecords 값보다 레코드 수가 많으면 마커라고 부르는 페이지 매김 토큰을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.

    기본값: 100

    제약: 최소 20, 최대 100입니다.

  • SnapshotType(CLI의 경우: --snapshot-type) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

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

    • automated - Amazon Neptune이 내 Amazon 계정에 대해 자동으로 생성한 DB 클러스터 스냅샷을 모두 반환합니다.

    • manual - 내 Amazon 계정에서 생성한 DB 클러스터 스냅샷을 모두 반환합니다.

    • shared - 내 Amazon 계정과 공유된 수동 DB 클러스터 스냅샷을 모두 반환합니다.

    • public - 퍼블릭으로 표시된 DB 클러스터 스냅샷을 모두 반환합니다.

    SnapshotType 값을 지정하지 않으면 자동 및 수동 DB 클러스터 스냅샷이 둘 다 반환됩니다. IncludeShared 파라미터를 true로 설정하여 이러한 결과에 공유 DB 클러스터 스냅샷을 포함시킬 수 있습니다. IncludePublic 파라미터를 true로 설정하여 이러한 결과에 퍼블릭 DB 클러스터 스냅샷을 포함시킬 수 있습니다.

    SnapshotType 값이 manual 또는 automated인 경우 IncludeSharedIncludePublic 파라미터는 적용되지 않습니다. SnapshotTypeshared로 설정된 경우 IncludePublic 파라미터는 적용되지 않습니다. SnapshotTypepublic로 설정된 경우 IncludeShared 파라미터는 적용되지 않습니다.

응답

  • DBClusterSnapshotsDBClusterSnapshot 객체의 배열입니다.

    사용자의 DB 클러스터 스냅샷 목록을 제공합니다.

  • Marker - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이전의 DescribeDBClusterSnapshots(작업) 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

DescribeDBClusterSnapshotAttributes(작업)

        이 API의 AWS CLI 이름은 describe-db-cluster-snapshot-attributes입니다.

수동 DB 클러스터 스냅샷에 대한 DB 클러스터 스냅샷 속성 이름 및 값의 목록을 반환합니다.

다른 Amazon 계정과 스냅샷을 공유하는 경우, DescribeDBClusterSnapshotAttributes는 수동 DB 스냅샷의 복사 또는 복원 권한이 있는 Amazon 계정의 ID 목록과 restore 속성을 반환합니다. restore 속성의 값 목록에 all이 있으면 그 수동 DB 클러스터 스냅샷은 퍼블릭이고 모든 Amazon 계정에서 복사 또는 복원할 수 있습니다.

Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사 또는 복원할 수 있는 액세스 권한을 추가 또는 제거하거나 수동 DB 클러스터 스냅샷을 퍼블릭 또는 프라이빗으로 만들려면 ModifyDBClusterSnapshotAttribute(작업) API 작업을 사용합니다.

요청

  • DBClusterSnapshotIdentifier(CLI의 경우: --db-cluster-snapshot-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    속성을 설명할 DB 클러스터 스냅샷의 식별자입니다.

응답

성공적인 DescribeDBClusterSnapshotAttributes(작업) API 작업 호출의 결과가 포함되어 있습니다.

수동 DB 클러스터 스냅샷 속성은 다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있도록 승인하는 데 사용됩니다. 자세한 내용은 ModifyDBClusterSnapshotAttribute(작업) API 작업을 참조하십시오.

  • DBClusterSnapshotAttributesDBClusterSnapshotAttribute 객체의 배열입니다.

    수동 DB 클러스터 스냅샷의 속성과 값 목록입니다.

  • DBClusterSnapshotIdentifier - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    해당 속성이 적용되는 수동 DB 클러스터 스냅샷의 식별자입니다.

구조:

DBClusterSnapshot(구조)

Amazon Neptune DB 클러스터 스냅샷에 대한 세부 정보가 포함되어 있습니다.

이 데이터 형식은 DescribeDBClusterSnapshots(작업) 작업에서 응답 요소로 사용됩니다.

필드
  • AllocatedStorage - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    기가바이트(GiB) 단위의 할당된 스토리지 크기를 지정합니다.

  • AvailabilityZones - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 인스턴스를 복원할 수 있는 EC2 가용 영역 목록을 제공합니다.

  • ClusterCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    DB 클러스터가 생성된 시간(협정 세계시(UTC))을 나타냅니다.

  • DBClusterIdentifier - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷을 생성한 DB 클러스터의 DB 클러스터 식별자를 지정합니다.

  • DBClusterSnapshotArn - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)입니다.

  • DBClusterSnapshotIdentifier - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 식별자를 지정합니다. 기존 스냅샷의 식별자와 일치해야 합니다.

    DBClusterSnapshotIdentifier를 사용하여 DB 클러스터를 복원한 후에는 DB 클러스터에 대한 향후 업데이트 시 동일한 DBClusterSnapshotIdentifier를 지정해야 합니다. 이 속성을 업데이트에 지정할 경우 DB 클러스터가 스냅샷에서 다시 복원되지 않고 데이터베이스 내 데이터가 변경되지 않습니다.

    그러나 DBClusterSnapshotIdentifier를 지정하지 않을 경우 빈 DB 클러스터가 생성되고 원래 DB 클러스터가 삭제됩니다. 이전 스냅샷 복원 속성과 다른 속성을 지정할 경우 DB 클러스터가 DBClusterSnapshotIdentifier에서 지정한 스냅샷에서 복원되고 원래 DB 클러스터는 삭제됩니다.

  • Engine - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    데이터베이스 엔진의 이름을 지정합니다.

  • EngineVersion - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 데이터베이스 엔진의 버전을 알려 줍니다.

  • IAMDatabaseAuthenticationEnabled - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    Amazon Identity and Access Management(IAM) 계정을 데이터베이스 계정에 매핑하도록 되어 있으면 True이고, 그렇지 않으면 False입니다.

  • KmsKeyId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    StorageEncrypted가 true인 경우 암호화된 DB 클러스터 스냅샷의 Amazon KMS 키 식별자입니다.

  • LicenseModel - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷에 사용할 라이선스 모델 정보를 알려 줍니다.

  • PercentProgress - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    전송된 데이터의 추정 백분율을 나타냅니다.

  • Port - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

    스냅샷 생성 시점에 DB 클러스터가 수신하던 포트를 지정합니다.

  • SnapshotCreateTime - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    스냅샷이 생성된 시간을 나타냅니다(협정 세계시(UTC)).

  • SnapshotType - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷의 유형을 알려 줍니다.

  • SourceDBClusterSnapshotArn - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷을 소스 DB 클러스터 스냅샷에서 복사한 경우 그 소스 DB 클러스터 스냅샷의 Amazon 리소스 이름(ARN)이고, 그렇지 않으면 null 값입니다.

  • Status - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 DB 클러스터 스냅샷의 상태를 지정합니다.

  • StorageEncrypted - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

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

  • StorageType - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 스토리지 유형입니다.

  • VpcId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    DB 클러스터 스냅샷과 연결된 VPC ID를 알려 줍니다.

DBClusterSnapshot는 다음의 응답 요소로 사용됩니다.

DBClusterSnapshotAttribute(구조)

수동 DB 클러스터 스냅샷 속성의 이름과 값이 포함되어 있습니다.

수동 DB 클러스터 스냅샷 속성은 다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복원할 수 있도록 승인하는 데 사용됩니다. 자세한 내용은 ModifyDBClusterSnapshotAttribute(작업) API 작업을 참조하십시오.

필드
  • AttributeName - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    수동 DB 클러스터 스냅샷 속성의 이름입니다.

    restore라는 속성은 수동 DB 클러스터 스냅샷을 복사하거나 복원할 권한이 있는 Amazon 계정의 목록을 나타냅니다. 자세한 내용은 ModifyDBClusterSnapshotAttribute(작업) API 작업을 참조하십시오.

  • AttributeValues - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    수동 DB 클러스터 스냅샷 속성의 값입니다.

    AttributeName 필드가 restore로 설정된 경우, 이 요소는 수동 DB 클러스터 스냅샷을 복사하거나 복원할 권한이 있는 Amazon 계정의 ID 목록을 반환합니다. 이 목록에 all 값이 있으면 수동 DB 클러스터 스냅샷은 퍼블릭 스냅샷이며 모든 Amazon 계정에서 복사하거나 복원할 수 있습니다.

DBClusterSnapshotAttributesResult(구조)

성공적인 DescribeDBClusterSnapshotAttributes(작업) API 작업 호출의 결과가 포함되어 있습니다.

수동 DB 클러스터 스냅샷 속성은 다른 Amazon 계정에서 수동 DB 클러스터 스냅샷을 복사하거나 복원할 수 있도록 승인하는 데 사용됩니다. 자세한 내용은 ModifyDBClusterSnapshotAttribute(작업) API 작업을 참조하십시오.

필드
  • DBClusterSnapshotAttributes - DBClusterSnapshotAttribute 객체 배열입니다.

    수동 DB 클러스터 스냅샷의 속성과 값 목록입니다.

  • DBClusterSnapshotIdentifier - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

    해당 속성이 적용되는 수동 DB 클러스터 스냅샷의 식별자입니다.

DBClusterSnapshotAttributesResult는 다음의 응답 요소로 사용됩니다.