Neptune インスタンス API - Amazon Neptune
CreateDBInstanceDeleteDBInstanceModifyDBInstanceRebootDBInstanceDescribeDBInstancesDescribeOrderableDBInstanceOptionsDescribeValidDBInstanceModifications________________________DBInstanceDBInstanceStatusInfoOrderableDBInstanceOptionPendingModifiedValuesValidStorageOptionsValidDBInstanceModificationsMessage

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

Neptune インスタンス API

アクション:

構造:

CreateDBInstance (アクション)

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

新しい DB インスタンスを作成します。

リクエスト

  • AutoMinorVersionUpgrade (CLI では: --auto-minor-version-upgrade) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    メンテナンスの時間帯に、DB インスタンスに自動的にマイナーエンジンアップグレードが適用されることを示します。

    デフォルト: true

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

    DB インスタンスが作成される EC2 アベイラビリティーゾーン。

    デフォルト: エンドポイントの Amazon リージョン内でランダムにシステムが選択したアベイラビリティーゾーン。

    例: us-east-1d

    制約: MultiAZ パラメータが true に設定されている場合、アベイラビリティーゾーンパラメータは指定できません。指定されたアベイラビリティーゾーンは、現在のエンドポイントと同じ Amazon リージョンにある必要があります。

  • BackupRetentionPeriod (CLI では: --backup-retention-period) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    自動バックアップを保管する日数。

    該当しません。自動バックアップの保持期間は、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

    デフォルト: 1

    制約:

    • 0 ～ 35 の値にする必要があります。

    • DB インスタンスがリードレプリカのソースである場合、0 に設定することはできません。

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

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

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

    インスタンスが属する DB クラスターの識別子。

    DB クラスターの作成については、「CreateDBCluster (アクション)」を参照してください。

    型: 文字列

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

    DB インスタンスのコンピューティング性能とメモリ容量 (例: db.m4.large)。すべての DB インスタンスクラスがすべての Amazon リージョンで使用できるわけではありません。

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

    DB インスタンス識別子。このパラメータは小文字で保存されます。

    制約:

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

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

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

    例: mydbinstance

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

    サポート外。

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

    この DB インスタンスに関連付ける DB パラメータグループの名前。この引数を省略すると、指定したエンジンのデフォルトの DBParameterGroup が使用されます。

    制約:

    • 1 ～ 255 の英字、数字、ハイフンである必要があります。

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

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

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

    この DB インスタンスに関連付ける DB セキュリティグループの一覧。

    デフォルト: データベースエンジンのデフォルトの DB セキュリティグループ。

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

    この DB インスタンスに関連付ける DB サブネットグループ。

    DB サブネットグループがない場合、それは VPC DB インスタンスではありません。

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

    DB インスタンスで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は無効です。「DB インスタンスを削除する」を参照してください。

    DB クラスターの DB インスタンスは、親 DB クラスターで削除保護が有効になっている場合でも削除できます。

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

    インスタンスを作成する Active Directory ドメインを指定します。

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

    ディレクトリサービスへの API 呼び出しを行うときに使用される IAM ロールの名前を指定します。

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

    CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。

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

    Neptune ではサポートされていません (無視)。

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

    このインスタンスに使用するデータベースエンジンの名前。

    有効な値: neptune

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

    使用するデータベースエンジンのバージョン番号。現在、このパラメータを設定しても効果はありません。

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

    初めに DB インスタンスに割り当てられるプロビジョンド IOPS (1 秒あたりの入力/出力操作数) の合計です。

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

    暗号化された DB インスタンスの Amazon KMS キー識別子。

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

    該当しません。KMS キー識別子は、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

    StorageEncrypted パラメータが true の場合で KmsKeyId パラメータの値を指定しない場合、Amazon Neptune はデフォルトの暗号化キーを使用します。Amazon KMS は、Amazon アカウント用にデフォルトの暗号化キーを作成します。Amazon アカウントには、Amazon リージョンごとにデフォルトの暗号化キーがあります。

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

    この DB インスタンスのライセンスモデル情報。

    有効な値: license-included | bring-your-own-license | general-public-license

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。拡張モニタリングメトリクスの収集を無効にするには、0 を指定します。デフォルトは 0 です。

    MonitoringRoleArn を指定した場合は、MonitoringInterval を 0 以外の値に設定する必要があります。

    有効な値: 0, 1, 5, 10, 15, 30, 60

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。例えば、arn:aws:iam:123456789012:role/emaccess です。

    MonitoringInterval を 0 以外に設定した場合は、MonitoringRoleArn 値を設定する必要があります。

  • MultiAZ (CLI では: --multi-az) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。MultiAZ パラメータが true に設定されている場合は、アベイラビリティーゾーンパラメータを設定できません。

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

    データベースが接続を受け入れるポート番号。

    該当しません。ポートは、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

    デフォルト: 8182

    型: 整数

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

    自動バックアップが作成される毎日の時間範囲。

    該当しません。自動バックアップを作成するための毎日の時間範囲は、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

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

    毎週 1 回のシステムメンテナンスを実行できる時間帯、世界標準時 (UTC)。

    形式: ddd:hh24:mi-ddd:hh24:mi

    デフォルトは、1 週間のうちのランダムな日に起こる、Amazon リージョンあたり 8 時間の範囲からランダムに選択された 30 分の時間窓です。

    有効な日数: Mon, Tue, Wed, Thu, Fri, Sat, Sun です。

    制約: 最小限の 30 分単位のウィンドウ。

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

    デフォルト: 1

    有効な値: 0 ～ 15

  • PubliclyAccessible (CLI では: --publicly-accessible) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    このフラグは、今後は使用しないでください。

  • StorageEncrypted (CLI では: --storage-encrypted) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

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

    該当しません。DB インスタンスの暗号化は、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

    デフォルト: false

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

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

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

    新しいインスタンスに割り当てるタグ。

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

    TDE 暗号化のためにインスタンスに関連付けるキーストアからの ARN。

  • TdeCredentialPassword (CLI の場合は --tde-credential-password) — string 型の SensitiveString (UTF-8 でエンコードされた文字列)。

    デバイスにアクセスするためのキーストアからの指定された ARN のパスワード。

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

    DB インスタンスのタイムゾーン。

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

    この DB インスタンスに関連付ける EC2 VPC セキュリティグループの一覧。

    該当しません。EC2 VPC セキュリティグループの関連リストは、DB クラスターによって管理されます。詳細については、「CreateDBCluster (アクション)」を参照してください。

    デフォルト: DB サブネットグループの VPC に対するデフォルトの EC2 VPC セキュリティグループ。

レスポンス

Amazon Neptune DB インスタンスの詳細が含まれています。

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

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

    マイナーバージョンのパッチを自動的に適用することを指定します。

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

    DB インスタンスを配置するアベイラビリティーゾーンの名前を指定します。

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

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

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

    この DB インスタンスの CA 証明書の識別子。

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

    タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを指定します。

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

    DB インスタンスが DB クラスターのメンバーである場合は、DB インスタンスがメンバーとなっている DB クラスターの名前が含まれます。

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

    DB インスタンスの Amazon リソースネーム (ARN)。

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

    DB インスタンスのコンピューティング名とメモリ容量クラスの名前が含まれています。

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

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

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

    DB インスタンスがリッスンするポートを指定します。DB インスタンスが DB クラスターの一部である場合は、DB クラスターのポートとは別のポートを指定できます。

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

    このデータベースの現在の状態を指定します。

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

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

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

    データベース名。

  • DBParameterGroups – DBParameterGroupStatus オブジェクトの配列。

    この DB インスタンスに適用される DB パラメータグループのリストを入力します。

  • DBSecurityGroups – DBSecurityGroupMembership オブジェクトの配列。

    DBSecurityGroup.Name と DBSecurityGroup.Status のサブ要素のみを含む DB セキュリティグループ要素の一覧を入力します。

  • DBSubnetGroup – DBSubnetGroup オブジェクト。

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

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

    DB インスタンスで削除保護が有効になっているかどうかを示します。削除保護が有効な場合、インスタンスは削除できません。「DB インスタンスを削除する」を参照してください。

  • DomainMemberships – DomainMembership オブジェクトの配列。

    サポートされません

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

    この DB インスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。

  • Endpoint – エンドポイント オブジェクト。

    接続エンドポイントを指定します。

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

    この DB インスタンスに使用されるデータベースエンジンの名前を提供します。

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

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

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

    DB インスタンスの拡張モニタリングメトリクスデータを受け取る Amazon CloudWatch Logs ログストリームの Amazon リソースネーム (ARN)。

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

    Amazon Identity and Access Management (IAM) 認証が有効な場合は true、それ以外の場合は false です。

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

    DB インスタンスが作成された日時を入力します。

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

    プロビジョンド IOPS(I/O operations per second) を指定します。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    この DB インスタンスのライセンスモデル情報。

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。

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

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。

  • PendingModifiedValues – PendingModifiedValues オブジェクト。

    DB インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。

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

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

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

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

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

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

    このフラグは、今後は使用しないでください。

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

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

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

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

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

    この DB インスタンスがリードレプリカの場合は、ソース DB インスタンスの識別子が含まれます。

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

    存在する場合は、マルチ AZ をサポートする DB インスタンスのセカンダリアベイラビリティーゾーンの名前を指定します。

  • StatusInfos – DBInstanceStatusInfo オブジェクトの配列。

    リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    インスタンスが TDE 暗号化のために関連付けられているキーストアからの ARN。

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

    サポート外。

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

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

エラー

DeleteDBInstance (アクション)

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

DeleteDBInstance アクションでは、以前にプロビジョニングされた DB インスタンスを削除します。DB インスタンスを削除すると、そのインスタンスの自動バックアップはすべて削除され、復旧することはできません。DeleteDBInstance によって削除される DB インスタンスの手動 DB スナップショットは削除されません。

最終的な DB スナップショットをリクエストした場合、Amazon Neptune DB インスタンスのステータスは、DB スナップショットが作成されるまで deleting になります。API アクション DescribeDBInstance は、このオペレーションのステータスを監視するために使用されます。一度送信したアクションをキャンセルまたは元に戻すことはできません。

DB インスタンスが障害状態にあり、ステータスが failed、incompatible-restore、または incompatible-network である場合、そのインスタンスを削除できるのは SkipFinalSnapshot パラメータが true に設定されている場合のみであることに注意してください。

DB インスタンスが DB クラスター内の唯一のインスタンスの場合、または削除保護が有効になっている場合、その DB インスタンスを削除することはできません。

リクエスト

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

    削除する DB インスタンスの DB インスタンス識別子。このパラメータでは大文字と小文字は区別されません。

    制約:

    • 既存の DB インスタンスの名前と一致する必要があります。

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

    SkipFinalSnapshot が false に設定されている場合に作成される新しい DBSnapshot の DBSnapshotIdentifier。

    注記

    このパラメータを指定して SkipFinalShapshot パラメータを true に設定すると、エラーが発生します。

    制約:

    • 1 ～ 255 文字の英字または数字でなければなりません。

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

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

    • リードレプリカの削除時に指定することはできません。

  • SkipFinalSnapshot (CLI では: --skip-final-snapshot) — タイプ boolean のブール値 (ブール値 (真または偽))。

    DB インスタンスの削除前に最終 DB スナップショットを作成するかどうかを決定します。true を指定した場合、DB スナップショットが作成されます。false が指定されている場合、DB インスタンスの削除前に DB スナップショットが作成されます。

    DB インスタンスが障害状態にあり、ステータスが「失敗」、「互換性のない復元」、または「互換性のないネットワーク」の場合、SkipFinalSnapshot パラメータが「true」に設定されている場合にのみ削除できます。

    リードレプリカを削除するときは、true を指定してください。

    注記

    SkipFinalSnapshot が false の場合は、FinalDBSnapshotIdentifier パラメータを指定する必要があります。

    デフォルト: false

レスポンス

Amazon Neptune DB インスタンスの詳細が含まれています。

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

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

    マイナーバージョンのパッチを自動的に適用することを指定します。

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

    DB インスタンスを配置するアベイラビリティーゾーンの名前を指定します。

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

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

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

    この DB インスタンスの CA 証明書の識別子。

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

    タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを指定します。

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

    DB インスタンスが DB クラスターのメンバーである場合は、DB インスタンスがメンバーとなっている DB クラスターの名前が含まれます。

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

    DB インスタンスの Amazon リソースネーム (ARN)。

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

    DB インスタンスのコンピューティング名とメモリ容量クラスの名前が含まれています。

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

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

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

    DB インスタンスがリッスンするポートを指定します。DB インスタンスが DB クラスターの一部である場合は、DB クラスターのポートとは別のポートを指定できます。

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

    このデータベースの現在の状態を指定します。

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

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

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

    データベース名。

  • DBParameterGroups – DBParameterGroupStatus オブジェクトの配列。

    この DB インスタンスに適用される DB パラメータグループのリストを入力します。

  • DBSecurityGroups – DBSecurityGroupMembership オブジェクトの配列。

    DBSecurityGroup.Name と DBSecurityGroup.Status のサブ要素のみを含む DB セキュリティグループ要素の一覧を入力します。

  • DBSubnetGroup – DBSubnetGroup オブジェクト。

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

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

    DB インスタンスで削除保護が有効になっているかどうかを示します。削除保護が有効な場合、インスタンスは削除できません。「DB インスタンスを削除する」を参照してください。

  • DomainMemberships – DomainMembership オブジェクトの配列。

    サポートされません

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

    この DB インスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。

  • Endpoint – エンドポイント オブジェクト。

    接続エンドポイントを指定します。

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

    この DB インスタンスに使用されるデータベースエンジンの名前を提供します。

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

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

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

    DB インスタンスの拡張モニタリングメトリクスデータを受け取る Amazon CloudWatch Logs ログストリームの Amazon リソースネーム (ARN)。

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

    Amazon Identity and Access Management (IAM) 認証が有効な場合は true、それ以外の場合は false です。

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

    DB インスタンスが作成された日時を入力します。

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

    プロビジョンド IOPS(I/O operations per second) を指定します。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    この DB インスタンスのライセンスモデル情報。

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。

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

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。

  • PendingModifiedValues – PendingModifiedValues オブジェクト。

    DB インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。

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

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

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

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

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

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

    このフラグは、今後は使用しないでください。

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

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

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

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

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

    この DB インスタンスがリードレプリカの場合は、ソース DB インスタンスの識別子が含まれます。

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

    存在する場合は、マルチ AZ をサポートする DB インスタンスのセカンダリアベイラビリティーゾーンの名前を指定します。

  • StatusInfos – DBInstanceStatusInfo オブジェクトの配列。

    リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    インスタンスが TDE 暗号化のために関連付けられているキーストアからの ARN。

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

    サポート外。

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

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

エラー

ModifyDBInstance (アクション)

        この API の AWS CLI 名は modify-db-instance です。

DB インスタンスの設定を変更します。これらのパラメータとリクエストに新しい値を指定することで、1 つ以上のデータベース設定パラメータを変更できます。DB インスタンスにどのような変更を加えることができるかについて知るには、ModifyDBInstance (アクション) を呼び出す前に DescribeValidDBInstanceModifications (アクション) を呼び出します。

リクエスト

  • AllowMajorVersionUpgrade (CLI では: --allow-major-version-upgrade) — タイプ boolean のブール値 (ブール値 (真または偽))。

    メジャーバージョンアップグレードが許可されることを示します。このパラメータの変更が停止につながらなければ、変更は非同期的に可能な限り迅速に適用されます。

  • ApplyImmediately (CLI では: --apply-immediately) — タイプ boolean のブール値 (ブール値 (真または偽))。

    DB インスタンスの PreferredMaintenanceWindow の設定に関係なく、このリクエストの変更と保留中の変更をできるだけ早く非同期に適用するかどうかを指定します。

    このパラメータを false に設定した場合、DB インスタンスへの変更は次のメンテナンスウィンドウ中に適用されます。パラメータの変更によっては機能停止を引き起こす可能性があり、次回の RebootDBInstance (アクション) への呼び出し、または次回の再起動の失敗時に適用されます。

    デフォルト: false

  • AutoMinorVersionUpgrade (CLI では: --auto-minor-version-upgrade) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    メンテナンスの時間帯に、DB インスタンスに自動的にマイナーバージョンアップグレードが適用されることを示します。次の場合を除き、このパラメータを変更しても機能停止にはならず、変更はできるだけ早く非同期的に適用されます。機能停止は、メンテナンスウィンドウ中にこのパラメータが true に設定されており、新しいマイナーバージョンが使用可能で、Neptune でそのエンジンバージョンの自動パッチ適用が有効になっている場合に発生します。

  • BackupRetentionPeriod (CLI では: --backup-retention-period) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    該当しません。自動バックアップの保持期間は、DB クラスターによって管理されます。詳細については、「ModifyDBCluster (アクション)」を参照してください。

    デフォルト: 既存の設定を仕様

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

    インスタンスに関連付ける必要のある証明書を示します。

  • CloudwatchLogsExportConfiguration (CLI では: --cloudwatch-logs-export-configuration) — CloudwatchLogsExportConfiguration オブジェクト。

    特定の DB インスタンスまたは DB クラスターの CloudWatch Logs にエクスポートするために有効にするログタイプの設定。

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

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

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

    DB インスタンスの新しいコンピューティング性能とメモリ容量 (例: db.m4.large)。すべての DB インスタンスクラスがすべての Amazon リージョンで使用できるわけではありません。

    DB インスタンスクラスを変更すると、変更中に機能停止が発生します。ApplyImmediately がこのリクエストの true として指定されない限り、変更は次のメンテナンスウィンドウ中に適用されます。

    デフォルト: 既存の設定を仕様

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

    DB インスタンス識別子。この値は小文字で保存されます。

    制約:

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

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

    この DB インスタンスに適用される DB パラメータグループの名前。この設定を変更しても機能は停止しません。パラメータグループ名自体は即時に変更されますが、フェイルオーバーなしでインスタンスを再起動するまで実際のパラメータの変更は適用されません。db インスタンスは自動的には再起動されず、次のメンテナンス時までパラメータの変更は適用されません。

    デフォルト: 既存の設定を仕様

    制約: DB パラメータグループは、この DB インスタンスと同じ DB パラメータグループファミリに属している必要があります。

  • DBPortNumber (CLI では: --db-port-number) — タイプ integer の IntegerOptional (符号付き 32 ビット整数)。

    データベースが接続を受け入れるポート番号。

    DBPortNumber の値は、DB インスタンスのオプショングループのオプションに指定されているポート値と一致しないようにしてください。

    DBPortNumber 値を変更すると、ApplyImmediately パラメータの値に関係なくデータベースが再起動されます。

    デフォルト: 8182

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

    この DB インスタンスで承認する DB セキュリティグループの一覧。この設定を変更しても機能停止が発生しない場合、変更は可能な限り早く非同期的に適用されます。

    制約:

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

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

    DB インスタンスの新しい DB サブネットグループ。このパラメータを使用して、DB インスタンスを別の VPC に移動できます。

    サブネットグループを変更すると、変更時に機能停止が発生します。ApplyImmediately パラメータに true を指定しない限り、変更は次のメンテナンス期間中に適用されます。

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

    例: mySubnetGroup

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

    DB インスタンスで削除保護が有効になっているかどうかを示す値。削除保護が有効になっている場合、データベースを削除することはできません。デフォルトでは、削除保護は無効です。「DB インスタンスを削除する」を参照してください。

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

    サポート外。

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

    サポートされません

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

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

    次のデータベースエンジンには、IAM データベース認証を有効にできます。

    該当しません。Amazon IAM アカウントのデータベースアカウンへのマッピングは、DB クラスターによって管理されます。詳細については、「ModifyDBCluster (アクション)」を参照してください。

    デフォルト: false

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

    アップグレード先のデータベースエンジンのバージョン番号です。現在、このパラメータを設定しても効果はありません。データベースエンジンを最新のリリースにアップグレードするには、ApplyPendingMaintenanceAction (アクション) API を使用します。

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

    インスタンスの新しいプロビジョンド IOPS (I/O operations per second) の値です。

    この設定を変更しても機能停止は発生しません。また、このリクエストで ApplyImmediately パラメータが true に設定されていない限り、変更は次のメンテナンスウィンドウ中に適用されます。

    デフォルト: 既存の設定を仕様

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。拡張モニタリングメトリクスの収集を無効にするには、0 を指定します。デフォルトは 0 です。

    MonitoringRoleArn を指定した場合は、MonitoringInterval を 0 以外の値に設定する必要があります。

    有効な値: 0, 1, 5, 10, 15, 30, 60

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。例えば、arn:aws:iam:123456789012:role/emaccess です。

    MonitoringInterval を 0 以外に設定した場合は、MonitoringRoleArn 値を設定する必要があります。

  • MultiAZ (CLI では: --multi-az) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。このパラメータを変更しても機能停止は発生しません。また、このリクエストで ApplyImmediately パラメータが true に設定されていない限り、変更は次のメンテナンスウィンドウ中に適用されます。

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

    DB インスタンスの名前を変更する場合の DB インスタンスの新規 DB インスタンス識別子 DB インスタンス識別子を変更すると、Apply Immediately を true に設定した場合はインスタンスが即時に再起動し、Apply Immediately を false にした場合は次のメンテナンス時に再起動します。この値は小文字で保存されます。

    制約:

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

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

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

    例: mydbinstance

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

    自動バックアップが有効になっている場合に自動バックアップが作成される毎日の時間帯。

    該当しません。自動バックアップを作成するための毎日の時間範囲は、DB クラスターによって管理されます。詳細については、「ModifyDBCluster (アクション)」を参照してください。

    制約:

    • hh24:mi-hh24:mi の形式である必要があります。

    • 時間は協定世界時 (UTC) である必要があります。

    • 必要なメンテナンス期間と競合してはいけません。

    • 少なくとも 30 分以上必要です。

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

    システムメンテナンスが発生する可能性がある週単位の時間範囲 (UTC) で、停止する可能性があります。次の場合を除き、このパラメータを変更しても機能停止にはならず、変更はできるだけ早く非同期的に適用されます。再起動を引き起こす保留中のアクションがあり、メンテナンスウィンドウが現在の時刻を含むように変更されている場合、このパラメータを変更すると DB インスタンスが再起動されます。このウィンドウを現在の時刻に変更した場合、保留中の変更が確実に適用されるように、現在の時刻からウィンドウの終わりまで 30 分以上必要です。

    デフォルト: 既存の設定を仕様

    形式: ddd:hh 24:mi-ddd:hh 24:mi

    有効な日数: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    制約: 30 分以上にする必要があります

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

    デフォルト: 1

    有効な値: 0 ～ 15

  • PubliclyAccessible (CLI では: --publicly-accessible) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    このフラグは、今後は使用しないでください。

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

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

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

    TDE 暗号化のためにインスタンスに関連付けるキーストアからの ARN。

  • TdeCredentialPassword (CLI の場合は --tde-credential-password) — string 型の SensitiveString (UTF-8 でエンコードされた文字列)。

    デバイスにアクセスするためのキーストアからの指定された ARN のパスワード。

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

    この DB インスタンスで承認する EC2 VPC セキュリティグループの一覧。この変更は、可能な限り早く非同期的に適用されます。

    該当しません。EC2 VPC セキュリティグループの関連リストは、DB クラスターによって管理されます。詳細については、「ModifyDBCluster (アクション)」を参照してください。

    制約:

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

