Neptune スナップショット API - Amazon Neptune
CreateDBClusterSnapshotDeleteDBClusterSnapshotCopyDBClusterSnapshotModifyDBClusterSnapshotAttributeRestoreDBClusterFromSnapshotRestoreDBClusterToPointInTimeDescribeDBClusterSnapshotsDescribeDBClusterSnapshotAttributes________________________DBClusterSnapshotDBClusterSnapshotAttributeDBClusterSnapshotAttributesResult

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Neptune スナップショット API

アクション:

構造:

CreateDBClusterSnapshot (アクション)

        この API の AWS CLI 名は create-db-cluster-snapshot です。

DB クラスターのスナップショットを作成します。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    スナップショットを作成する DB クラスターの識別子。このパラメータは大文字と小文字が区別されません。

    制約:

    • 既存の DBCluster の識別子と一致する必要があります。

    例: my-cluster1

  • DBClusterSnapshotIdentifier (CLI では: --db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの識別子。このパラメータは小文字で保存されます。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

    例: my-cluster1-snapshot1

  • Tags  (CLI では: --tags) - Tag オブジェクトの配列。

    DB クラスタースナップショットに割り当てられるタグ。

レスポンス

Amazon Neptune DB クラスタースナップショットの詳細が含まれています。

このデータ型は、DescribeDBClusterSnapshots (アクション) アクションのレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の整数 (符号付き 32 ビット整数)。

    割り当てられているストレージのサイズ (ギビバイト (GiB)) を指定します。

  • AvailabilityZones — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのインスタンスを復元できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • ClusterCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • DBClusterIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットの作成元の DB クラスターの DB クラスター識別子を指定します。

  • DBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの Amazon リソースネーム (ARN)。

  • DBClusterSnapshotIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの識別子を指定します。既存のスナップショットの識別子と一致する必要があります。

    DB クラスターの復元に DBClusterSnapshotIdentifier を使用した場合は、DB クラスターの以後の更新でも同じ DBClusterSnapshotIdentifier を指定する必要があります。更新でこのプロパティを指定すると、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。

    ただし、DBClusterSnapshotIdentifier を指定しない場合は、空の DB クラスターが作成され、元の DB クラスターは削除されます。以前のスナップショットの復元プロパティとは異なるプロパティを指定すると、DB クラスターは DBClusterSnapshotIdentifier で指定したスナップショットから復元され、元の DB クラスターは削除されます。

  • Engine — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    データベースエンジンの名前を指定します。

  • EngineVersion — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットに使用されるデータベースエンジンのバージョンを入力します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • KmsKeyId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスタースナップショットの Amazon KMS キー識別子。

  • LicenseModel — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのライセンスモデル情報を入力します。

  • PercentProgress - タイプ integer の整数 (符号付き 32 ビット整数)。

    転送された推定データの割合を指定します。

  • Port - タイプ integer の整数 (符号付き 32 ビット整数)。

    スナップショット時に DB クラスターが待機していたポートを指定します。

  • SnapshotCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    スナップショットが取られた時刻を協定世界時 (UTC) で入力します。

  • SnapshotType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのタイプを入力します。

  • SourceDBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットがソース DB クラスタースナップショットからコピーされた場合は、ソース DB クラスタースナップショットの Amazon リソースネーム (ARN)、それ以外の場合は null 値。

  • Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのステータスを指定します。

  • StorageEncrypted — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスタースナップショットが暗号化されているかどうかを指定します。

  • StorageType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられているストレージタイプ。

  • VpcId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられている VPC ID を入力します。

エラー

DeleteDBClusterSnapshot (アクション)

        この API の AWS CLI 名は delete-db-cluster-snapshot です。

DB クラスタースナップショットを削除します。スナップショットがコピーされている場合、コピー操作は終了します。

注記

DB クラスタースナップショットを削除するには、available 状態にする必要があります。

リクエスト

  • DBClusterSnapshotIdentifier (CLI では: --db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    削除する DB クラスタースナップショットの識別子。

    制約: available の状態にある既存の DB クラスタースナップショットの名前でなければなりません。

レスポンス

Amazon Neptune DB クラスタースナップショットの詳細が含まれています。

このデータ型は、DescribeDBClusterSnapshots (アクション) アクションのレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の整数 (符号付き 32 ビット整数)。

    割り当てられているストレージのサイズ (ギビバイト (GiB)) を指定します。

  • AvailabilityZones — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのインスタンスを復元できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • ClusterCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • DBClusterIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットの作成元の DB クラスターの DB クラスター識別子を指定します。

  • DBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの Amazon リソースネーム (ARN)。

  • DBClusterSnapshotIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの識別子を指定します。既存のスナップショットの識別子と一致する必要があります。

    DB クラスターの復元に DBClusterSnapshotIdentifier を使用した場合は、DB クラスターの以後の更新でも同じ DBClusterSnapshotIdentifier を指定する必要があります。更新でこのプロパティを指定すると、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。

    ただし、DBClusterSnapshotIdentifier を指定しない場合は、空の DB クラスターが作成され、元の DB クラスターは削除されます。以前のスナップショットの復元プロパティとは異なるプロパティを指定すると、DB クラスターは DBClusterSnapshotIdentifier で指定したスナップショットから復元され、元の DB クラスターは削除されます。

  • Engine — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    データベースエンジンの名前を指定します。

  • EngineVersion — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットに使用されるデータベースエンジンのバージョンを入力します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • KmsKeyId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスタースナップショットの Amazon KMS キー識別子。

  • LicenseModel — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのライセンスモデル情報を入力します。

  • PercentProgress - タイプ integer の整数 (符号付き 32 ビット整数)。

    転送された推定データの割合を指定します。

  • Port - タイプ integer の整数 (符号付き 32 ビット整数)。

    スナップショット時に DB クラスターが待機していたポートを指定します。

  • SnapshotCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    スナップショットが取られた時刻を協定世界時 (UTC) で入力します。

  • SnapshotType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのタイプを入力します。

  • SourceDBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットがソース DB クラスタースナップショットからコピーされた場合は、ソース DB クラスタースナップショットの Amazon リソースネーム (ARN)、それ以外の場合は null 値。

  • Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのステータスを指定します。

  • StorageEncrypted — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスタースナップショットが暗号化されているかどうかを指定します。

  • StorageType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられているストレージタイプ。

  • VpcId — タイプ 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 (ブール値 (真または偽))。

    ソース DB クラスタースナップショットからターゲット DB クラスタースナップショットにすべてのタグをコピーする場合は true、それ以外の場合は false です。デフォルトは [False] (偽) です。

  • KmsKeyId (CLI では: --kms-key-id) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    暗号化された DB クラスタースナップショットの Amazon Amazon KMS キー ID。KMS キー ID は、KMS 暗号化キーの Amazon リソースネーム (ARN)、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 (UTF-8 でエンコードされた文字列) の文字列。

    現在サポートされていません。

  • SourceDBClusterSnapshotIdentifier (CLI では: --source-db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    コピーする DB クラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。

    制約:

    • [available (使用可能)] 状態の有効なシステムスナップショットを指定する必要があります。

    • 有効な DB スナップショットの識別子を指定します。

    例: my-cluster-snapshot1

  • Tags  (CLI では: --tags) - Tag オブジェクトの配列。

    新しい DB クラスタースナップショットのコピーに割り当てるタグ。

  • TargetDBClusterSnapshotIdentifier (CLI では: --target-db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    ソース DB クラスタースナップショットから作成する新しい DB クラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

    例: my-cluster-snapshot2

レスポンス

Amazon Neptune DB クラスタースナップショットの詳細が含まれています。

このデータ型は、DescribeDBClusterSnapshots (アクション) アクションのレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の整数 (符号付き 32 ビット整数)。

    割り当てられているストレージのサイズ (ギビバイト (GiB)) を指定します。

  • AvailabilityZones — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのインスタンスを復元できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • ClusterCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • DBClusterIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットの作成元の DB クラスターの DB クラスター識別子を指定します。

  • DBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの Amazon リソースネーム (ARN)。

  • DBClusterSnapshotIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの識別子を指定します。既存のスナップショットの識別子と一致する必要があります。

    DB クラスターの復元に DBClusterSnapshotIdentifier を使用した場合は、DB クラスターの以後の更新でも同じ DBClusterSnapshotIdentifier を指定する必要があります。更新でこのプロパティを指定すると、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。

    ただし、DBClusterSnapshotIdentifier を指定しない場合は、空の DB クラスターが作成され、元の DB クラスターは削除されます。以前のスナップショットの復元プロパティとは異なるプロパティを指定すると、DB クラスターは DBClusterSnapshotIdentifier で指定したスナップショットから復元され、元の DB クラスターは削除されます。

  • Engine — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    データベースエンジンの名前を指定します。

  • EngineVersion — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットに使用されるデータベースエンジンのバージョンを入力します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • KmsKeyId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスタースナップショットの Amazon KMS キー識別子。

  • LicenseModel — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのライセンスモデル情報を入力します。

  • PercentProgress - タイプ integer の整数 (符号付き 32 ビット整数)。

    転送された推定データの割合を指定します。

  • Port - タイプ integer の整数 (符号付き 32 ビット整数)。

    スナップショット時に DB クラスターが待機していたポートを指定します。

  • SnapshotCreateTime — TStamp、タイプ timestamp（通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点）。

    スナップショットが取られた時刻を協定世界時 (UTC) で入力します。

  • SnapshotType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのタイプを入力します。

  • SourceDBClusterSnapshotArn — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットがソース DB クラスタースナップショットからコピーされた場合は、ソース DB クラスタースナップショットの Amazon リソースネーム (ARN)、それ以外の場合は null 値。

  • Status — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのステータスを指定します。

  • StorageEncrypted — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスタースナップショットが暗号化されているかどうかを指定します。

  • StorageType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられているストレージタイプ。

  • VpcId — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられている VPC ID を入力します。

エラー

ModifyDBClusterSnapshotAttribute (アクション)

        この API の AWS CLI 名は modify-db-cluster-snapshot-attribute です。

属性および値を、手動 DB クラスタースナップショットに追加するか、ここから属性および値を削除します。

手動 DB クラスタースナップショットを他の Amazon アカウントと共有するには、AttributeName として restore を指定し、ValuesToAdd パラメータを使用して手動 DB クラスタースナップショットを復元することを承認された Amazon アカウントの ID のリストを追加します。手動の DB クラスタースナップショットをパブリックにするには、値 all を使用します。これは、すべての Amazon アカウントでコピーまたは復元できることを意味します。ただし、すべての Amazon アカウントには利用させたくないプライベート情報を含む手動 DB クラスタースナップショットについては、値 all を追加しないように注意してください。手動の DB クラスタースナップショットが暗号化されている場合は、ValuesToAdd パラメータに承認された Amazon アカウント ID のリストを指定することによってのみ共有できます。この場合、そのパラメータの値として all を使用することはできません。

どの Amazon アカウントが手動 DB クラスタースナップショットをコピーまたは復元するアクセス権を持っているか、または手動 DB クラスタースナップショットがパブリックかプライベートかを確認するには、DescribeDBClusterSnapshotAttributes (アクション) API アクションを使用します。

リクエスト

  • AttributeName (CLI では: --attribute-name) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    変更する DB クラスタースナップショット属性の名前。

    手動の DB クラスタースナップショットをコピーまたは復元するための他の Amazon アカウントの認可を管理するには、この値を restore に設定します。

  • DBClusterSnapshotIdentifier (CLI では: --db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    属性を変更する DB クラスタースナップショットの識別子。

  • ValuesToAdd (CLI では: --values-to-add) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    AttributeName で指定された属性に追加する DB クラスタースナップショット属性のリスト

    手動の DB クラスタースナップショットをコピーまたは復元することを他の Amazon アカウントに許可するには、このリストを 1 つ以上の Amazon アカウント ID を含めるか、手動の DB クラスタースナップショットを任意の Amazon アカウントで復元できるように all を設定します。ただし、すべての Amazon アカウントには利用させたくないプライベート情報を含む手動 DB クラスタースナップショットについては、値 all を追加しないように注意してください。

  • ValuesToRemove (CLI では: --values-to-remove) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    AttributeName で指定された属性から削除する DB クラスタースナップショット属性のリスト。

    手動の DB クラスタースナップショットをコピーまたは復元するための他の Amazon アカウントに対する権限を削除するには、このリストに 1 つ以上の Amazon アカウント ID を含めるか、all でコピーまたは復元する Amazon アカウントに対する権限を削除します DB クラスタースナップショット all を指定しても、アカウント ID が restore 属性に明示的に追加されている Amazon アカウントでも、手動の DB クラスタースナップショットをコピーまたは復元できます。

レスポンス

DescribeDBClusterSnapshotAttributes (アクション) API アクションへの呼び出しが成功した結果が含まれています。

手動 DB クラスタースナップショット属性は、他の Amazon アカウントが手動 DB クラスタースナップショットをコピーまたは復元することを承認するために使用されます。詳細については、ModifyDBClusterSnapshotAttribute (アクション) API アクションを参照してください。

  • DBClusterSnapshotAttributes – DBClusterSnapshotAttribute オブジェクトの配列。

    手動 DB クラスタースナップショットの属性と値のリスト。

  • DBClusterSnapshotIdentifier — タイプ 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 の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーンのリストを入力します。

  • CopyTagsToSnapshot (CLI では: --copy-tags-to-snapshot) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    true に設定されている場合、タグは、作成された復元 DB クラスターのスナップショットにコピーされます。

  • DatabaseName (CLI では: --database-name) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    サポート外。

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB スナップショットまたは DB クラスタースナップショットから作成する DB クラスターの名前。このパラメータでは大文字と小文字は区別されません。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません

    例: my-snapshot-id

  • DBClusterParameterGroupName (CLI では: --db-cluster-parameter-group-name) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに関連付ける DB クラスターパラメータグループの名前。

    制約:

    • 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。

  • DBSubnetGroupName (CLI では: --db-subnet-group-name) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに使用する DB サブネットグループの名前。

    制約: 指定した場合、既存の DBSubnetGroup の名前と一致する必要があります。

    例: mySubnetgroup

  • DeletionProtection (CLI では: --deletion-protection) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は無効です。

  • EnableCloudwatchLogsExports (CLI では: --enable-cloudwatch-logs-exports) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    復元された DB クラスターが Amazon CloudWatch Logs にエクスポートするログのリスト。

  • EnableIAMDatabaseAuthentication (CLI では: --enable-iam-database-authentication) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

    デフォルト: false

  • Engine (CLI では: --engine) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに使用するデータベースエンジン。

    デフォルト: ソースオブジェクトと同じ

    制約: ソースのエンジンに対応する必要があります。

  • EngineVersion (CLI では: --engine-version) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    新しい DB クラスターに使用するデータベースエンジンのバージョン。

  • KmsKeyId (CLI では: --kms-key-id) — タイプ: 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 スナップショットまたは DB クラスタースナップショットの暗号化に使用された KMS キーを使用して暗号化されます。

    • 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 の文字列 (UTF-8 でエンコードされた文字列)。

    復元元の DB スナップショットまたは DB クラスタースナップショットの識別子。

    DB クラスタースナップショットを指定するには、名前または Amazon リソースネーム (ARN) のいずれかを使用できます。ただし、DB スナップショットを指定するには ARN のみを使用できます。

    制約:

    • 既存のスナップショットの識別子と一致する必要があります。

  • StorageType (CLI では: --storage-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターに関連付けられるストレージタイプを指定します。

    有効な値: standard、iopt1

    デフォルト: standard

  • Tags  (CLI では: --tags) - Tag オブジェクトの配列。

    復元された DB クラスターに割り当てられるタグ。

  • VpcSecurityGroupIds (CLI では: --vpc-security-group-ids) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    新しい DB クラスターが属する VPC セキュリティグループのリスト。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

  • AvailabilityZones — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

  • CloneGroupId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • CopyTagsToSnapshot — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

  • CrossAccountClone — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

  • DatabaseName — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

  • DBClusterArn — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの Amazon リソースネーム (ARN) を返します。

  • DBClusterIdentifier — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

  • DBClusterParameterGroup — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

  • DbClusterResourceId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

  • DBSubnetGroup — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

  • DeletionProtection — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

  • EnabledCloudwatchLogsExports — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

  • Endpoint — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

  • Engine — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

  • EngineVersion — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

  • HostedZoneId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

  • KmsKeyId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

  • MultiAZ — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

  • PercentProgress — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

  • PreferredBackupWindow — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

  • PreferredMaintenanceWindow — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

  • ReaderEndpoint — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

  • ReadReplicaIdentifiers — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

  • ReplicationSourceIdentifier — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    Neptune ではサポートされていません。

  • ReplicationType — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

  • Status — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

  • StorageType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    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 クラスターの DB インスタンスを作成するには、CreateDBInstance (アクション) アクションを呼び出す必要があります。RestoreDBClusterToPointInTime アクションが完了し、DB クラスターのスタータスが使用可能になった後でのみ、DB インスタンスを作成できます。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    作成される新しい DB クラスターの名前。

    制約:

    • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

    • 1 字目は英字である必要があります。

    • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません

  • DBClusterParameterGroupName (CLI では: --db-cluster-parameter-group-name) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに関連付ける DB クラスターパラメータグループの名前。

    制約:

    • 指定した場合、既存の DBClusterParameterGroup の名前と一致する必要があります。

  • DBSubnetGroupName (CLI では: --db-subnet-group-name) — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    新しい DB クラスターに使用する DB サブネットグループ名。

    制約: 指定した場合、既存の DBSubnetGroup の名前と一致する必要があります。

    例: mySubnetgroup

  • DeletionProtection (CLI では: --deletion-protection) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は無効です。

  • EnableCloudwatchLogsExports (CLI では: --enable-cloudwatch-logs-exports) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    復元された DB クラスターが CloudWatch Logs にエクスポートするログのリスト。

  • EnableIAMDatabaseAuthentication (CLI では: --enable-iam-database-authentication) — BooleanOptional、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

    デフォルト: false

  • KmsKeyId (CLI では: --kms-key-id) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB スナップショットまたは暗号化された DB クラスターから暗号化された DB クラスターを復元するときに使用する Amazon KMS キー識別子。

    KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しい DB クラスターの暗号化に使用する KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを復元する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。

    新しい DB クラスターに復元し、新しい DB クラスターをソース DB クラスターの暗号化に使用された KMS キーとは異なる KMS キーで暗号化することができます。新しい 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 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターを復元する日時。

    有効な値: 協定世界時 (UTC) 形式の時刻でなければなりません。

    制約:

    • DB インスタンスの復元可能な最新時刻より前である必要があります。

    • UseLatestRestorableTime パラメータを指定しない場合は、指定する必要があります。

    • UseLatestRestorableTime パラメータが true である場合は、指定することはできません。

    • RestoreType パラメータが copy-on-write である場合は、指定することはできません。

    例: 2015-03-07T23:45:00Z

  • RestoreType (CLI では: --restore-type) — タイプ: 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 の文字列 (UTF-8 でエンコードされた文字列)。

    復元元のソース DB クラスターの識別子。

    制約:

    • 既存の DBCluster の識別子と一致する必要があります。

  • StorageType (CLI では: --storage-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    DB クラスターに関連付けられるストレージタイプを指定します。

    有効な値: standard、iopt1

    デフォルト: standard

  • Tags  (CLI では: --tags) - Tag オブジェクトの配列。

    復元された DB クラスターに適用されるタグ。

  • UseLatestRestorableTime (CLI では: --use-latest-restorable-time) — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターを最新の復元可能なバックアップ時刻に復元する場合は true に、それ以外の場合は false に設定される値。

    デフォルト: false

    制約: RestoreToTime パラメータを指定した場合は、指定することはできません。

  • VpcSecurityGroupIds (CLI では: --vpc-security-group-ids) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    新しい DB クラスターが属する VPC セキュリティグループのリストを入力します。

レスポンス

Amazon Neptune DB クラスターの詳細が含まれています。

このデータ型は、DescribeDBClusters (アクション) でレスポンス要素として使用されます。

  • AllocatedStorage - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    AllocatedStorage は常に 1 を返します。これは、Neptune DB クラスターのストレージサイズが固定されていないため、必要に応じて自動的に調整されるためです。

  • AssociatedRoles – DBClusterRole オブジェクトの配列。

    DB クラスターに関連付けられている Amazon Identity and Access Management (IAM) ロールのリストを入力します。DB クラスターに関連付けられている IAM ロールは、ユーザーに代わって他の Amazon のサービスにアクセスするための DB クラスターへのアクセス許可を付与します。

  • AutomaticRestartTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが自動的に再起動される時刻。

  • AvailabilityZones — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターのインスタンスを作成できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • BacktrackConsumedChangeRecords — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BacktrackWindow — タイプ long の LongOptional (符号付き 64 ビット整数)。

    Neptune ではサポートされていません。

  • BackupRetentionPeriod - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動 DB スナップショットが保持される日数を指定します。

  • Capacity - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    Neptune ではサポートされていません。

  • CloneGroupId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターが関連付けられているクローングループを識別します。

  • ClusterCreateTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • CopyTagsToSnapshot — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    true に設定されている場合、タグは、作成された DB クラスターのいずれかのスナップショットにコピーされます。

  • CrossAccountClone — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    trueに設定されている場合、DB クラスターを複数のアカウント間でクローンできます。

  • DatabaseName — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの作成時に指定された場合は、作成時に提供されたこの DB クラスターの初期データベースの名前が入ります。DB クラスターの存続中はこれと同じ名前が返されます。

  • DBClusterArn — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの Amazon リソースネーム (ARN) を返します。

  • DBClusterIdentifier — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    ユーザーが指定した DB クラスター識別子が含まれています。この識別子は、DB クラスターを識別する一意のキーです。

  • DBClusterMembers – DBClusterMember オブジェクトの配列。

    DB クラスターを構成するインスタンスのリストを入力します。

  • DBClusterParameterGroup — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターに使用する DB クラスターパラメータグループの名前を指定します。

  • DbClusterResourceId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターの Amazon リージョン固有のイミュータブルな識別子。この識別子は、DB クラスターの Amazon KMS キーにアクセスするたびに Amazon CloudTrail ログエントリに記録されます。

  • DBSubnetGroup — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    サブネットグループ内の名前、説明、サブネットなど、DB クラスターに関連付けられているサブネットグループに関する情報を指定します。

  • DeletionProtection — BooleanOptional、タイプ:boolean (ブール値 (真または偽) の値)。

    DB クラスターで削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、データベースを削除することはできません。

  • EarliestBacktrackTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    Neptune ではサポートされていません。

  • EarliestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最も早い時刻を指定します。

  • EnabledCloudwatchLogsExports — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。有効なログタイプは、audit (監査ログを CloudWatch に公開する場合) と slowquery (スロークエリログを CloudWatch に公開する場合) です。「Amazon CloudWatch Logs への Neptune ログの発行」を参照してください。

  • Endpoint — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    DB クラスターのプライマリインスタンスの接続エンドポイントを指定します。

  • Engine — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターに使用されるデータベースエンジンの名前を入力します。

  • EngineVersion — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    データベースエンジンのバージョンを示します。

  • GlobalClusterIdentifier — GlobalClusterIdentifier、Type: string (UTF-8 でエンコードされた文字列)、1～255、正規表現 [A-Za-z][0-9A-Za-z-:._]* に一致。

    ユーザーが指定したグローバルクラスター識別子を含みます。この識別子は、グローバルクラスターを識別する一意のキーです。

  • HostedZoneId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • IOOptimizedNextAllowedModificationTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    次回は、iopt1 ストレージタイプを使用するように DB クラスターを変更できます。

  • KmsKeyId — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスターの Amazon KMS キー識別子。

  • LatestRestorableTime — TStamp、タイプ:timestamp (通常は 1970 年 1 月 1 日深夜 0 時からのオフセットとして定義される特定の時点)。

    特定時点への復元によりデータベースを復元できる最新の日時を指定します。

  • MultiAZ — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。

  • PendingModifiedValues – ClusterPendingModifiedValues オブジェクト。

    このデータ型は、ModifyDBCluster 操作でレスポンス要素として使用され、次のメンテナンスウィンドウに適用される変更を含みます。

  • PercentProgress — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    オペレーションの進行状況をパーセンテージで指定します。

  • Port - タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースエンジンがリッスンするポートを指定します。

  • PreferredBackupWindow — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    BackupRetentionPeriod に応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。

  • PreferredMaintenanceWindow — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。

  • ReaderEndpoint — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターのリーダーエンドポイント。DB クラスターの読み込みエンドポイントは、DB クラスター内で使用できるリードレプリカ間で接続を負荷分散します。クライアントが読み取りエンドポイントへの新規接続をリクエストすると、Neptune によって接続リクエストが DB クラスターのリードレプリカ間で配分されます。この機能は、DB クラスターの複数のリードレプリカ間の読み取りワークロードを分散させる役に立ちます。

    フェイルオーバーが発生し、接続しているリードレプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他のリードレプリカに送信し続けるために、読み込みエンドポイントに再接続することができます。

  • ReadReplicaIdentifiers — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターに関連付けられているリードレプリカの 1 つ以上の識別子を含みます。

  • ReplicationSourceIdentifier — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    Neptune ではサポートされていません。

  • ReplicationType — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    Neptune ではサポートされていません。

  • ServerlessV2ScalingConfiguration – ServerlessV2ScalingConfigurationInfo オブジェクト。

    Neptune サーバーレス DB クラスターのスケーリング設定を表示します。

    詳細については、「Amazon Neptune ユーザーガイド」の 「Amazon Neptune サーバーレスの使用」を参照してください。

  • Status — 文字列、タイプ: string (UTF-8 でエンコードされた文字列)。

    この DB クラスターの現在の状態を指定します。

  • StorageEncrypted - タイプ boolean のブール値 (ブール値 (真または偽))。

    DB クラスターが暗号化されているかどうかを指定します。

  • StorageType — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスターで使用するストレージタイプ。

    有効な値:

    • standard — (デフォルト) I/O 使用率が低いか中程度のアプリケーション向けに、費用対効果の高いデータベースストレージを提供します。

    • iopt1 — 料金が予測可能で、低い I/O レイテンシーと一貫した I/O スループットを必要とする I/O 集約型のグラフワークロードのニーズを満たすように設計された I/O 最適化ストレージを有効にします。

      Neptune I/O 最適化ストレージは、エンジンリリース 1.3.0.0 以降でのみ使用可能です。

  • VpcSecurityGroups – VpcSecurityGroupMembership オブジェクトの配列。

    DB クラスターが属する VPC セキュリティグループのリストを入力します。

エラー

DescribeDBClusterSnapshots (アクション)

        この API の AWS CLI 名は describe-db-cluster-snapshots です。

DB クラスタースナップショットに関する情報を返します。この API アクションはページ分割をサポートします。

リクエスト

  • DBClusterIdentifier (CLI では: --db-cluster-identifier) — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのリストを取得する DB クラスターの ID。このパラメータは、DBClusterSnapshotIdentifier パラメータと組み合わせて使用することはできません。このパラメータは大文字と小文字が区別されません。

    制約:

    • 指定した場合、既存の DBCluster の識別子と一致している必要があります。

  • DBClusterSnapshotIdentifier (CLI では: --db-cluster-snapshot-identifier) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    記述する特定の DB クラスタースナップショット識別子。このパラメータは、DBClusterIdentifier パラメータと組み合わせて使用することはできません。この値は小文字で保存されます。

    制約:

    • 指定した場合、既存の DBClusterSnapshot の識別子と一致している必要があります。

    • この識別子が自動スナップショット用の場合、SnapshotType パラメータも指定する必要があります。

  • Filters  (CLI では: --filters) - フィルター オブジェクトの配列。

    このパラメータは、現在サポートされていません。

  • IncludePublic (CLI では: --include-public) — ブール値、タイプ: boolean (ブール値 (真または偽))。

    パブリックであり、任意の Amazon アカウントでコピーまたは復元できる手動の DB クラスタースナップショットを含める場合は true、それ以外の場合は false です。デフォルトは false です。デフォルトは [False] (偽) です。

    手動 DB クラスタースナップショットは、ModifyDBClusterSnapshotAttribute (アクション) API アクションを使用してパブリックとして共有できます。

  • IncludeShared (CLI では: --include-shared) — ブール値、タイプ: boolean (ブール値 (真または偽))。

    この Amazon アカウントにコピーまたは復元のアクセス許可が与えられている他の Amazon アカウントからの共有手動 DB クラスタースナップショットを含める場合は true、それ以外の場合は false。デフォルトは false です。

    ModifyDBClusterSnapshotAttribute (アクション) API アクションを使用すると、Amazon アカウントに手動の DB クラスタースナップショットを別の Amazon アカウントから復元するアクセス許可を付与できます。

  • Marker (CLI では: --marker) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    以前の DescribeDBClusterSnapshots リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

  • MaxRecords (CLI では: --max-records) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    レスポンスに含めるレコードの最大数。指定された MaxRecords の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。

    デフォルト: 100

    制約: 最小 20、最大 100。

  • SnapshotType (CLI では: --snapshot-type) — タイプ: string (UTF-8 でエンコードされた文字列) の文字列。

    返される DB クラスタースナップショットのタイプ。次のいずれかの値を指定できます。

    • automated - Amazon アカウント用に Amazon Neptune によって自動的に取得されたすべての DB クラスタースナップショットを返します。

    • manual - Amazon アカウント用に Amazon Neptune によって自動的に取得されたすべての DB クラスタースナップショットを返します。

    • shared - Amazon アカウントに共有されているすべての手動 DB クラスタースナップショットを返します。

    • public - パブリックとしてマークされているすべての DB クラスタースナップショットを返します。

    SnapshotType 値を指定しない場合、自動および手動の両方の DB クラスタースナップショットが返されます。IncludeShared パラメータを true に設定することで、これらの結果に共有 DB クラスタースナップショットを含めることができます。IncludePublic パラメータを true に設定することで、これらの結果にパブリック DB クラスタースナップショットを含めることができます。

    IncludeShared および IncludePublic パラメータは、manual または automated の SnapshotType 値には適用されません。SnapshotType が shared に設定されている場合、IncludePublic パラメータは適用されません。SnapshotType が public に設定されている場合、IncludeShared パラメータは適用されません。

レスポンス

  • DBClusterSnapshots – DBClusterSnapshot オブジェクトの配列。

    ユーザーの DB クラスタースナップショットのリストを入力します。

  • Marker — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    以前の DescribeDBClusterSnapshots (アクション) リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

エラー

DescribeDBClusterSnapshotAttributes (アクション)

        この API の AWS CLI 名は describe-db-cluster-snapshot-attributes です。

手動の DB クラスタースナップショットの DB クラスタースナップショットの属性名と値のリストを返します。

スナップショットを他の Amazon アカウントと共有する場合、DescribeDBClusterSnapshotAttributes は restore 属性と手動 DB クラスタースナップショットのコピーまたは復元を許可された Amazon アカウントの ID のリストを返します。all が restore 属性の値の一覧に含まれている場合、手動 DB クラスタースナップショットは公開されており、すべての Amazon アカウントでコピーまたは復元できます。

手動の DB クラスタースナップショットをコピーまたは復元するため、または手動の DB クラスタースナップショットをパブリックまたはプライベートにするための Amazon アカウントへのアクセスを追加または削除するには、ModifyDBClusterSnapshotAttribute (アクション) API アクションを使用します。

リクエスト

  • DBClusterSnapshotIdentifier (CLI では: --db-cluster-snapshot-identifier) — 必須: タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    属性を記述する DB クラスタースナップショットの識別子。

レスポンス

DescribeDBClusterSnapshotAttributes (アクション) API アクションへの呼び出しが成功した結果が含まれています。

手動 DB クラスタースナップショット属性は、他の Amazon アカウントが手動 DB クラスタースナップショットをコピーまたは復元することを承認するために使用されます。詳細については、ModifyDBClusterSnapshotAttribute (アクション) API アクションを参照してください。

  • DBClusterSnapshotAttributes – DBClusterSnapshotAttribute オブジェクトの配列。

    手動 DB クラスタースナップショットの属性と値のリスト。

  • DBClusterSnapshotIdentifier — タイプ string の文字列 (UTF-8 でエンコードされた文字列)。

    属性が適用される手動 DB クラスタースナップショットの識別子。

エラー

構造:

DBClusterSnapshot (構造)

Amazon Neptune DB クラスタースナップショットの詳細が含まれています。

このデータ型は、DescribeDBClusterSnapshots (アクション) アクションのレスポンス要素として使用されます。

フィールド

  • AllocatedStorage — 整数、タイプ: integer (符号付き 32 ビット整数)。

    割り当てられているストレージのサイズ (ギビバイト (GiB)) を指定します。

  • AvailabilityZones — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのインスタンスを復元できる EC2 アベイラビリティーゾーン (AZ) のリストを入力します。

  • ClusterCreateTime — TStamp、タイプ: timestamp (一般的には 1970 年 1 月 1 日の深夜 0 時からのオフセットとして定義される特定の時点)。

    DB クラスターが作成された時刻を協定世界時 (UTC) で指定します。

  • DBClusterIdentifier — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットの作成元の DB クラスターの DB クラスター識別子を指定します。

  • DBClusterSnapshotArn — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの Amazon リソースネーム (ARN)。

  • DBClusterSnapshotIdentifier — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットの識別子を指定します。既存のスナップショットの識別子と一致する必要があります。

    DB クラスターの復元に DBClusterSnapshotIdentifier を使用した場合は、DB クラスターの以後の更新でも同じ DBClusterSnapshotIdentifier を指定する必要があります。更新でこのプロパティを指定すると、DB クラスターはスナップショットから再度復元されず、データベース内のデータは変更されません。

    ただし、DBClusterSnapshotIdentifier を指定しない場合は、空の DB クラスターが作成され、元の DB クラスターは削除されます。以前のスナップショットの復元プロパティとは異なるプロパティを指定すると、DB クラスターは DBClusterSnapshotIdentifier で指定したスナップショットから復元され、元の DB クラスターは削除されます。

  • Engine — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    データベースエンジンの名前を指定します。

  • EngineVersion — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットに使用されるデータベースエンジンのバージョンを入力します。

  • IAMDatabaseAuthenticationEnabled — ブール値、タイプ: boolean (ブール値 (真または偽))。

    Amazon Identity and Access Management (IAM) アカウントのデータベースアカウントへのマッピングが有効な場合は true、それ以外の場合は false です。

  • KmsKeyId — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    StorageEncrypted が true の場合、暗号化された DB クラスタースナップショットの Amazon KMS キー識別子。

  • LicenseModel — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのライセンスモデル情報を入力します。

  • PercentProgress — 整数、タイプ: integer (符号付き 32 ビット整数)。

    転送された推定データの割合を指定します。

  • Port — 整数、タイプ: integer (符号付き 32 ビット整数)。

    スナップショット時に DB クラスターが待機していたポートを指定します。

  • SnapshotCreateTime — TStamp、タイプ: timestamp (一般的には 1970 年 1 月 1 日の深夜 0 時からのオフセットとして定義される特定の時点)。

    スナップショットが取られた時刻を協定世界時 (UTC) で入力します。

  • SnapshotType — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットのタイプを入力します。

  • SourceDBClusterSnapshotArn — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットがソース DB クラスタースナップショットからコピーされた場合は、ソース DB クラスタースナップショットの Amazon リソースネーム (ARN)、それ以外の場合は null 値。

  • Status — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    この DB クラスタースナップショットのステータスを指定します。

  • StorageEncrypted — ブール値、タイプ: boolean (ブール値 (真または偽))。

    DB クラスタースナップショットが暗号化されているかどうかを指定します。

  • StorageType — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられているストレージタイプ。

  • VpcId — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    DB クラスタースナップショットに関連付けられている VPC ID を入力します。

DBClusterSnapshot は、以下のレスポンス要素として使用されます。

DBClusterSnapshotAttribute (構造)

手動 DB クラスタースナップショット属性の名前と値を含みます。

手動 DB クラスタースナップショット属性は、他の Amazon アカウントが手動 DB クラスタースナップショットを復元することを承認するために使用されます。詳細については、ModifyDBClusterSnapshotAttribute (アクション) API アクションを参照してください。

フィールド

  • AttributeName — これはタイプ string の文字列です (UTF-8 でエンコードされた文字列)。

    手動 DB クラスタースナップショット属性の名前。

    restore という名前の属性は、手動の DB クラスタースナップショットをコピーまたは復元するアクセス許可を持つ Amazon アカウントのリストを参照します。詳細については、ModifyDBClusterSnapshotAttribute (アクション) API アクションを参照してください。

  • AttributeValues — これはタイプ 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 の文字列です (UTF-8 でエンコードされた文字列)。

    属性が適用される手動 DB クラスタースナップショットの識別子。

DBClusterSnapshotAttributesResult は、以下のレスポンス要素として使用されます。