Neptune 파라미터 API - Amazon Neptune
CopyDBParameterGroupCopyDBClusterParameterGroupCreateDBParameterGroupCreateDBClusterParameterGroupDeleteDBParameterGroupDeleteDBClusterParameterGroupModifyDBParameterGroupModifyDBClusterParameterGroupResetDBParameterGroupResetDBClusterParameterGroupDescribeDBParametersDescribeDBParameterGroupsDescribeDBClusterParametersDescribeDBClusterParameterGroupsDescribeEngineDefaultParametersDescribeEngineDefaultClusterParameters________________________파라미터DBParameterGroupDBClusterParameterGroupDBParameterGroupStatus

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

Neptune 파라미터 API

작업:

구조:

CopyDBParameterGroup(작업)

        이 API의 AWS CLI 이름은 copy-db-parameter-group입니다.

지정된 DB 파라미터 그룹을 복사합니다.

요청

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

    소스 DB 파라미터 그룹의 식별자 또는 ARN입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

    제약 조건:

    • 유효한 DB 파라미터 그룹을 지정해야 합니다.

    • my-db-param-group과 같이 유효한 DB 파라미터 그룹 식별자 또는 유효한 ARN을 지정해야 합니다.

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

    복사된 DB 파라미터 그룹에 할당할 태그입니다.

  • TargetDBParameterGroupDescription(CLI의 경우: --target-db-parameter-group-description) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    복사된 DB 파라미터 그룹에 대한 설명입니다.

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

    복사한 DB 파라미터 그룹의 식별자입니다.

    제약 조건:

    • null이거나, 비워 두거나, 공백을 입력할 수 없습니다.

    • 1에서 255자리의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.

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

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

    예: my-db-parameter-group

응답

Amazon Neptune DB 파라미터 그룹에 대한 세부 정보가 포함되어 있습니다.

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

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

    DB 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    이 DB 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    DB 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 파라미터 그룹에 대한 고객 설명을 제공합니다.

오류

CopyDBClusterParameterGroup(작업)

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

지정된 DB 클러스터 파라미터 그룹을 복사합니다.

요청

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

    소스 DB 클러스터 파라미터 그룹의 식별자 또는 Amazon 리소스 이름(ARN)입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

    제약 조건:

    • 유효한 DB 클러스터 파라미터 그룹을 지정해야 합니다.

    • 소스 DB 클러스터 파라미터 그룹이 복사본과 동일한 Amazon 리전에 있는 경우, my-db-cluster-param-group과 같이 유효한 DB 파라미터 그룹 식별자 또는 유효한 ARN을 지정합니다.

    • 소스 DB 파라미터 그룹이 복사본과 다른 Amazon 리전에 있는 경우, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1과 같이 유효한 DB 클러스터 파라미터 그룹 ARN을 지정합니다.

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

    복사된 DB 클러스터 파라미터 그룹에 할당할 태그입니다.

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

    복사된 DB 클러스터 파라미터 그룹에 대한 설명입니다.

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

    복사된 DB 클러스터 파라미터 그룹의 식별자입니다.

    제약 조건:

    • null이거나, 비워 두거나, 공백을 입력할 수 없습니다.

    • 1에서 255자리의 문자, 숫자 또는 하이픈으로 구성되어야 합니다.

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

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

    예: my-cluster-param-group1

응답

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

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

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

    DB 클러스터 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    DB 클러스터 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹에 대한 고객 설명을 제공합니다.

오류

CreateDBParameterGroup(작업)

        이 API의 AWS CLI 이름은 create-db-parameter-group입니다.

새 DB 파라미터 그룹을 생성합니다.

처음에 DB 파라미터 그룹은 DB 인스턴스에서 사용하는 데이터베이스 엔진의 기본 파라미터로 생성됩니다. 원하는 파라미터에 사용자 지정 값을 입력하려면 그룹을 생성한 뒤 ModifyDBParameterGroup을 사용하여 수정해야 합니다. DB 파라미터 그룹을 생성한 뒤에는 ModifyDBInstance를 사용하여 DB 인스턴스와 연결해야 합니다. 새 DB 파라미터 그룹을 실행 중인 DB 인스턴스와 연결할 때는 DB 인스턴스를 장애 조치 없이 재부팅해야 새 DB 파라미터 그룹 및 연결된 설정이 적용됩니다.

중요

DB 파라미터 그룹을 생성한 후 해당 DB 파라미터 그룹을 기본 파라미터 그룹으로 사용하는 첫 번째 DB 인스턴스를 생성하기 전에 5분 이상 기다려야 합니다. 이렇게 하면 Amazon Neptune이 생성 작업을 완전히 마친 뒤에 그 파라미터 그룹을 새 DB 인스턴스의 기본값으로 사용할 수 있습니다. 이는 character_set_database 파라미터에서 정의한 기본 데이터베이스의 문자 세트와 같은 DB 인스턴스의 기본 데이터베이스를 생성할 때 필요한 파라미터에 특히 중요합니다. Amazon Neptune 콘솔의 Parameter Groups 옵션이나 DescribeDBParameters 명령을 사용하여 DB 파라미터 그룹이 생성 또는 수정되었는지 확인할 수 있습니다.

요청

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

    DB 파라미터 그룹 패밀리의 이름입니다. DB 파라미터 그룹은 단 하나의 DB 파라미터 그룹 패밀리와 연결할 수 있고, 그 DB 파라미터 그룹 패밀리와 호환되는 엔진 버전의 데이터베이스 엔진을 실행 중인 DB 인스턴스에만 적용할 수 있습니다.

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

    DB 파라미터 그룹의 이름입니다.

    제약 조건:

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

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

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

    참고

    이 값은 소문자 문자열로 저장됩니다.

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

    DB 파라미터 그룹에 대한 설명입니다.

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

    새 DB 파라미터 그룹에 할당할 태그입니다.

응답

Amazon Neptune DB 파라미터 그룹에 대한 세부 정보가 포함되어 있습니다.

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

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

    DB 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    이 DB 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    DB 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 파라미터 그룹에 대한 고객 설명을 제공합니다.

오류

CreateDBClusterParameterGroup(작업)

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

새 DB 클러스터 파라미터 그룹을 생성합니다.

DB 클러스터 파라미터 그룹의 파라미터는 DB 클러스터의 모든 인스턴스에 적용됩니다.

처음에 DB 클러스터 파라미터 그룹은 DB 클러스터의 인스턴스에서 사용하는 데이터베이스 엔진의 기본 파라미터로 생성됩니다. 원하는 파라미터에 사용자 지정 값을 입력하려면 그룹을 생성한 뒤 ModifyDBClusterParameterGroup(작업)을 사용하여 그룹을 수정해야 합니다. DB 클러스터 파라미터 그룹을 생성한 뒤에는 ModifyDBCluster(작업)를 사용하여 DB 클러스터와 연결해야 합니다. 새 DB 클러스터 파라미터 그룹을 실행 중인 DB 클러스터와 연결할 때는 DB 클러스터의 DB 인스턴스를 장애 조치 없이 재부팅해야 새 DB 파라미터 그룹 및 연결된 설정이 적용됩니다.

중요

DB 클러스터 파라미터 그룹을 생성한 후 해당 DB 클러스터 파라미터 그룹을 기본 파라미터 그룹으로 사용하는 첫 번째 DB 클러스터를 생성하기 전에 5분 이상 기다려야 합니다. 이렇게 하면 Amazon Neptune이 생성 작업을 완전히 마친 뒤에 그 DB 클러스터 파라미터 그룹을 새 DB 클러스터의 기본값으로 사용할 수 있습니다. 이는 character_set_database 파라미터로 정의한 기본 데이터베이스의 문자 세트 등 DB 클러스터의 기본 데이터베이스를 생성할 때 필요한 파라미터의 경우 특히 중요합니다. Amazon Neptune 콘솔의 파라미터 그룹 옵션이나 DescribeDBClusterParameters(작업) 명령을 사용하여 DB 클러스터 파라미터 그룹이 생성 또는 수정되었는지 확인할 수 있습니다.

요청

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

    DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

    • 기존 DBClusterParameterGroup의 이름과 일치해야 합니다.

    참고

    이 값은 소문자 문자열로 저장됩니다.

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

    DB 클러스터 파라미터 그룹 패밀리의 이름입니다. DB 클러스터 파라미터 그룹은 단 하나의 DB 클러스터 파라미터 그룹 패밀리와 연결할 수 있고, 그 DB 클러스터 파라미터 그룹 패밀리와 호환되는 엔진 버전의 데이터베이스 엔진을 실행 중인 DB 클러스터에만 적용할 수 있습니다.

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

    DB 클러스터 파라미터 그룹에 대한 설명입니다.

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

    새 DB 클러스터 파라미터 그룹에 할당할 태그입니다.

응답

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

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

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

    DB 클러스터 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    DB 클러스터 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹에 대한 고객 설명을 제공합니다.

오류

DeleteDBParameterGroup(작업)

        이 API의 AWS CLI 이름은 delete-db-parameter-group입니다.

지정된 DBParameterGroup을 삭제합니다. 삭제할 DBParameterGroup은 어떤 DB 인스턴스와도 연결할 수 없습니다.

요청

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

    DB 파라미터 그룹의 이름입니다.

    제약 조건:

    • 기존 DB 파라미터 그룹의 이름이어야 합니다.

    • 기본 DB 파라미터 그룹은 삭제할 수 없습니다.

    • 어떤 DB 인스턴스와도 연결할 수 없습니다.

응답

  • 무응답 파라미터.

오류

DeleteDBClusterParameterGroup(작업)

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

지정된 DB 클러스터 파라미터 그룹을 삭제합니다. 삭제할 DB 클러스터 파라미터 그룹은 어떤 DB 클러스터와도 연결할 수 없습니다.

요청

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

    DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

    • 기존 DB 클러스터 파라미터 그룹의 이름이어야 합니다.

    • 기본 DB 클러스터 파라미터 그룹은 삭제할 수 없습니다.

    • 어떤 DB 클러스터와도 연결할 수 없습니다.

응답

  • 무응답 파라미터.

오류

ModifyDBParameterGroup(작업)

        이 API의 AWS CLI 이름은 modify-db-parameter-group입니다.

DB 파라미터 그룹의 파라미터를 수정합니다. 하나 이상의 파라미터를 수정하려면 ParameterName, ParameterValue 및 ApplyMethod의 목록을 제출하십시오. 요청 하나에서 최대 20개의 파라미터를 수정할 수 있습니다.

참고

동적 파라미터의 변경 내용은 즉시 적용됩니다. 고정 파라미터를 변경할 경우, 파라미터 그룹과 연결된 DB 인스턴스에 대한 장애 조치 없이 재부팅해야 변경 사항이 적용됩니다.

중요

DB 파라미터 그룹을 수정한 후 해당 DB 파라미터 그룹을 기본 파라미터 그룹으로 사용하는 첫 번째 DB 인스턴스를 생성하기 전에 5분 이상 기다려야 합니다. 이렇게 하면 Amazon Neptune이 수정 작업을 완전히 마친 뒤에 그 파라미터 그룹을 새 DB 인스턴스의 기본값으로 사용할 수 있습니다. 이는 character_set_database 파라미터에서 정의한 기본 데이터베이스의 문자 세트와 같은 DB 인스턴스의 기본 데이터베이스를 생성할 때 필요한 파라미터에 특히 중요합니다. Amazon Neptune 콘솔의 Parameter Groups 옵션이나 DescribeDBParameters 명령을 사용하여 DB 파라미터 그룹이 생성 또는 수정되었는지 확인할 수 있습니다.

요청

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

    DB 파라미터 그룹의 이름입니다.

    제약 조건:

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

  • Parameters(CLI의 경우: --parameters) - 필수: 파라미터 객체의 배열입니다.

    파라미터 업데이트를 위한 파라미터 이름, 값, 적용 방법으로 구성된 배열입니다. 파라미터의 이름과 값, 적용 방법을 하나 이상 입력해야 하며, 이후의 인수는 선택 사항입니다. 요청 하나에서 최대 20개의 파라미터를 수정할 수 있습니다.

    유효한 값(적용 방법): immediate | pending-reboot

    참고

    즉시값은 동적 파라미터에만 사용할 수 있습니다. 재시작 보류중 값은 동적 파라미터와 정적 파라미터에 모두 사용 가능하며, DB 인스턴스를 장애 조치 없이 재부팅하면 변경 사항이 적용됩니다.

응답

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

    DB 파라미터 그룹의 이름을 제공합니다.

오류

ModifyDBClusterParameterGroup(작업)

        이 API의 AWS CLI 이름은 modify-db-cluster-parameter-group입니다.

DB 클러스터 파라미터 그룹의 파라미터를 수정합니다. 하나 이상의 파라미터를 수정하려면 ParameterName, ParameterValue 및 ApplyMethod의 목록을 제출하십시오. 요청 하나에서 최대 20개의 파라미터를 수정할 수 있습니다.

참고

동적 파라미터의 변경 내용은 즉시 적용됩니다. 고정 파라미터를 변경할 경우, 파라미터 그룹과 연결된 DB 클러스터에 대한 장애 조치 없이 재부팅해야 변경 사항이 적용됩니다.

중요

DB 클러스터 파라미터 그룹을 생성한 후 해당 DB 클러스터 파라미터 그룹을 기본 파라미터 그룹으로 사용하는 첫 번째 DB 클러스터를 생성하기 전에 5분 이상 기다려야 합니다. 이렇게 하면 Amazon Neptune이 생성 작업을 완전히 마친 뒤에 그 파라미터 그룹을 새 DB 클러스터의 기본값으로 사용할 수 있습니다. 이는 character_set_database 파라미터로 정의한 기본 데이터베이스의 문자 세트 등 DB 클러스터의 기본 데이터베이스를 생성할 때 필요한 파라미터의 경우 특히 중요합니다. Amazon Neptune 콘솔의 파라미터 그룹 옵션이나 DescribeDBClusterParameters(작업) 명령을 사용하여 DB 클러스터 파라미터 그룹이 생성 또는 수정되었는지 확인할 수 있습니다.

요청

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

    수정할 DB 클러스터 파라미터 그룹의 이름입니다.

  • Parameters(CLI의 경우: --parameters) - 필수: 파라미터 객체의 배열입니다.

    DB 클러스터 파라미터 그룹에서 수정할 파라미터의 목록입니다.

응답

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

    DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

    • 1에서 255자리의 문자 또는 숫자여야 합니다.

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

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

    참고

    이 값은 소문자 문자열로 저장됩니다.

오류

ResetDBParameterGroup(작업)

        이 API의 AWS CLI 이름은 reset-db-parameter-group입니다.

DB 파라미터 그룹의 파라미터를 엔진/시스템 기본값으로 수정합니다. 특정 파라미터를 재설정하려면 ParameterName 및 ApplyMethod의 목록을 제공해야 합니다. DB 파라미터 그룹 전체를 재설정하려면 DBParameterGroup 이름과 ResetAllParameters 파라미터를 지정합니다. 전체 그룹을 재설정하는 경우, 동적 파라미터는 즉시 업데이트되고 정적 파라미터는 pending-reboot로 설정되어 다음번 DB 인스턴스 재시작 또는 RebootDBInstance 요청 시 적용됩니다.

요청

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

    DB 파라미터 그룹의 이름입니다.

    제약 조건:

    • 기존 DBParameterGroup의 이름과 일치해야 합니다.

  • Parameters(CLI의 경우: --parameters) - 파라미터 객체의 배열입니다.

    DB 파라미터 그룹 전체를 재설정하려면 DBParameterGroup 이름과 ResetAllParameters 파라미터를 지정합니다. 특정 파라미터를 재설정하려면 ParameterName 및 ApplyMethod의 목록을 제공해야 합니다. 요청 하나에서 최대 20개의 파라미터를 수정할 수 있습니다.

    유효한 값(적용 방법): pending-reboot

  • ResetAllParameters(CLI의 경우: --reset-all-parameters) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 파라미터 그룹의 모든 파라미터를 기본값으로 재설정할지 여부(true 또는 false)를 지정합니다.

    기본값: true

