翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DBCluster
クラスターに関する詳細情報。
内容
注記
次のリストで必須のパラメーターを説明します。
- AssociatedRoles.DBClusterRole.N
-
クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールのリストを指定します。クラスターに関連付けられている (IAM) ロールは、ユーザーに代わって他の AWS サービスにアクセスするためのアクセス許可をクラスターに付与します。
型: DBClusterRole オブジェクトの配列
必須：いいえ
- AvailabilityZones.AvailabilityZone.N
-
クラスターのインスタンスを作成できる Amazon EC2 アベイラビリティーゾーン (AZ) のリストを入力します。
型: 文字列の配列
必須：いいえ
- BackupRetentionPeriod
-
自動スナップショットが保持される日数を指定します。
型: 整数
必須：いいえ
- CloneGroupId
-
DB クラスターが関連付けられているクローングループを識別します。
型: 文字列
必須: いいえ
- ClusterCreateTime
-
クラスターが作成された時刻を協定世界時 (UTC) で指定します。
型: タイムスタンプ
必須：いいえ
- DBClusterArn
-
クラスターの Amazon リソースネーム (ARN) を返します。
型: 文字列
必須: いいえ
- DBClusterIdentifier
-
ユーザーが指定したクラスター識別子が含まれています。この識別子は、クラスターを識別する一意のキーです。
型: 文字列
必須: いいえ
- DBClusterMembers.DBClusterMember.N
-
クラスターを構成するインスタンスのリストを入力します。
型: DBClusterMember オブジェクトの配列
必須：いいえ
- DBClusterParameterGroup
-
クラスターに使用するクラスターパラメータグループの名前を指定します。
型: 文字列
必須: いいえ
- DbClusterResourceId
-
クラスターの AWS リージョン 固有のイミュータブルな識別子。この識別子は、クラスターの AWS CloudTrail キーにアクセスするたびに AWS KMS ログエントリに記録されます。
型: 文字列
必須: いいえ
- DBSubnetGroup
-
サブネットグループ内の名前、説明、サブネットなど、クラスターに関連付けられているサブネットグループに関する情報を指定します。
型: 文字列
必須: いいえ
- DeletionProtection
-
このクラスターを削除できるかどうかを指定します。
DeletionProtectionを有効にすると、クラスターが変更されDeletionProtectionが無効にならない限り、クラスターを削除することができません。DeletionProtectionはクラスターが誤って削除されるのを防ぎます。型: ブール値
必須：いいえ
- EarliestRestorableTime
-
特定時点への復元によりデータベースを復元できる最も早い時刻。
型: タイムスタンプ
必須：いいえ
- EnabledCloudwatchLogsExports.member.N
-
このクラスターが Amazon CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。
型: 文字列の配列
必須：いいえ
- Endpoint
-
クラスターのプライマリインスタンスの接続エンドポイントを指定します。
型: 文字列
必須: いいえ
- Engine
-
このクラスターに使用されるデータベースエンジンの名前を入力します。
型: 文字列
必須: いいえ
- EngineVersion
-
データベースエンジンのバージョンを示します。
型: 文字列
必須: いいえ
- HostedZoneId
-
ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。
型: 文字列
必須: いいえ
- KmsKeyId
-
StorageEncryptedがtrueの場合、暗号化されたクラスターの AWS KMS キー識別子。型: 文字列
必須: いいえ
- LatestRestorableTime
-
特定時点への復元によりデータベースを復元できる最新の日時を指定します。
型: タイムスタンプ
必須：いいえ
- MasterUsername
-
クラスターのマスターユーザー名が含まれています。
型: 文字列
必須: いいえ
- MultiAZ
-
クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。
型: ブール値
必須：いいえ
- PercentProgress
-
オペレーションの進行状況をパーセンテージで指定します。
型: 文字列
必須: いいえ
- Port
-
データベースエンジンがリッスンするポートを指定します。
型: 整数
必須：いいえ
- PreferredBackupWindow
-
BackupRetentionPeriodに応じた、自動バックアップが有効な場合に自動バックアップが作成される毎日の時間範囲を指定します。型: 文字列
必須: いいえ
- PreferredMaintenanceWindow
-
週 1 回のシステムメンテナンスを実行できる時間範囲を世界標準時 (UTC) で指定します。
型: 文字列
必須: いいえ
- ReaderEndpoint
-
クラスターの読み込みエンドポイント。クラスター用のリーダーエンドポイントは、クラスタ内の使用可能な Amazon DocumentDB レプリカ間で接続の負荷分散を行います。クライアントがリーダーエンドポイントへの新規接続をリクエストすると、Amazon DocumentDB によって接続リクエストがクラスターの Amazon DocumentDB レプリカ間で配分されます。この機能は、クラスターの複数の Amazon DocumentDB レプリカ間の読み取りワークロードを分散させる役に立ちます。
フェイルオーバーが発生し、接続している Amazon DocumentDB レプリカがプライマリインスタンスに昇格すると、接続は削除されます。読み取りワークロードをクラスター内の他の Amazon DocumentDB レプリカに送信し続けるために、リーダーエンドポイントに再接続することができます。
型: 文字列
必須: いいえ
- ReadReplicaIdentifiers.ReadReplicaIdentifier.N
-
このクラスターに関連付けられているセカンダリクラスターの 1 つ以上の識別子を含みます。
型: 文字列の配列
必須：いいえ
- ReplicationSourceIdentifier
-
このクラスターがセカンダリークラスターの場合は、ソースクラスターの識別子が含まれます。
型: 文字列
必須: いいえ
- Status
-
このクラスターの現在の状態を指定します。
型: 文字列
必須: いいえ
- StorageEncrypted
-
クラスターが暗号化されているかどうかを指定します。
型: ブール値
必須：いいえ
- StorageType
-
クラスターに関連付けられたストレージタイプ
クラスターに関連付けられたストレージタイプ
Amazon DocumentDB クラスターのストレージタイプの詳細については、「Amazon DocumentDB 開発者ガイド」の「クラスターストレージ設定」を参照してください。
ストレージタイプの有効な値 -
standard | iopt1デフォルト値は
standardです型: 文字列
必須: いいえ
- VpcSecurityGroups.VpcSecurityGroupMembership.N
-
クラスターに関連付けられる VPC (Virtual Private Cloud) セキュリティグループのリスト。
型: VpcSecurityGroupMembership オブジェクトの配列
必須：いいえ
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
