翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # データ型 次のデータ型は でサポートされています Amazon DocumentDB (with MongoDB compatibility)。 + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) Amazon DocumentDB Elastic クラスターでは、以下のデータ型がサポートされています。 + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Amazon DocumentDB (with MongoDB compatibility) 次のデータ型は でサポートされています Amazon DocumentDB (with MongoDB compatibility)。 + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) # AvailabilityZone アベイラビリティーゾーンに関する情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Name ** アベイラビリティーゾーンの名前。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) # Certificate AWS アカウント の認証機関 (CA) 証明書の取得。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** CertificateArn ** 証明書の Amazon リソースネーム (ARN)。 例:`arn:aws:rds:us-east-1::cert:rds-ca-2019` タイプ: 文字列 必須: いいえ ** CertificateIdentifier ** 証明書を識別する一意のキー。 例:`rds-ca-2019` タイプ: 文字列 必須: いいえ ** CertificateType ** 証明書の種類を入力します。 例:`CA` タイプ: 文字列 必須: いいえ ** Thumbprint ** 証明書のサムプリント。 タイプ: 文字列 必須: いいえ ** ValidFrom ** 証明書が有効である開始日時。 例:`2019-07-31T17:57:09Z` 型: タイムスタンプ 必須: いいえ ** ValidTill ** 証明書が有効でなくなる日時。 例:`2024-07-31T17:57:09Z` 型: タイムスタンプ 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) # CertificateDetails DB インスタンスのサーバー証明書の詳細を返します。 詳細については、「Amazon DocumentDB デベロッパーガイド」の「[Amazon DocumentDB TLS 証明書の更新](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)」と「[転送中のデータの暗号化](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)」を参照してください。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** CAIdentifier ** DB インスタンスのサーバー証明書に使用される CA 証明書の CA 識別子。 タイプ: 文字列 必須: いいえ ** ValidTill ** DB インスタンスのサーバー証明書の有効期限。 型: タイムスタンプ 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) # CloudwatchLogsExportConfiguration 特定のインスタンスまたはクラスターについて、Amazon CloudWatch Logs へのエクスポートを有効にするためのログタイプの設定。 `EnableLogTypes` および `DisableLogTypes` の配列では、CloudWatch Logs にエクスポートする (または、エクスポートしない) ログを決定します。これらの配列内の値は、使用されているエンジンによって異なります。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DisableLogTypes.member.N ** 無効にするログタイプのリスト。 型: 文字列の配列 必須: いいえ ** EnableLogTypes.member.N ** 有効にするログタイプのリスト。 型: 文字列の配列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) # ClusterMasterUserSecret マスターユーザーパスワードの AWS Secrets Manager で Amazon DocumentDB が管理するシークレットが含まれます。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** KmsKeyId ** シークレットの暗号化に使用される AWS KMS キーの識別子。 タイプ: 文字列 必須: いいえ ** SecretArn ** シークレットの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** SecretStatus ** シークレットのステータス。 設定可能なステータス値は以下のとおりです。 + 作成中 – シークレットは作成中です。 + アクティブ – シークレットは通常の使用とローテーションで利用可能です。 + ローテーション中 – シークレットはローテーション中です。 + 問題発生中 - シークレットはデータベースの認証情報へのアクセスに使用できますが、ローテーションはできません。例えば、アクセス許可が変更されて Amazon DocumentDB がシークレットやシークレットの KMS キーにアクセスできなくなった場合、いずれかのシークレットがこのステータスになる可能性があります。 シークレットのステータスがこの場合は、ステータスの原因となった状態を修正できます。または、インスタンスを変更してデータベース認証情報の自動管理をオフにしてから、インスタンスを再度変更してデータベース認証情報の自動管理をオンにします。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) # DBCluster クラスターに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AssociatedRoles.DBClusterRole.N ** クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールのリストを指定します。クラスターに関連付けられている (IAM) ロールは、ユーザーに代わって他の AWS サービスにアクセスするためのアクセス許可をクラスターに付与します。 型: [DBClusterRole](API_DBClusterRole.md) オブジェクトの配列 必須: いいえ ** AvailabilityZones.AvailabilityZone.N ** クラスターのインスタンスを作成できる Amazon EC2 アベイラビリティーゾーン (AZ) のリストを入力します。 型: 文字列の配列 必須: いいえ ** BackupRetentionPeriod ** 自動スナップショットが保持される日数を指定します。 タイプ: 整数 必須: いいえ ** CloneGroupId ** DB クラスターが関連付けられているクローングループを識別します。 タイプ: 文字列 必須: いいえ ** ClusterCreateTime ** クラスターが作成された時刻を協定世界時 (UTC) で指定します。 型: タイムスタンプ 必須: いいえ ** DBClusterArn ** クラスターの Amazon リソースネーム (ARN) を返します。 タイプ: 文字列 必須: いいえ ** DBClusterIdentifier ** ユーザーが指定したクラスター識別子が含まれています。この識別子は、クラスターを識別する一意のキーです。 タイプ: 文字列 必須: いいえ ** DBClusterMembers.DBClusterMember.N ** クラスターを構成するインスタンスのリストを入力します。 型: [DBClusterMember](API_DBClusterMember.md) オブジェクトの配列 必須: いいえ ** 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 を指定します。 タイプ: 文字列 必須: いいえ ** IOOptimizedNextAllowedModificationTime ** 次回は、iopt1 ストレージタイプを使用するように Amazon DocumentDB クラスターを変更できます。 型: タイムスタンプ 必須: いいえ ** KmsKeyId ** `StorageEncrypted` が `true` の場合、暗号化されたクラスターの AWS KMS キー識別子。 タイプ: 文字列 必須: いいえ ** LatestRestorableTime ** 特定時点への復元によりデータベースを復元できる最新の日時を指定します。 型: タイムスタンプ 必須: いいえ ** MasterUsername ** クラスターのマスターユーザー名が含まれています。 タイプ: 文字列 必須: いいえ ** MasterUserSecret ** マスターユーザーパスワードの AWS Secrets Manager で Amazon DocumentDB が管理するシークレット。 型: [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) オブジェクト 必須: いいえ ** MultiAZ ** クラスターが複数のアベイラビリティーゾーンにインスタンスを持つかどうかを指定します。 型: ブール値 必須: いいえ ** NetworkType ** クラスターのネットワークタイプです。 ネットワークタイプは、クラスターに指定された `DBSubnetGroup` によって決まります。`DBSubnetGroup` は IPv4 プロトコルのみ、または IPv4 プロトコルと IPv6 プロトコル (`DUAL`) をサポートできます。 詳細については、「Amazon DocumentDB デベロッパーガイド」の「[VPC の DocumentDB クラスター](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)」を参照してください。 有効な値: `IPV4` \$1 `DUAL` タイプ: 文字列 必須: いいえ ** 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 ** このクラスターがセカンダリークラスターの場合は、ソースクラスターの識別子が含まれます。 タイプ: 文字列 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成。 型: [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) オブジェクト 必須: いいえ ** Status ** このクラスターの現在の状態を指定します。 タイプ: 文字列 必須: いいえ ** StorageEncrypted ** クラスターが暗号化されているかどうかを指定します。 型: ブール値 必須: いいえ ** StorageType ** クラスターに関連付けられたストレージタイプ Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です タイプ: 文字列 必須: いいえ ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** クラスターに関連付けられる VPC (Virtual Private Cloud) セキュリティグループのリスト。 型: [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) オブジェクトの配列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) # DBClusterMember クラスターの一部であるインスタンスに関する情報が含まれています。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBClusterParameterGroupStatus ** クラスターのこのメンバーの DB クラスターパラメータグループのステータスを指定します。 タイプ: 文字列 必須: いいえ ** DBInstanceIdentifier ** クラスターのこのメンバーのインスタンス ID を指定します。 タイプ: 文字列 必須: いいえ ** IsClusterWriter ** クラスターメンバーがクラスターのプライマリインスタンスの場合は `true`、それ以外の場合は `false` です。 型: ブール値 必須: いいえ ** PromotionTier ** 既存のプライマリインスタンスの障害後に、Amazon DocumentDB レプリカをプライマリインスタンスに昇格される順序を指定する値。 タイプ: 整数 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) # DBClusterParameterGroup クラスターパラメータグループに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBClusterParameterGroupArn ** クラスターパラメータグループの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** DBClusterParameterGroupName ** クラスターパラメータグループの名前を指定します。 タイプ: 文字列 必須: いいえ ** DBParameterGroupFamily ** このクラスターパラメータグループと互換性があるクラスターパラメータグループファミリーの名前を指定します。 タイプ: 文字列 必須: いいえ ** Description ** このクラスターパラメータグループに対するユーザー定義の説明を指定します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) # DBClusterRole クラスターに関連付けられている AWS Identity and Access Management (IAM) ロールを記述します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** RoleArn ** DB クラスターに関連付けられる IAM ロール Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** Status ** IAM ロールとクラスターの間の関連付けの状態を説明します。`Status` プロパティは以下のいずれかの値を返します。 + `ACTIVE` - IAM ロール ARN は DB クラスターに関連付けられており、代わりに他の AWS のサービスにアクセスするために使用できます。 + `PENDING` - IAM ロール ARN はクラスターに関連付けられています。 + `INVALID` - IAM ロール ARN はクラスターに関連付けられていますが、DB クラスターはユーザーに代わって他の AWS のサービスにアクセスするために IAM ロールを引き受けることができません。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) # DBClusterSnapshot クラスタースナップショットに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AvailabilityZones.AvailabilityZone.N ** クラスタースナップショットのインスタンスを復元できる Amazon EC2 アベイラビリティーゾーン (AZ) のリストを入力します。 型: 文字列の配列 必須: いいえ ** ClusterCreateTime ** クラスターが作成された時刻を協定世界時 (UTC) で指定します。 型: タイムスタンプ 必須: いいえ ** DBClusterIdentifier ** このクラスタースナップショットの作成元のクラスターのクラスター識別子を指定します。 タイプ: 文字列 必須: いいえ ** DBClusterSnapshotArn ** クラスタースナップショットの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** DBClusterSnapshotIdentifier ** クラスタースナップショットの識別子を指定します。 タイプ: 文字列 必須: いいえ ** Engine ** データベースエンジンの名前を指定します。 タイプ: 文字列 必須: いいえ ** EngineVersion ** このクラスタースナップショットに使用されるデータベースエンジンのバージョンを入力します。 タイプ: 文字列 必須: いいえ ** KmsKeyId ** `StorageEncrypted` が `true` の場合、暗号化されたクラスタースナップショットの AWS KMS キー識別子。 タイプ: 文字列 必須: いいえ ** MasterUsername ** クラスタースナップショットのマスターユーザー名を入力します。 タイプ: 文字列 必須: いいえ ** PercentProgress ** 転送された推定データの割合を指定します。 タイプ: 整数 必須: いいえ ** Port ** スナップショット時にクラスターが待機していたポートを指定します。 タイプ: 整数 必須: いいえ ** SnapshotCreateTime ** スナップショットが取られた時刻を協定世界時 (UTC) で入力します。 型: タイムスタンプ 必須: いいえ ** SnapshotType ** クラスタースナップショットのタイプを入力します。 タイプ: 文字列 必須: いいえ ** SourceDBClusterSnapshotArn ** クラスタースナップショットがソースクラスタースナップショットからコピーされた場合は、ソースクラスタースナップショットの ARÑ、それ以外の場合は null 値。 タイプ: 文字列 必須: いいえ ** Status ** このクラスタースナップショットのステータスを指定します。 タイプ: 文字列 必須: いいえ ** StorageEncrypted ** クラスタースナップショットが暗号化されているかどうかを指定します。 型: ブール値 必須: いいえ ** StorageType ** クラスタースナップショットに関連付けられているストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です タイプ: 文字列 必須: いいえ ** VpcId ** クラスタースナップショットに関連付けられている仮想プライベートクラウド (VPC) ID を提供します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) # DBClusterSnapshotAttribute 手動クラスタースナップショット属性の名前と値を含みます。 手動 DB クラスタースナップショット属性は、他の AWS アカウント が手動 DB クラスタースナップショットを復元することを承認するために使用されます。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AttributeName ** 手動クラスタースナップショット属性の名前。 `restore` という名前の属性は、手動のクラスタースナップショットをコピーまたは復元するアクセス許可を持つ AWS アカウント のリストを参照します。 タイプ: 文字列 必須: いいえ ** AttributeValues.AttributeValue.N ** 手動クラスタースナップショット属性の値。 `AttributeName` フィールドが `restore` に設定されている場合、この要素は手動クラスタースナップショットのコピーまたは復元を許可されている AWS アカウント の ID のリストを返します。`all` の値がリストにある場合、手動クラスタースナップショットは公開されており、どの AWS アカウント でもコピーや復元ができます。 型: 文字列の配列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) # DBClusterSnapshotAttributesResult クラスタースナップショットに関連付けられている属性に関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N ** クラスタースナップショットの属性と値のリスト。 タイプ: [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) オブジェクトの配列 必須: いいえ ** DBClusterSnapshotIdentifier ** 属性が適用されるクラスタースナップショットの識別子。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) # DBEngineVersion エンジンのバージョンに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBEngineDescription ** データベースエンジンの説明。 タイプ: 文字列 必須: いいえ ** DBEngineVersionDescription ** データベースエンジンのバージョンの説明。 タイプ: 文字列 必須: いいえ ** DBParameterGroupFamily ** データベースエンジンのパラメータグループファミリーの名前。 タイプ: 文字列 必須: いいえ ** Engine ** データベースエンジンの名前。 タイプ: 文字列 必須: いいえ ** EngineVersion ** データベースエンジンのバージョン番号。 タイプ: 文字列 必須: いいえ ** ExportableLogTypes.member.N ** データベースエンジンが Amazon CloudWatch Logs にエクスポートできるログのタイプ。 型: 文字列の配列 必須: いいえ ** ServerlessV2FeaturesSupport ** Amazon DocumentDB エンジンのバージョンが異なる Amazon DocumentDB Serverless プロパティまたは制限を指定します。新しいクラスターまたはアップグレードされたクラスターで使用する Amazon DocumentDB バージョンを決定するときに、この属性の値をテストできます。既存のクラスターのバージョンを取得し、そのバージョンが特定の Amazon DocumentDB Serverless 機能をサポートしているかどうかを確認してから、それらの機能を使用することもできます。 型: [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) オブジェクト 必須: いいえ ** SupportedCACertificateIdentifiers.member.N ** サポートされている CA 証明書識別子のリスト。 詳細については、「Amazon DocumentDB デベロッパーガイド」の「[Amazon DocumentDB TLS証明書の更新](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)」と「[転送中のデータの暗号化](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)」を参照してください。 型: 文字列の配列 必須: いいえ ** SupportsCertificateRotationWithoutRestart ** エンジンが DB インスタンスを再起動せずにサーバー証明書をローテーションすることをサポートしているバージョンかどうかを示します。 型: ブール値 必須: いいえ ** SupportsLogExportsToCloudwatchLogs ** エンジンのバージョンが `ExportableLogTypes` で指定されたログタイプの CloudWatch Logs へのエクスポートをサポートするかどうかを示す値。 型: ブール値 必須: いいえ ** ValidUpgradeTarget.UpgradeTarget.N ** このデータベースエンジンのバージョンをアップグレードできるエンジンのバージョンのリスト。 型: [UpgradeTarget](API_UpgradeTarget.md) オブジェクトの配列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) # DBInstance インスタンスに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AutoMinorVersionUpgrade ** 適用されません。このパラメータは Amazon DocumentDB には適用されません。Amazon DocumentDB は、設定値に関係なく、マイナーバージョンのアップグレードを実行しません。 型: ブール値 必須: いいえ ** AvailabilityZone ** インスタンスを配置するアベイラビリティーゾーンの名前を指定します。 タイプ: 文字列 必須: いいえ ** BackupRetentionPeriod ** 自動スナップショットが保持される日数を指定します。 タイプ: 整数 必須: いいえ ** CACertificateIdentifier ** この DB インスタンスの CA 証明書の識別子。 タイプ: 文字列 必須: いいえ ** CertificateDetails ** DB インスタンスのサーバー証明書の詳細。 型: [CertificateDetails](API_CertificateDetails.md) オブジェクト 必須: いいえ ** CopyTagsToSnapshot ** タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを示す値。デフォルトでは、タグはコピーされません。 型: ブール値 必須: いいえ ** DBClusterIdentifier ** インスタンスがクラスターのメンバーである場合は、インスタンスがメンバーとなっているクラスターの名前が含まれます。 タイプ: 文字列 必須: いいえ ** DBInstanceArn ** インスタンスの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** DBInstanceClass ** インスタンスのコンピューティングおよびメモリ容量クラスの名前を指定します。 タイプ: 文字列 必須: いいえ ** DBInstanceIdentifier ** ユーザーが指定したデータベース識別子が含まれています。この識別子は、インスタンスを識別する一意のキーです。 タイプ: 文字列 必須: いいえ ** DBInstanceStatus ** このデータベースの現在の状態を指定します。 タイプ: 文字列 必須: いいえ ** DbiResourceId ** インスタンスの AWS リージョン 固有のイミュータブルな識別子。この識別子は、インスタンスの AWS CloudTrail キーにアクセスするたびに AWS KMS ログエントリに記録されます。 タイプ: 文字列 必須: いいえ ** DBSubnetGroup ** サブネットグループ内の名前、説明、サブネットなど、インスタンスに関連付けられているサブネットグループに関する情報を指定します。 型: [DBSubnetGroup](API_DBSubnetGroup.md) オブジェクト 必須: いいえ ** EnabledCloudwatchLogsExports.member.N ** このインスタンスが CloudWatch Logs にエクスポートするように設定されているログタイプのリスト。 型: 文字列の配列 必須: いいえ ** Endpoint ** 接続エンドポイントを指定します。 型: [Endpoint](API_Endpoint.md) オブジェクト 必須: いいえ ** Engine ** このインスタンスに使用されるデータベースエンジンの名前を入力します。 タイプ: 文字列 必須: いいえ ** EngineVersion ** データベースエンジンのバージョンを示します。 タイプ: 文字列 必須: いいえ ** InstanceCreateTime ** インスタンスが作成された日時を入力します。 型: タイムスタンプ 必須: いいえ ** KmsKeyId ** `StorageEncrypted` が `true` の場合、暗号化されたインスタンスの AWS KMS キー識別子。 タイプ: 文字列 必須: いいえ ** LatestRestorableTime ** 特定時点への復元によりデータベースを復元できる最新の日時を指定します。 型: タイムスタンプ 必須: いいえ ** PendingModifiedValues ** インスタンスへの変更が保留中であることを指定します。この要素は、変更が保留中の場合にのみ含まれます。特定の変更は、サブエレメントによって識別されます。 型: [PendingModifiedValues](API_PendingModifiedValues.md) オブジェクト 必須: いいえ ** 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](API_DBInstanceStatusInfo.md) オブジェクトの配列 必須: いいえ ** StorageEncrypted ** インスタンスが暗号化されているかどうかを指定します。 型: ブール値 必須: いいえ ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** インスタンスが属する VPC セキュリティグループ要素のリストを入力します。 タイプ: [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) オブジェクトの配列 必須：いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) # DBInstanceStatusInfo インスタンスのステータス情報のリストを入力します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Message ** インスタンスにエラーがある場合のエラーの詳細。インスタンスがエラー状態にない場合、この値は空白です。 タイプ: 文字列 必須: いいえ ** Normal ** インスタンスが正常に動作している場合はブール値が `true`、インスタンスがエラー状態の場合は `false` です。 型: ブール値 必須: いいえ ** Status ** インスタンスのステータス。リードレプリカの `StatusType` の場合、値は `replicating`、エラー、`stopped`、または `terminated` となります。 タイプ: 文字列 必須: いいえ ** StatusType ** 現在、この値は「`read replication`」です。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) # DBSubnetGroup サブネットグループに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBSubnetGroupArn ** DB サブネットグループの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** DBSubnetGroupDescription ** サブネットグループの説明を入力します。 タイプ: 文字列 必須: いいえ ** DBSubnetGroupName ** サブネットグループの名前。 タイプ: 文字列 必須: いいえ ** SubnetGroupStatus ** サブネットグループのステータスを入力します。 タイプ: 文字列 必須: いいえ ** Subnets.Subnet.N ** サブネットグループ内の 1 つ以上のサブネットに関する詳細情報。 型: [Subnet](API_Subnet.md) オブジェクトの配列 必須: いいえ ** SupportedNetworkTypes.member.N ** DB サブネットグループのネットワークタイプ。 有効な値: `IPV4` \$1 `DUAL` `DBSubnetGroup` は IPv4 プロトコルのみ、または IPv4 プロトコルと IPv6 プロトコル (DUAL) をサポートできます。 型: 文字列の配列 必須: いいえ ** VpcId ** サブネットグループの VPC (Virtual Private Cloud) ID を提供します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) # Endpoint クラスターまたはインスタンスにアクセスするためのネットワーク情報。クライアントプログラムは、これらの Amazon DocumentDB リソースにアクセスするための有効なエンドポイントを指定する必要があります。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Address ** インスタンスの DNS アドレスが指定されます。 タイプ: 文字列 必須: いいえ ** HostedZoneId ** ホストゾーンを作成するときに Amazon Route 53 が割り当てる ID を指定します。 タイプ: 文字列 必須: いいえ ** Port ** データベースエンジンがリッスンするポートを指定します。 タイプ: 整数 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) # EngineDefaults `DescribeEngineDefaultClusterParameters` オペレーションの呼び出しが成功した結果が含まれています。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBParameterGroupFamily ** エンジンパラメータ情報を返すクラスターパラメータグループファミリーの名前。 タイプ: 文字列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** Parameters.Parameter.N ** 特定のクラスターパラメータグループファミリのパラメータ。 タイプ: [Parameter](API_Parameter.md) オブジェクトの配列 必須：いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) # Event イベントに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Date ** イベントの日付と時刻を指定します。 型: タイムスタンプ 必須: いいえ ** EventCategories.EventCategory.N ** イベントのカテゴリを指定します。 型: 文字列の配列 必須: いいえ ** Message ** このイベントのテキストを入力します。 タイプ: 文字列 必須: いいえ ** SourceArn ** イベントの Amazon リソースネーム (ARN) タイプ: 文字列 必須: いいえ ** SourceIdentifier ** イベントの発生元の識別子を入力します。 タイプ: 文字列 必須: いいえ ** SourceType ** このイベントのソースタイプを指定します。 型: 文字列 有効な値：`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) # EventCategoriesMap 1 つ以上のイベントカテゴリ名が含むイベントソースタイプ。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** EventCategories.EventCategory.N ** 指定されたソースタイプのイベントカテゴリ。 型: 文字列の配列 必須: いいえ ** SourceType ** 返されたカテゴリに属しているソースタイプ。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) # EventSubscription サブスクライブしたイベントの詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** CustomerAwsId ** Amazon DocumentDB イベント通知サブスクリプションに関連付けられている AWS 顧客アカウント。 タイプ: 文字列 必須: いいえ ** CustSubscriptionId ** Amazon DocumentDB イベント通知サブスクリプション ID。 タイプ: 文字列 必須: いいえ ** Enabled ** サブスクリプションが有効になっているかどうかを示すブール値。サブスクリプションが有効になっているかどうかを示す `true` の値。 型: ブール値 必須: いいえ ** EventCategoriesList.EventCategory.N ** Amazon DocumentDB イベント通知サブスクリプションのイベントカテゴリのリスト。 型: 文字列の配列 必須: いいえ ** EventSubscriptionArn ** イベントサブスクリプションの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** SnsTopicArn ** Amazon DocumentDB イベント通知サブスクリプションのトピック ARN。 タイプ: 文字列 必須: いいえ ** SourceIdsList.SourceId.N ** Amazon DocumentDB イベント通知サブスクリプションのソース ID のリスト。 型: 文字列の配列 必須: いいえ ** SourceType ** Amazon DocumentDB イベント通知サブスクリプションのソースタイプ。 タイプ: 文字列 必須: いいえ ** Status ** Amazon DocumentDB イベント通知サブスクリプションのステータス。 制約: 次のいずれかを指定できます:`creating` `modifying``deleting``active``no-permission``topic-not-exist` `no-permission` ステータスは、Amazon DocumentDB が Amazon SNS トピックに投稿するアクセス許可を失ったことを示します。`topic-not-exist` ステータスは、サブスクリプションの作成後にトピックが削除されたことを示します。 タイプ: 文字列 必須: いいえ ** SubscriptionCreationTime ** Amazon DocumentDB イベント通知サブスクリプションが作成された時刻。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) # FailoverState Amazon DocumentDB グローバルクラスターでスケジュールされたオペレーションまたは処理中のオペレーションの状態が含まれます。スイッチオーバーまたはフェイルオーバーオペレーションがスケジュールされているか、グローバルクラスターで進行中の場合を除き、このデータ型は空です。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** FromDbClusterArn ** 現在降格中であり、この状態に関連付けられている Amazon DocumentDB クラスターの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** IsDataLossAllowed ** オペレーションがグローバルスイッチオーバーかグローバルフェイルオーバーかを示します。データ損失が許可されている場合、オペレーションはグローバルフェイルオーバーです。それ以外の場合は、スイッチオーバーです。 タイプ: ブール値 必須: いいえ ** Status ** グローバルクラスターの現在のステータス。可能な値は以下のとおりです。 + **保留中** – サービスは、グローバルクラスターのスイッチオーバーまたはフェイルオーバーのリクエストを受信しました。グローバルクラスターのプライマリクラスターと指定されたセカンダリクラスターは、オペレーションの開始前に検証中です。 + **フェイルオーバー** – 選択したセカンダリクラスターは、グローバルクラスターをフェイルオーバーする新しいプライマリクラスターに昇格中です。 + **キャンセル** — グローバルクラスターの切り替えまたはフェイルオーバーのリクエストがキャンセルされ、プライマリクラスターと選択したセカンダリクラスターが以前の状態に戻ります。 型: 文字列 有効な値：`pending | failing-over | cancelling` 必須：いいえ ** ToDbClusterArn ** 現在昇格中で、この状態に関連付けられている Amazon DocumentDB クラスターの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) # Filter より具体的な結果のリストを返すために使用される、フィルタ値の名前付きセット。フィルターを使用すると、ID などの特定の基準でリソースのセットを照合できます。 ワイルドカードがサポートされていません。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Name ** フィルターの名前。フィルター名では大文字と小文字が区別されます。 タイプ: 文字列 必須: はい ** Values.Value.N ** 1 つまたは複数のフィルターの値。フィルタの値は大文字と小文字が区別されます。 型: 文字列の配列 必須: はい ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) # GlobalCluster Amazon DocumentDB グローバルクラスターを表すデータ型。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DatabaseName ** 新しいグローバルクラスター内のデフォルトのデータベース名。 タイプ: 文字列 必須: いいえ ** DeletionProtection ** 新しいグローバルクラスターの削除保護設定。 タイプ: ブール値 必須: いいえ ** Engine ** グローバルクラスターで使用される Amazon DocumentDB データベースエンジン。 タイプ: 文字列 必須: いいえ ** EngineVersion ** データベースエンジンのバージョンを示します。 タイプ: 文字列 必須: いいえ ** FailoverState ** このグローバルクラスターのプロセス内または保留中のスイッチオーバーまたはフェイルオーバープロセスの現在の状態のすべてのプロパティを含むデータオブジェクト。このグローバルクラスターで `SwitchoverGlobalCluster`または `FailoverGlobalCluster`オペレーションが呼び出されない限り、このオブジェクトは空です。 型: [FailoverState](API_FailoverState.md) オブジェクト 必須: いいえ ** GlobalClusterArn ** グローバルクラスターの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** GlobalClusterIdentifier ** ユーザーが指定したグローバルクラスター識別子が含まれています。この識別子は、グローバルクラスターを識別する一意のキーです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: いいえ ** GlobalClusterMembers.GlobalClusterMember.N ** グローバルクラスタ内のセカンダリクラスターのクラスター ID のリスト。現在、1 つの項目に制限されています。 タイプ: [GlobalClusterMember](API_GlobalClusterMember.md) オブジェクトの配列 必須: いいえ ** GlobalClusterResourceId ** グローバルデータベースクラスターの AWS リージョンリージョン固有のイミュータブルな識別子。この識別子は、クラスターの AWS KMS カスタマーマスターキー (CMK) にアクセスするたびに AWS CloudTrail ログエントリに記録されます。 タイプ: 文字列 必須: いいえ ** Status ** このグローバルクラスターの現在の状態を指定します。 タイプ: 文字列 必須: いいえ ** StorageEncrypted ** グローバルクラスターの記憶域暗号化設定。 タイプ: ブール値 必須: いいえ ** TagList.Tag.N ** グローバルクラスタータグのリスト。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須：いいえ ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) # GlobalClusterMember Amazon DocumentDB グローバルクラスターに関連付けられているプライマリおよびセカンダリークラスターに関する情報を含むデータ構造。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** DBClusterArn ** 各 Amazon DocumentDB クラスターの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ** IsWriter ** Amazon DocumentDB クラスターが関連付けられている Amazon DocumentDB グローバルクラスターの主クラスタ (読み取り/書き込み機能を持つ) かどうか指定します。 タイプ: ブール値 必須: いいえ ** Readers.member.N ** Amazon DocumentDB グローバルクラスターに関連付けられている各読み取りセカンダリクラスターの Amazon リソースネーム (ARN)。 型: 文字列の配列 必須: いいえ ** SynchronizationStatus ** グローバルクラスター内の各 Amazon DocumentDB クラスターの同期ステータス。 型: 文字列 有効な値：`connected | pending-resync` 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) # OrderableDBInstanceOption インスタンスで使用できるオプション。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AvailabilityZones.AvailabilityZone.N ** インスタンスのアベイラビリティーゾーンのリスト。 タイプ: [AvailabilityZone](API_AvailabilityZone.md) オブジェクトの配列 必須: いいえ ** DBInstanceClass ** インスタンスのインスタンスクラス。 タイプ: 文字列 必須: いいえ ** Engine ** インスタンスのエンジンタイプ。 タイプ: 文字列 必須: いいえ ** EngineVersion ** インスタンスのエンジンバージョン。 タイプ: 文字列 必須: いいえ ** LicenseModel ** インスタンスのライセンスモデル。 タイプ: 文字列 必須: いいえ ** StorageType ** その DB クラスターに関連付けるストレージタイプ。 タイプ: 文字列 必須: いいえ ** Vpc ** インスタンスが VPC (Virtual Private Cloud) にあるかどうかを示します。 型: ブール値 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) # Parameter 個々のパラメータに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AllowedValues ** パラメータの有効な値の範囲を指定します。 タイプ: 文字列 必須: いいえ ** ApplyMethod ** パラメータの更新を適用するタイミングを指定します。 タイプ: 文字列 有効な値：`immediate | pending-reboot` 必須: いいえ ** ApplyType ** エンジン固有のパラメータタイプを指定します。 タイプ: 文字列 必須: いいえ ** DataType ** パラメータの有効なデータ型を指定します。 タイプ: 文字列 必須: いいえ ** Description ** パラメータの説明を入力します。 タイプ: 文字列 必須: いいえ ** IsModifiable ** パラメータを変更できるか (`true`) 、できない (`false`) かを示します。いくつかのパラメータには、それらの変更を妨げるセキュリティ上または運用上の影響があります。 型: ブール値 必須: いいえ ** MinimumEngineVersion ** パラメータを適用できる最も古いエンジンバージョン。 タイプ: 文字列 必須: いいえ ** ParameterName ** パラメータの名前を指定します。 タイプ: 文字列 必須: いいえ ** ParameterValue ** パラメータの値を指定します。CSV 形式のクラスターパラメータの `AllowedValues` の 1 つ以上である必要があります。 次の値を指定できます。 + `enabled`: クラスターは TLS バージョン 1.0 から 1.3 を使用した安全な接続を受け入れます。 + `disabled`: クラスターは TLS を使用したセキュアな接続を受け入れません。 + `fips-140-3`クラスターは、連邦情報処理標準 (FIPS) 出版物 140-3 の要件に従った安全な接続のみを受け付けます。これらのリージョン (ca-central-1、us-west-2、us-east-1、us-east-2、us-gov-east-1、us-gov-west-1) で、Amazon DocumentDB 5.0 (エンジンバージョン 3.0.3727) 以降のクラスターでのみサポートされます。 + `tls1.2+`: クラスターは TLS バージョン 1.2 以降を使用した安全な接続を受け入れます。Amazon DocumentDB 4.0 (エンジンバージョン 2.0.10980) および Amazon DocumentDB 5.0 (エンジンバージョン 3.0.11051) 以降でのみサポートされています。 + `tls1.3+`: クラスターは TLS バージョン 1.3 以降を使用した安全な接続を受け入れます。Amazon DocumentDB 4.0 (エンジンバージョン 2.0.10980) および Amazon DocumentDB 5.0 (エンジンバージョン 3.0.11051) 以降でのみサポートされています。 タイプ: 文字列 必須: いいえ ** Source ** パラメータ値のソースを示します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) # PendingCloudwatchLogsExports 設定がまだ保留中のログタイプのリスト。これらのログタイプは有効化中または無効化中です。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** LogTypesToDisable.member.N ** 有効化中のログタイプ。有効にすると、これらのログタイプは Amazon CloudWatch Logs にエクスポートされます。 型: 文字列の配列 必須: いいえ ** LogTypesToEnable.member.N ** 無効化中のログタイプ。無効化されたログタイプは CloudWatch Logs にエクスポートされません。 型: 文字列の配列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) # PendingMaintenanceAction リソースの保留中のメンテナンスアクションに関する情報を入力します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Action ** リソースに対して使用可能な保留中のメンテナンスアクションのタイプ。 タイプ: 文字列 必須: いいえ ** AutoAppliedAfterDate ** アクションが適用されたときのメンテナンスウィンドウの日付。メンテナンスアクションは、この日以降の最初のメンテナンスウィンドウ中にリソースに適用されます。この日付を指定した場合、`next-maintenance` オプトインリクエストは無視されます。 型: タイムスタンプ 必須: いいえ ** CurrentApplyDate ** 保留中のメンテナンスアクションがリソースに適用される有効日。 型: タイムスタンプ 必須: いいえ ** Description ** メンテナンスアクションについての詳細を提供する説明。 タイプ: 文字列 必須: いいえ ** ForcedApplyDate ** アクションが自動的に適用されたときのメンテナンスウィンドウの日付。メンテナンスアクションは、リソースのメンテナンスウィンドウに関係なく、この日にリソースに適用されます。この日付を指定した場合、`immediate` オプトインリクエストは無視されます。 型: タイムスタンプ 必須: いいえ ** OptInStatus ** リソースに対して受信されたオプトインリクエストのタイプを示します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) # PendingModifiedValues インスタンスの 1 つ以上の変更された設定。これらの変更された設定はリクエストされていますが、まだ適用されていません。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AllocatedStorage ** 適用される、または現在適用されているインスタンスの新しい `AllocatedStorage` サイズが含まれています。 タイプ: 整数 必須: いいえ ** BackupRetentionPeriod ** 自動バックアップを保持する保留日数を指定します。 タイプ: 整数 必須: いいえ ** CACertificateIdentifier ** DB インスタンスの 認定権限 (CA) 証明書の識別子を指定します。 タイプ: 文字列 必須: いいえ ** DBInstanceClass ** 適用される、または現在適用されているインスタンスの新しい `DBInstanceClass` が含まれています。 タイプ: 文字列 必須: いいえ ** DBInstanceIdentifier ** 適用される、または現在適用されているインスタンスの新しい `DBInstanceIdentifier` が含まれています。 タイプ: 文字列 必須: いいえ ** DBSubnetGroupName ** インスタンスの新しいサブネットグループ。 タイプ: 文字列 必須: いいえ ** EngineVersion ** データベースエンジンのバージョンを示します。 タイプ: 文字列 必須: いいえ ** Iops ** 適用される、または現在適用されているインスタンスの新しいプロビジョンド IOPS 値を指定します。 タイプ: 整数 必須: いいえ ** LicenseModel ** インスタンスのライセンスモデル。 有効な値:`license-included` 、`bring-your-own-license`、`general-public-license` タイプ: 文字列 必須: いいえ ** MasterUserPassword ** インスタンスのマスター認証情報の保留中または現在進行中の変更が含まれています。 タイプ: 文字列 必須: いいえ ** MultiAZ ** Single-AZ インスタンスをマルチ AZ 配置に変更することを示します。 型: ブール値 必須: いいえ ** PendingCloudwatchLogsExports ** 設定がまだ保留中のログタイプのリスト。これらのログタイプは有効化中または無効化中です。 型: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) オブジェクト 必須: いいえ ** Port ** インスタンスの保留ポートを指定します。 タイプ: 整数 必須: いいえ ** StorageType ** インスタンスに関連付けられるストレージタイプを指定します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) # ResourcePendingMaintenanceActions [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) の出力を表します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N ** リソースの保留中のメンテナンスアクションに関する詳細を提供するリスト。 タイプ: [PendingMaintenanceAction](API_PendingMaintenanceAction.md) オブジェクトの配列 必須: いいえ ** ResourceIdentifier ** 保留中のアクションが適用されるリソースの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) # ServerlessV2FeaturesSupport Amazon DocumentDB エンジンのバージョンが異なる Amazon DocumentDB Serverless プロパティまたは制限を指定します。新しいクラスターまたはアップグレードされたクラスターで使用する Amazon DocumentDB バージョンを決定するときに、この属性の値をテストできます。既存のクラスターのバージョンを取得し、そのバージョンが特定の Amazon DocumentDB Serverless 機能をサポートしているかどうかを確認してから、それらの機能を使用することもできます。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** MaxCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最大数。DCU 値は、32、32.5、33 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ** MinCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最小数。DCU 値は、8、8.5、9 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) # ServerlessV2ScalingConfiguration Amazon DocumentDB Serverless クラスターのスケーリング設定を設定します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** MaxCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最大数。DCU 値は、32、32.5、33 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ** MinCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最小数。DCU 値は、8、8.5、9 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) # ServerlessV2ScalingConfigurationInfo Amazon DocumentDB Serverless クラスターのスケーリング設定を取得します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** MaxCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最大数。DCU 値は、32、32.5、33 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ** MinCapacity ** Amazon DocumentDB Serverless クラスター内のインスタンスの Amazon DocumentDB キャパシティユニット (DCU) の最小数。DCU 値は、8、8.5、9 など、半段階刻みで指定できます。 型: 倍精度浮動小数点数 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) # Subnet サブネットグループに関する詳細情報。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** SubnetAvailabilityZone ** サブネットのアベイラビリティーゾーンを指定します。 型: [AvailabilityZone](API_AvailabilityZone.md) オブジェクト 必須: いいえ ** SubnetIdentifier ** サブネットの識別子を指定します。 タイプ: 文字列 必須: いいえ ** SubnetStatus ** サブネットのステータスを指定します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) # Tag キーと値のペアで構成される Amazon DocumentDB リソースに割り当てられるメタデータ。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Key ** タグに必要な名前。文字列値は、1 〜 128 文字の Unicode 文字です。「`aws:`」または「`rds:`」をプレフィックスとして使用することはできません。文字列には、一連の Unicode 文字、数字、空白、「\$1」、「.」、「/」、「=」、「\$1」、「-」 (Java 正規表現: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)") のみ使用できます。 タイプ: 文字列 必須: いいえ ** Value ** タグの値 (オプション)。文字列値は、1 〜 256 文字の Unicode 文字です。「`aws:`」または「`rds:`」をプレフィックスとして使用することはできません。文字列には、一連の Unicode 文字、数字、空白、「\$1」、「.」、「/」、「=」、「\$1」、「-」 (Java 正規表現: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)") のみ使用できます。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) # UpgradeTarget インスタンスをアップグレードできるデータベースエンジンのバージョン。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** AutoUpgrade ** `AutoMinorVersionUpgrade` が `true` に設定されているソース DB インスタンスにターゲットバージョンが適用されるかどうかを示す値。 型: ブール値 必須: いいえ ** Description ** インスタンスをアップグレードできるデータベースエンジンのバージョン。 タイプ: 文字列 必須: いいえ ** Engine ** アップグレードターゲットデータベースエンジンの名前。 タイプ: 文字列 必須: いいえ ** EngineVersion ** アップグレードターゲットのデータベースエンジンのバージョン番号。 タイプ: 文字列 必須: いいえ ** IsMajorVersionUpgrade ** データベースエンジンがメジャーバージョンにアップグレードされているかどうかを示す値。 型: ブール値 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) # VpcSecurityGroupMembership VPC (Virtual Private Cloud) セキュリティグループメンバーシップに関するクエリのレスポンス要素として使用されます。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** Status ** VPC セキュリティグループのステータス。 タイプ: 文字列 必須: いいえ ** VpcSecurityGroupId ** VPC セキュリティグループの名前。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) # Amazon DocumentDB Elastic Clusters Amazon DocumentDB Elastic クラスターでは、以下のデータ型がサポートされています。 + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Cluster 特定のエラスティッククラスターに関する情報を返します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** adminUserName ** エラスティッククラスター管理者の名前。 タイプ: 文字列 必須: はい ** authType ** エラスティッククラスターの認証タイプ。 型: 文字列 有効な値：`PLAIN_TEXT | SECRET_ARN` 必須: はい ** clusterArn ** エラスティッククラスターの ARN 識別子。 タイプ: 文字列 必須: はい ** clusterEndpoint ** エラスティッククラスターへの接続に使用されている URL。 タイプ: 文字列 必須: はい ** clusterName ** エラスティッククラスターの名前。 タイプ: 文字列 必須: はい ** createTime ** エラスティッククラスターが作成された協定世界時 (UTC) 時刻。 タイプ: 文字列 必須: はい ** kmsKeyId ** エラスティッククラスターの暗号化に使用する KMS キー識別子。 タイプ: 文字列 必須: はい ** preferredMaintenanceWindow ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式*: `ddd:hh24:mi-ddd:hh24:mi` タイプ: 文字列 必須: はい ** shardCapacity ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。 タイプ: 整数 必須: はい ** shardCount ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。 タイプ: 整数 必須: はい ** status ** エラスティッククラスターのステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必須: はい ** subnetIds ** エラスティッククラスターの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: はい ** vpcSecurityGroupIds ** このクラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: はい ** backupRetentionPeriod ** 自動スナップショットが保持される日数。 タイプ: 整数 必須: いいえ ** preferredBackupWindow ** `backupRetentionPeriod` に応じて、自動バックアップが有効な場合に毎日自動バックアップの作成を実行する時間範囲を指定します。 タイプ: 文字列 必須: いいえ ** shardInstanceCount ** クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値 が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。 タイプ: 整数 必須: いいえ ** shards ** クラスター内のシャードの数 タイプ: [Shard](API_elastic_Shard.md) オブジェクトの配列 必須：いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) # ClusterInList Amazon DocumentDB エラスティッククラスターのリスト。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** clusterArn ** エラスティッククラスターの ARN 識別子。 タイプ: 文字列 必須: はい ** clusterName ** エラスティッククラスターの名前。 タイプ: 文字列 必須: はい ** status ** エラスティッククラスターのステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必須: はい ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) # ClusterSnapshot 特定のエラスティッククラスタースナップショットに関する情報を返します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** adminUserName ** エラスティッククラスター管理者の名前。 タイプ: 文字列 必須: はい ** clusterArn ** エラスティッククラスターの ARN 識別子。 タイプ: 文字列 必須: はい ** clusterCreationTime ** エラスティッククラスターが作成された協定世界時 (UTC) 時刻。 タイプ: 文字列 必須: はい ** kmsKeyId ** KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。ここで暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。 タイプ: 文字列 必須: はい ** snapshotArn ** エラスティッククラスタースナップショットの ARN 識別子。 タイプ: 文字列 必須: はい ** snapshotCreationTime ** エラスティッククラスターが作成された協定世界時 (UTC) 時刻。 タイプ: 文字列 必須: はい ** snapshotName ** エラスティッククラスタースナップショットの名前。 タイプ: 文字列 必須: はい ** status ** エラスティッククラスタースナップショットのステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必須: はい ** subnetIds ** エラスティッククラスターの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: はい ** vpcSecurityGroupIds ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: はい ** snapshotType ** 返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。 + `automated` - Amazon DocumentDB が AWS アカウントに対して自動作成したクラスタースナップショットをすべて返します。 + `manual` - AWS アカウントに対して手動作成したクラスタースナップショットをすべて返します。 型: 文字列 有効な値：`MANUAL | AUTOMATED` 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) # ClusterSnapshotInList エラスティッククラスタースナップショットのリスト。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** clusterArn ** エラスティッククラスターの ARN 識別子。 タイプ: 文字列 必須: はい ** snapshotArn ** エラスティッククラスタースナップショットの ARN 識別子。 タイプ: 文字列 必須: はい ** snapshotCreationTime ** エラスティッククラスターが作成された協定世界時 (UTC) 時刻。 タイプ: 文字列 必須: はい ** snapshotName ** エラスティッククラスタースナップショットの名前。 タイプ: 文字列 必須: はい ** status ** エラスティッククラスタースナップショットのステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必須: はい ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) # PendingMaintenanceActionDetails 保留中のメンテナンスアクションの詳細を取得します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** action ** 保留中のメンテナンスアクションの特定のアクションを表示します。 タイプ: 文字列 必須: はい ** autoAppliedAfterDate ** アクションが適用されたときのメンテナンスウィンドウの日付を表示します。メンテナンスアクションは、この日以降の最初のメンテナンスウィンドウ中にリソースに適用されます。この日付を指定した場合、`NEXT_MAINTENANCE` `optInType` リクエストは無視されます。 タイプ: 文字列 必須: いいえ ** currentApplyDate ** 保留中のメンテナンスアクションがリソースに適用される有効日を表示します。 タイプ: 文字列 必須: いいえ ** description ** メンテナンスアクションについての詳細を提供する説明を表示します。 タイプ: 文字列 必須: いいえ ** forcedApplyDate ** アクションが自動的に適用されたときのメンテナンスウィンドウの日付を表示します。メンテナンスアクションは、リソースのメンテナンスウィンドウに関係なく、この日にリソースに適用されます。この日付を指定した場合、`IMMEDIATE` `optInType` リクエストは無視されます。 タイプ: 文字列 必須: いいえ ** optInStatus ** リソースに対して受信された `optInType` リクエストのタイプを表示します。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) # ResourcePendingMaintenanceAction リソースの保留中のメンテナンスアクションに関する情報を入力します。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** pendingMaintenanceActionDetails ** リソースの保留中のメンテナンスアクションに関する情報を入力します。 型: [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) オブジェクトの配列 必須: いいえ ** resourceArn ** 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム)。 タイプ: 文字列 必須: いいえ ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) # Shard シャードの名前 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** createTime ** そのシャードが作成された協定世界時 (UTC) 時刻。 タイプ: 文字列 必須: はい ** shardId ** シャードの ID タイプ: 文字列 必須: はい ** status ** そのシャードの現在のステータス。 型: 文字列 有効な値：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必須: はい ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) # ValidationExceptionField 特定の検証例外が発生した具体的なフィールド。 ## 内容 **注記** 次のリストで必須のパラメーターを説明します。 ** message ** このフィールドの検証例外を説明するエラーメッセージ。 タイプ: 文字列 必須: はい ** name ** 検証例外が発生したフィールドの名前。 タイプ: 文字列 必須: はい ## 以下の資料も参照してください。 言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField)