DBInstance
インスタンスに関する詳細情報。
内容
注記
次のリストで必須のパラメーターを説明します。
- AutoMinorVersionUpgrade
-
適用されません。このパラメータは Amazon DocumentDB には適用されません。Amazon DocumentDB は、設定値に関係なく、マイナーバージョンのアップグレードを実行しません。
型: ブール値
必須：いいえ
- AvailabilityZone
-
インスタンスを配置するアベイラビリティーゾーンの名前を指定します。
型: 文字列
必須: いいえ
- BackupRetentionPeriod
-
自動スナップショットが保持される日数を指定します。
型: 整数
必須：いいえ
- CACertificateIdentifier
-
この DB インスタンスの CA 証明書の識別子。
型: 文字列
必須: いいえ
- CertificateDetails
-
DB インスタンスのサーバー証明書の詳細。
型: CertificateDetails オブジェクト
必須：いいえ
- CopyTagsToSnapshot
-
タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを示す値。デフォルトでは、タグはコピーされません。
型: ブール値
必須：いいえ
- DBClusterIdentifier
-
インスタンスがクラスターのメンバーである場合は、インスタンスがメンバーとなっているクラスターの名前が含まれます。
型: 文字列
必須: いいえ
- DBInstanceArn
-
インスタンスの Amazon リソースネーム (ARN)。
型: 文字列
必須: いいえ
- DBInstanceClass
-
インスタンスのコンピューティングおよびメモリ容量クラスの名前を指定します。
型: 文字列
必須: いいえ
- DBInstanceIdentifier
-
ユーザーが指定したデータベース識別子が含まれています。この識別子は、インスタンスを識別する一意のキーです。
型: 文字列
必須: いいえ
- DBInstanceStatus
-
このデータベースの現在の状態を指定します。
型: 文字列
必須: いいえ
- DbiResourceId
-
インスタンスの AWS リージョン 固有のイミュータブルな識別子。この識別子は、インスタンスの AWS CloudTrail キーにアクセスするたびに AWS KMS ログエントリに記録されます。
型: 文字列
必須: いいえ
- DBSubnetGroup
-
サブネットグループ内の名前、説明、サブネットなど、インスタンスに関連付けられているサブネットグループに関する情報を指定します。
型: DBSubnetGroup オブジェクト
必須：いいえ
- EnabledCloudwatchLogsExports.member.N
-
このインスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。
型: 文字列の配列
必須：いいえ
- Endpoint
-
接続エンドポイントを指定します。
型: Endpoint オブジェクト
必須：いいえ
- Engine
-
このインスタンスに使用されるデータベースエンジンの名前を入力します。
型: 文字列
必須: いいえ
- EngineVersion
-
データベースエンジンのバージョンを示します。
型: 文字列
必須: いいえ
- InstanceCreateTime
-
インスタンスが作成された日時を入力します。
型: タイムスタンプ
必須：いいえ
- KmsKeyId
-
StorageEncryptedがtrueの場合、暗号化されたインスタンスの AWS KMS キー識別子。型: 文字列
必須: いいえ
- LatestRestorableTime
-
特定時点への復元によりデータベースを復元できる最新の日時を指定します。
型: タイムスタンプ
必須：いいえ
- PendingModifiedValues
-
インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。
型: PendingModifiedValues オブジェクト
必須：いいえ
- PerformanceInsightsEnabled
-
Amazon RDS Performance Insights をその DB インスタンスで有効化する場合は
true、それ以外の場合はfalseに設定します。型: ブール値
必須：いいえ
- PerformanceInsightsKMSKeyId
-
パフォーマンスインサイトデータの暗号化の AWS KMS キー識別子。AWS KMS キー ID は、AWS KMS 暗号化キーの Amazon リソースネーム (ARN)、AWS KMS キー識別子、または AWS KMS 暗号化キーのキーエイリアスです。
型: 文字列
必須: いいえ
- PreferredBackupWindow
-
BackupRetentionPeriodに応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。型: 文字列
必須: いいえ
- PreferredMaintenanceWindow
-
週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。
型: 文字列
必須: いいえ
- PromotionTier
-
既存のプライマリインスタンスの障害後に、Amazon DocumentDB レプリカをプライマリインスタンスに昇格される順序を指定する値。
型: 整数
必須：いいえ
- PubliclyAccessible
-
サポート外。Amazon DocumentDB は現在パブリックエンドポイントをサポートしていません。
PubliclyAccessibleの値は常にfalseです。型: ブール値
必須：いいえ
- StatusInfos.DBInstanceStatusInfo.N
-
リードレプリカのステータス。インスタンスがリードレプリカではない場合、これは空白です。
型: DBInstanceStatusInfo オブジェクトの配列
必須：いいえ
- StorageEncrypted
-
インスタンスが暗号化されているかどうかを指定します。
型: ブール値
必須：いいえ
- VpcSecurityGroups.VpcSecurityGroupMembership.N
-
インスタンスが属する VPC セキュリティグループ要素のリストを入力します。
型: VpcSecurityGroupMembership オブジェクトの配列
必須：いいえ
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