レスポンス

Amazon Neptune DB インスタンスの詳細が含まれています。

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

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

    マイナーバージョンのパッチを自動的に適用することを指定します。

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

    DB インスタンスを配置するアベイラビリティーゾーンの名前を指定します。

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

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

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

    この DB インスタンスの CA 証明書の識別子。

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

    タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを指定します。

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

    DB インスタンスが DB クラスターのメンバーである場合は、DB インスタンスがメンバーとなっている DB クラスターの名前が含まれます。

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

    DB インスタンスの Amazon リソースネーム (ARN)。

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

    DB インスタンスのコンピューティング名とメモリ容量クラスの名前が含まれています。

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

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

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

    DB インスタンスがリッスンするポートを指定します。DB インスタンスが DB クラスターの一部である場合は、DB クラスターのポートとは別のポートを指定できます。

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

    このデータベースの現在の状態を指定します。

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

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

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

    データベース名。

  • DBParameterGroups – DBParameterGroupStatus オブジェクトの配列。

    この DB インスタンスに適用される DB パラメータグループのリストを入力します。

  • DBSecurityGroups – DBSecurityGroupMembership オブジェクトの配列。

    DBSecurityGroup.Name と DBSecurityGroup.Status のサブ要素のみを含む DB セキュリティグループ要素の一覧を入力します。

  • DBSubnetGroup – DBSubnetGroup オブジェクト。

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

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

    DB インスタンスで削除保護が有効になっているかどうかを示します。削除保護が有効な場合、インスタンスは削除できません。「DB インスタンスを削除する」を参照してください。

  • DomainMemberships – DomainMembership オブジェクトの配列。

    サポートされません

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

    この DB インスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。

  • Endpoint – エンドポイント オブジェクト。

    接続エンドポイントを指定します。

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

    この DB インスタンスに使用されるデータベースエンジンの名前を提供します。

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

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

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

    DB インスタンスの拡張モニタリングメトリクスデータを受け取る Amazon CloudWatch Logs ログストリームの Amazon リソースネーム (ARN)。

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

    Amazon Identity and Access Management (IAM) 認証が有効な場合は true、それ以外の場合は false です。

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

    DB インスタンスが作成された日時を入力します。

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

    プロビジョンド IOPS(I/O operations per second) を指定します。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    この DB インスタンスのライセンスモデル情報。

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。

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

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。

  • PendingModifiedValues – PendingModifiedValues オブジェクト。

    DB インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。

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

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

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

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

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

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

    このフラグは、今後は使用しないでください。

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

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

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

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

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

    この DB インスタンスがリードレプリカの場合は、ソース DB インスタンスの識別子が含まれます。

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

    存在する場合は、マルチ AZ をサポートする DB インスタンスのセカンダリアベイラビリティーゾーンの名前を指定します。

  • StatusInfos – DBInstanceStatusInfo オブジェクトの配列。

    リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    インスタンスが TDE 暗号化のために関連付けられているキーストアからの ARN。

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

    サポート外。

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

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