응답

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

    DB 파라미터 그룹의 이름을 제공합니다.

오류

ResetDBClusterParameterGroup(작업)

        이 API의 AWS CLI 이름은 reset-db-cluster-parameter-group입니다.

DB 클러스터 파라미터 그룹의 파라미터를 기본값으로 수정합니다. 특정 파라미터를 재설정하려면 ParameterName 및 ApplyMethod의 목록을 제출해야 합니다. DB 클러스터 파라미터 그룹 전체를 재설정하려면 DBClusterParameterGroupName 및 ResetAllParameters 파라미터를 지정합니다.

전체 그룹을 재설정하는 경우, 동적 파라미터는 즉시 업데이트되고 정적 파라미터는 pending-reboot로 설정되어 다음번 DB 인스턴스 재시작 또는 RebootDBInstance(작업) 요청 시 적용됩니다. 업데이트된 정적 파라미터를 적용할 DB 클러스터의 모든 DB 인스턴스에 대해 RebootDBInstance(작업)를 호출해야 합니다.

요청

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

    재설정할 DB 클러스터 파라미터 그룹의 이름입니다.

  • Parameters(CLI의 경우: --parameters) - 파라미터 객체의 배열입니다.

    기본값으로 재설정하려는 DB 클러스터 파라미터 그룹의 파라미터 이름 목록입니다. ResetAllParameters 파라미터를 true로 설정한 경우 이 파라미터를 사용할 수 없습니다.

  • ResetAllParameters(CLI의 경우: --reset-all-parameters) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    DB 클러스터 파라미터 그룹의 모든 파라미터를 기본값으로 재설정하려면 이 값을 true로 설정하고, 그렇지 않으면 false로 설정합니다. Parameters 파라미터용으로 지정된 파라미터 이름 목록이 있는 경우에는 이 파라미터를 사용할 수 없습니다.

응답

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

    DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

    • 1에서 255자리의 문자 또는 숫자여야 합니다.

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

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

    참고

    이 값은 소문자 문자열로 저장됩니다.

오류

DescribeDBParameters(작업)

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

특정 DB 파라미터 그룹에 대한 세부 파라미터 목록을 반환합니다.

요청

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

    세부 정보를 반환할 특정 DB 파라미터 그룹의 이름입니다.

    제약 조건:

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

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

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

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

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

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

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

    기본값: 100

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

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

    반환할 파라미터 유형입니다.

    기본값: 모든 파라미터 유형이 반환됩니다.

    유효한 값: user | system | engine-default

응답

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

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

  • Parameters – 파라미터 객체의 배열입니다.

    파라미터(구조) 값의 목록입니다.

오류

DescribeDBParameterGroups(작업)

        이 API의 AWS CLI 이름은 describe-db-parameter-groups입니다.

DBParameterGroup 설명 목록을 반환합니다. DBParameterGroupName이 지정된 경우, 이 목록에는 지정된 DB 파라미터 그룹에 대한 설명만 포함됩니다.

요청

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

    세부 정보를 반환할 특정 DB 파라미터 그룹의 이름입니다.

    제약 조건:

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

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

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

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

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

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

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

    기본값: 100

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

응답

  • DBParameterGroups – DBParameterGroup 객체의 배열입니다.

    DBParameterGroup(구조) 인스턴스의 목록입니다.

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

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

오류

DescribeDBClusterParameters(작업)

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

특정 DB 클러스터 파라미터 그룹에 대한 세부 파라미터 목록을 반환합니다.

요청

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

    파라미터의 세부 정보를 반환할 특정 DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

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

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

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

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

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

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

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

    기본값: 100

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

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

    특정 소스의 파라미터만 반환됨을 나타내는 값입니다. 파라미터 소스는 engine, service 또는 customer가 될 수 있습니다.

응답

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

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

  • Parameters – 파라미터 객체의 배열입니다.

    DB 클러스터 파라미터 그룹의 파라미터 목록을 제공합니다.