エラー

RebootDBInstance (アクション)

        この API の AWS CLI 名は reboot-db-instance です。

通常はメンテナンスのために、DB インスタンスを再起動する必要がある場合があります。たとえば、特定の変更を行う場合や、DB インスタンスに関連付けられた DB パラメータグループを変更する場合は、変更を有効にするためにインスタンスを再起動する必要があります。

DB インスタンスを再起動すると、データベースエンジンサービスが再起動されます。DB インスタンスを再起動すると一時的に機能停止になります。その間、DB インスタンスのステータスは [rebooting] に設定されます。

リクエスト

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

    DB インスタンス識別子。このパラメータは小文字で保存されます。

    制約:

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

  • ForceFailover (CLI では: --force-failover) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    true の場合、再起動はマルチ AZ フェイルオーバーによって行われます。

    制約: インスタンスがマルチ AZ 用に設定されていない場合、true を指定することはできません。

レスポンス

Amazon Neptune DB インスタンスの詳細が含まれています。

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

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

    マイナーバージョンのパッチを自動的に適用することを指定します。

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

    DB インスタンスを配置するアベイラビリティーゾーンの名前を指定します。

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

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

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

    この DB インスタンスの CA 証明書の識別子。

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

    タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを指定します。

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

    DB インスタンスが DB クラスターのメンバーである場合は、DB インスタンスがメンバーとなっている DB クラスターの名前が含まれます。

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

    DB インスタンスの Amazon リソースネーム (ARN)。

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

    DB インスタンスのコンピューティング名とメモリ容量クラスの名前が含まれています。

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

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

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

    DB インスタンスがリッスンするポートを指定します。DB インスタンスが DB クラスターの一部である場合は、DB クラスターのポートとは別のポートを指定できます。

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

    このデータベースの現在の状態を指定します。

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

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

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

    データベース名。

  • DBParameterGroups – DBParameterGroupStatus オブジェクトの配列。

    この DB インスタンスに適用される DB パラメータグループのリストを入力します。

  • DBSecurityGroups – DBSecurityGroupMembership オブジェクトの配列。

    DBSecurityGroup.Name と DBSecurityGroup.Status のサブ要素のみを含む DB セキュリティグループ要素の一覧を入力します。

  • DBSubnetGroup – DBSubnetGroup オブジェクト。

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

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

    DB インスタンスで削除保護が有効になっているかどうかを示します。削除保護が有効な場合、インスタンスは削除できません。「DB インスタンスを削除する」を参照してください。

  • DomainMemberships – DomainMembership オブジェクトの配列。

    サポートされません

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

    この DB インスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。

  • Endpoint – エンドポイント オブジェクト。

    接続エンドポイントを指定します。

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

    この DB インスタンスに使用されるデータベースエンジンの名前を提供します。

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

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

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

    DB インスタンスの拡張モニタリングメトリクスデータを受け取る Amazon CloudWatch Logs ログストリームの Amazon リソースネーム (ARN)。

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

    Amazon Identity and Access Management (IAM) 認証が有効な場合は true、それ以外の場合は false です。

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

    DB インスタンスが作成された日時を入力します。

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

    プロビジョンド IOPS(I/O operations per second) を指定します。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    この DB インスタンスのライセンスモデル情報。

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

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。

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

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。

  • PendingModifiedValues – PendingModifiedValues オブジェクト。

    DB インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。

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

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

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

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

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

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

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

    このフラグは、今後は使用しないでください。

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

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

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

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

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

    この DB インスタンスがリードレプリカの場合は、ソース DB インスタンスの識別子が含まれます。

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

    存在する場合は、マルチ AZ をサポートする DB インスタンスのセカンダリアベイラビリティーゾーンの名前を指定します。

  • StatusInfos – DBInstanceStatusInfo オブジェクトの配列。

    リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    インスタンスが TDE 暗号化のために関連付けられているキーストアからの ARN。

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

    サポート外。

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

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

エラー

DescribeDBInstances (アクション)

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

プロビジョニングされたインスタンスに関する情報を返し、ページ分割をサポートします。

注記

このオペレーションでは、Amazon RDS インスタンスと Amazon DocDB インスタンスの情報も返すことができます。

リクエスト

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

    ユーザーが指定したインスタンス識別子。このパラメータを指定した場合は、特定の DB インスタンスからの情報だけが返されます。このパラメータでは大文字と小文字は区別されません。

    制約:

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

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

    記述する 1 つ以上の DB インスタンスを指定するフィルター。

    サポートされているフィルター:

    • db-cluster-id - DB クラスター識別子と DB クラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN によって識別された DB クラスターに関連付けられた DB インスタンスに関する情報のみが含まれます。

    • engine - エンジン名 (neptune など) を受け入れ、そのエンジンによって作成された DB インスタンスに結果リストを制限します。

    たとえば、Amazon CLI からこの API を呼び出し、Neptune DB インスタンスのみが返されるようにフィルタリングするには、次のコマンドを使用します。

    aws neptune describe-db-instances \
            --filters  Name=engine,Values=neptune

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

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

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

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

    デフォルト: 100

    制約: 最小 20、最大 100。

レスポンス

  • DBInstances – DBInstance オブジェクトの配列。

    DBInstance (構造) インスタンスのリスト。

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

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

エラー

DescribeOrderableDBInstanceOptions (アクション)

        この API の AWS CLI 名は describe-orderable-db-instance-options です。

指定されたエンジンの注文可能な DB インスタンスオプションのリストを返します。

リクエスト

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

    DB インスタンスクラスのフィルター値。指定した DB インスタンスのクラスと一致する使用可能なオファリングのみを表示するには、このパラメータを指定してください。

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

    DB インスタンスオプションを取得するエンジンの名前。

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

    エンジンバージョンフィルターの値。指定したエンジンのバージョンと一致する使用可能なオファリングのみを表示するには、このパラメータを指定してください。

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

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

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

    ライセンスモデルフィルター値。指定したライセンスモデルと一致する使用可能なオファリングのみを表示するには、このパラメータを指定してください。

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

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

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

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

    デフォルト: 100

    制約: 最小 20、最大 100。

  • Vpc (CLI では: --vpc) — タイプ boolean の BooleanOptional (ブール値 (真または偽))。

    VPC フィルター値。このパラメータを指定すると、 VPC 環境または非 VPC 環境のみが表示されます。

レスポンス

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

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

  • OrderableDBInstanceOptions – OrderableDBInstanceOption オブジェクトの配列。

    DB インスタンスの順序付可能なオプションに関する情報が含まれている OrderableDBInstanceOption (構造) 構造。

DescribeValidDBInstanceModifications (アクション)

        この API の AWS CLI 名は describe-valid-db-instance-modifications です。

DB インスタンスにどのような変更を加えることができるかについて知るには、DescribeValidDBInstanceModifications (アクション) を呼び出します。ModifyDBInstance (アクション) を呼び出すときにこの情報を使用できます。

リクエスト

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

    DB インスタンスのお客様の識別子または ARN。

レスポンス

DB インスタンスに加えることができる有効な変更に関する情報。DescribeValidDBInstanceModifications (アクション) アクションへの呼び出しが成功した結果が含まれています。ModifyDBInstance (アクション) を呼び出すときにこの情報を使用できます。

  • Storage – ValidStorageOptions オブジェクトの配列。

    DB インスタンスの有効なストレージオプション。

エラー

構造:

DBInstance (構造)

Amazon Neptune DB インスタンスの詳細が含まれています。

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

フィールド

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

    マイナーバージョンのパッチを自動的に適用することを指定します。

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

    DB インスタンスを配置するアベイラビリティーゾーンの名前を指定します。

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

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

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

    この DB インスタンスの CA 証明書の識別子。

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

    タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを指定します。

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

    DB インスタンスが DB クラスターのメンバーである場合は、DB インスタンスがメンバーとなっている DB クラスターの名前が含まれます。

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

    DB インスタンスの Amazon リソースネーム (ARN)。

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

    DB インスタンスのコンピューティング名とメモリ容量クラスの名前が含まれています。

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

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

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

    DB インスタンスがリッスンするポートを指定します。DB インスタンスが DB クラスターの一部である場合は、DB クラスターのポートとは別のポートを指定できます。

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

    このデータベースの現在の状態を指定します。

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

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

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

    データベース名。

  • DBParameterGroups — これは DBParameterGroupStatus オブジェクトの配列です。

    この DB インスタンスに適用される DB パラメータグループのリストを入力します。

  • DBSecurityGroups — これは DBSecurityGroupMembership オブジェクトの配列です。

    DBSecurityGroup.Name と DBSecurityGroup.Status のサブ要素のみを含む DB セキュリティグループ要素の一覧を入力します。

  • DBSubnetGroup - これは DBSubnetGroup オブジェクトです。

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

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

    DB インスタンスで削除保護が有効になっているかどうかを示します。削除保護が有効な場合、インスタンスは削除できません。「DB インスタンスを削除する」を参照してください。

  • DomainMemberships — これは DomainMembership オブジェクトの配列です。

    サポートされません

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

    この DB インスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。

  • Endpoint - これは エンドポイント オブジェクトです。

    接続エンドポイントを指定します。

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

    この DB インスタンスに使用されるデータベースエンジンの名前を提供します。

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

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

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

    DB インスタンスの拡張モニタリングメトリクスデータを受け取る Amazon CloudWatch Logs ログストリームの Amazon リソースネーム (ARN)。

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

    Amazon Identity and Access Management (IAM) 認証が有効な場合は true、それ以外の場合は false です。

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

    DB インスタンスが作成された日時を入力します。

  • Iops — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    プロビジョンド IOPS(I/O operations per second) を指定します。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    この DB インスタンスのライセンスモデル情報。

  • MonitoringInterval — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスについて拡張モニターメトリクスが収集される時点間の間隔 (秒単位)。

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

    Neptune が拡張モニタリングメトリクスを Amazon CloudWatch Logs に送信することを許可する IAM ロールの ARN。

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

    DB インスタンスが Multi-AZ デプロイかどうかを指定します。

  • PendingModifiedValues - これは PendingModifiedValues オブジェクトです。

    DB インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。

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

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

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

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

  • PromotionTier — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    既存のプライマリインスタンスの障害後に、リードレプリカをプライマリインスタンスに昇格される順序を指定する値。

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

    このフラグは、今後は使用しないでください。

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

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

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

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

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

    この DB インスタンスがリードレプリカの場合は、ソース DB インスタンスの識別子が含まれます。

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

    存在する場合は、マルチ AZ をサポートする DB インスタンスのセカンダリアベイラビリティーゾーンの名前を指定します。

  • StatusInfos — これは DBInstanceStatusInfo オブジェクトの配列です。

    リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。

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

    サポートなし: DB インスタンスの暗号化は、DB クラスターによって管理されます。

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

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

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

    インスタンスが TDE 暗号化のために関連付けられているキーストアからの ARN。

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

    サポート外。

  • VpcSecurityGroups — これは VpcSecurityGroupMembership オブジェクトの配列です。

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

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