오류

DescribeDBClusterParameterGroups(작업)

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

DBClusterParameterGroup 설명 목록을 반환합니다. DBClusterParameterGroupName 파라미터가 지정된 경우, 이 목록에는 지정된 DB 클러스터 파라미터 그룹에 대한 설명만 포함됩니다.

요청

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

    세부 정보를 반환할 특정 DB 클러스터 파라미터 그룹의 이름입니다.

    제약 조건:

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

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

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

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

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

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

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

    기본값: 100

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

응답

  • DBClusterParameterGroups – DBClusterParameterGroup 객체의 배열입니다.

    DB 클러스터 파라미터 그룹의 목록입니다.

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

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

오류

DescribeEngineDefaultParameters(작업)

        이 API의 AWS CLI 이름은 describe-engine-default-parameters입니다.

지정된 데이터베이스 엔진에 대한 기본 엔진 및 시스템 파라미터 정보를 반환합니다.

요청

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

    DB 파라미터 그룹 패밀리의 이름입니다.

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

    현재 지원되지 않습니다.

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

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

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

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

    기본값: 100

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

응답

성공한 DescribeEngineDefaultParameters(작업) 작업 호출의 결과가 포함되어 있습니다.

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

    엔진의 기본 파라미터를 적용할 DB 파라미터 그룹 패밀리의 이름을 지정합니다.

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

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

  • Parameters – 파라미터 객체의 배열입니다.

    엔진 기본 파라미터의 목록이 포함되어 있습니다.

DescribeEngineDefaultClusterParameters(작업)

        이 API의 AWS CLI 이름은 describe-engine-default-cluster-parameters입니다.

클러스터 데이터베이스 엔진에 대한 기본 엔진 및 시스템 파라미터 정보를 반환합니다.

요청

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

    엔진 파라미터 정보를 반환할 DB 클러스터 파라미터 그룹 패밀리의 이름입니다.

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

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

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

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

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

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

    기본값: 100

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

응답

성공한 DescribeEngineDefaultParameters(작업) 작업 호출의 결과가 포함되어 있습니다.

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

    엔진의 기본 파라미터를 적용할 DB 파라미터 그룹 패밀리의 이름을 지정합니다.

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

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

  • Parameters – 파라미터 객체의 배열입니다.

    엔진 기본 파라미터의 목록이 포함되어 있습니다.

구조:

파라미터(구조)

파라미터를 지정합니다.

필드

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

    파라미터의 유효한 값 범위를 지정합니다.

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

    파라미터 업데이트의 적용 시점을 나타냅니다.

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

    엔진별 파라미터 유형을 지정합니다.

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

    파라미터의 유효한 데이터 형식을 지정합니다.

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

    파라미터의 설명을 제공합니다.

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

    파라미터를 수정할 수 있는지 여부(true 또는 false)를 나타냅니다. 일부 파라미터에는 보안 또는 작동상의 의미가 있어 변경할 수 없습니다.

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

    파라미터를 적용할 수 있는 가장 빠른 엔진 버전입니다.

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

    파라미터의 이름을 지정합니다.

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

    파라미터의 값을 지정합니다.

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

    파라미터 값의 소스를 나타냅니다.

DBParameterGroup(구조)

Amazon Neptune DB 파라미터 그룹에 대한 세부 정보가 포함되어 있습니다.

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

필드

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

    DB 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    이 DB 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    DB 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 파라미터 그룹에 대한 고객 설명을 제공합니다.

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

DBClusterParameterGroup(구조)

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

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

필드

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

    DB 클러스터 파라미터 그룹의 Amazon 리소스 이름(ARN)입니다.

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

    DB 클러스터 파라미터 그룹의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹과 호환되는 DB 파라미터 그룹 패밀리의 이름을 제공합니다.

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

    이 DB 클러스터 파라미터 그룹에 대한 고객 설명을 제공합니다.

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

DBParameterGroupStatus(구조)

DB 파라미터 그룹의 상태입니다.

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

필드

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

    DB 파라미터 그룹의 이름입니다.

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

    파라미터 업데이트의 상태입니다.