DBInstanceStatusInfo (構造)

DB インスタンスのステータス情報のリストを入力します。

フィールド

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

    インスタンスにエラーがある場合のエラーの詳細。インスタンスがエラー状態にない場合、この値は空白です。

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

    インスタンスが正常に動作している場合はブール値が true、インスタンスがエラー状態の場合は false です。

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

    DB インスタンスのステータス。リードレプリカの StatusType の場合、値はレプリケーション中、エラー、停止、または終了です。

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

    この値は現在「リードレプリケーション」です。

OrderableDBInstanceOption (構造)

DB インスタンスで使用可能なオプションのリストが含まれています。

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

フィールド

  • AvailabilityZones — これは AvailabilityZone オブジェクトの配列です。

    DB インスタンスのアベイラビリティーゾーンのリスト。

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

    DB インスタンスの DB インスタンスクラス。

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

    DB インスタンスのエンジンタイプ。

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

    DB インスタンスのエンジンバージョン。

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

    DB インスタンスのライセンスモデル。

  • MaxIopsPerDbInstance — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスのプロビジョンド IOPS の合計最大数。

  • MaxIopsPerGib— DoubleOptional、タイプ: double (倍精度 IEEE 754 浮動小数点数)。

    DB インスタンスの 1 GiB あたりのプロビジョンド IOPS の最大数。

  • MaxStorageSize — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスの最大ストレージサイズ。

  • MinIopsPerDbInstance — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスのプロビジョンド IOPS の合計最小数。

  • MinIopsPerGib— DoubleOptional、タイプ: double (倍精度 IEEE 754 浮動小数点数)。

    DB インスタンスの 1 GiB あたりのプロビジョンド IOPS の最小数。

  • MinStorageSize — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスの最小ストレージサイズ。

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

    DB インスタンスがマルチ AZ に対応しているかどうかを示します。

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

    DB インスタンスがリードレプリカを持つことができるかどうかを示します。

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

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

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

    DB インスタンスが 1 〜 60 秒の間隔で拡張モニタリングをサポートするかどうかを示します。

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

    Neptune グローバルデータベースを他の DB エンジン属性の特定の組み合わせで使用できるかどうかを示す値。

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

    DB インスタンスが IAM データベース認証をサポートするかどうかを示します。

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

    DB インスタンスがプロビジョンド IOPS をサポートするかどうかを示します。

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

    DB インスタンスが暗号化ストレージをサポートするかどうかを示します。

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

    DB インスタンスが VPC 内にあるかどうかを示します。

PendingModifiedValues (構造)

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

フィールド

  • AllocatedStorage — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    適用される、または現在適用されている DB インスタンスの新しい AllocatedStorage サイズが含まれています。

  • BackupRetentionPeriod — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    自動バックアップを保持する保留日数を指定します。

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

    DB インスタンスの CA 証明書の識別子を指定します。

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

    適用される、または現在適用されている DB インスタンスの新しい DBInstanceClass が含まれています。

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

    適用される、または現在適用されている DB インスタンスの新しい DBInstanceIdentifier が含まれています。

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

    DB インスタンスの新しい DB サブネットグループ。

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

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

  • Iops — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    適用される、または現在適用されている DB インスタンスの新しいプロビジョンド IOPS 値を指定します。

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

    Single-AZ DB インスタンスをマルチ AZ 配置に変更することを示します。

  • PendingCloudwatchLogsExports - これは PendingCloudwatchLogsExports オブジェクトです。

    この PendingCloudwatchLogsExports 構造は、CloudWatch ログを有効および無効にする保留中の変更を指定します。

  • Port — これはタイプ integer の IntegerOptional です (符号付き 32 ビット整数)。

    DB インスタンスの保留ポートを指定します。

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

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

ValidStorageOptions (構造)

該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

フィールド

  • IopsToStorageRatio — これは DoubleRange オブジェクトの配列です。

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

  • ProvisionedIops — これは [Range] (範囲) オブジェクトの配列です。

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

  • StorageSize — これは [Range] (範囲) オブジェクトの配列です。

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

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

    該当しません。Neptune の場合、ストレージタイプは DB クラスターレベルで管理されます。

ValidDBInstanceModificationsMessage (構造)

DB インスタンスに加えることができる有効な変更に関する情報。DescribeValidDBInstanceModifications (アクション) アクションへの呼び出しが成功した結果が含まれています。ModifyDBInstance (アクション) を呼び出すときにこの情報を使用できます。

フィールド

  • Storage — これは ValidStorageOptions オブジェクトの配列です。

    DB インスタンスの有効なストレージオプション。

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