翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Amazon DocumentDB クラスター、インスタンス、およびリソース管理 API リファレンス このセクションでは HTTP、AWS Command Line Interface (AWS CLI) または AWS SDK を介してアクセス可能な Amazon DocumentDB (MongoDB 互換性あり) のクラスター、インスタンス、およびリソース管理操作について説明します。これらの API を使用して、クラスターおよびインスタンスの作成、削除、および変更を行うことができます。 **重要** これらの API は、クラスター、インスタンス、および関連リソースの管理にのみ使用されます。稼働中の Amazon DocumentDB クラスターに接続する方法については [入門ガイド](get-started-guide.md) を参照してください。 **Topics** + [アクション](API_Operations.md) + [データ型](API_Types.md) + [共通エラー](CommonErrors.md) + [共通パラメータ](CommonParameters.md) # アクション Amazon DocumentDB (with MongoDB compatibility) は以下のアクションをサポートしています。 + [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) + [AddTagsToResource](API_AddTagsToResource.md) + [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) + [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) + [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) + [CreateDBCluster](API_CreateDBCluster.md) + [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) + [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) + [CreateDBInstance](API_CreateDBInstance.md) + [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) + [CreateEventSubscription](API_CreateEventSubscription.md) + [CreateGlobalCluster](API_CreateGlobalCluster.md) + [DeleteDBCluster](API_DeleteDBCluster.md) + [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) + [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) + [DeleteEventSubscription](API_DeleteEventSubscription.md) + [DeleteGlobalCluster](API_DeleteGlobalCluster.md) + [DescribeCertificates](API_DescribeCertificates.md) + [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) + [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) + [DescribeDBClusters](API_DescribeDBClusters.md) + [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) + [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) + [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) + [DescribeDBInstances](API_DescribeDBInstances.md) + [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) + [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) + [DescribeEventCategories](API_DescribeEventCategories.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) + [DescribeGlobalClusters](API_DescribeGlobalClusters.md) + [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) + [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) + [FailoverDBCluster](API_FailoverDBCluster.md) + [FailoverGlobalCluster](API_FailoverGlobalCluster.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ModifyDBCluster](API_ModifyDBCluster.md) + [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) + [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) + [ModifyEventSubscription](API_ModifyEventSubscription.md) + [ModifyGlobalCluster](API_ModifyGlobalCluster.md) + [RebootDBInstance](API_RebootDBInstance.md) + [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) + [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) + [RemoveTagsFromResource](API_RemoveTagsFromResource.md) + [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) + [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) + [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) + [StartDBCluster](API_StartDBCluster.md) + [StopDBCluster](API_StopDBCluster.md) + [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) Amazon DocumentDB Elastic クラスターでは、以下のアクションがサポートされています。 + [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) + [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) + [CreateCluster](API_elastic_CreateCluster.md) + [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) + [DeleteCluster](API_elastic_DeleteCluster.md) + [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) + [GetCluster](API_elastic_GetCluster.md) + [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) + [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) + [ListClusters](API_elastic_ListClusters.md) + [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) + [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) + [ListTagsForResource](API_elastic_ListTagsForResource.md) + [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) + [StartCluster](API_elastic_StartCluster.md) + [StopCluster](API_elastic_StopCluster.md) + [TagResource](API_elastic_TagResource.md) + [UntagResource](API_elastic_UntagResource.md) + [UpdateCluster](API_elastic_UpdateCluster.md) # Amazon DocumentDB (with MongoDB compatibility) Amazon DocumentDB (with MongoDB compatibility) は以下のアクションをサポートしています。 + [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) + [AddTagsToResource](API_AddTagsToResource.md) + [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) + [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) + [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) + [CreateDBCluster](API_CreateDBCluster.md) + [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) + [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) + [CreateDBInstance](API_CreateDBInstance.md) + [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) + [CreateEventSubscription](API_CreateEventSubscription.md) + [CreateGlobalCluster](API_CreateGlobalCluster.md) + [DeleteDBCluster](API_DeleteDBCluster.md) + [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) + [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) + [DeleteEventSubscription](API_DeleteEventSubscription.md) + [DeleteGlobalCluster](API_DeleteGlobalCluster.md) + [DescribeCertificates](API_DescribeCertificates.md) + [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) + [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) + [DescribeDBClusters](API_DescribeDBClusters.md) + [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) + [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) + [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) + [DescribeDBInstances](API_DescribeDBInstances.md) + [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) + [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) + [DescribeEventCategories](API_DescribeEventCategories.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) + [DescribeGlobalClusters](API_DescribeGlobalClusters.md) + [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) + [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) + [FailoverDBCluster](API_FailoverDBCluster.md) + [FailoverGlobalCluster](API_FailoverGlobalCluster.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ModifyDBCluster](API_ModifyDBCluster.md) + [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) + [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) + [ModifyEventSubscription](API_ModifyEventSubscription.md) + [ModifyGlobalCluster](API_ModifyGlobalCluster.md) + [RebootDBInstance](API_RebootDBInstance.md) + [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) + [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) + [RemoveTagsFromResource](API_RemoveTagsFromResource.md) + [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) + [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) + [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) + [StartDBCluster](API_StartDBCluster.md) + [StopDBCluster](API_StopDBCluster.md) + [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) # AddSourceIdentifierToSubscription 既存のイベント通知サブスクリプションにソース識別子を追加します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SourceIdentifier ** 追加されるイベントソースの識別子。 + ソースタイプがインスタンスの場合は、`DBInstanceIdentifier` を指定する必要があります。 + ソースタイプがセキュリティグループである場合は、`DBSecurityGroupName` を指定する必要があります。 + ソースタイプがパラメータグループである場合は、`DBParameterGroupName` を指定する必要があります。 + ソースタイプが DB ナップショットである場合は、`DBSnapshotIdentifier` を指定する必要があります。 タイプ: 文字列 必須: はい ** SubscriptionName ** ソース識別子を追加する Amazon DocumentDB イベント通知サブスクリプション名。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** EventSubscription ** サブスクライブしたイベントの詳細情報。 型: [EventSubscription](API_EventSubscription.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** SourceNotFound ** リクエストされたリソースが見つかりませんでした。 HTTP ステータスコード: 404 ** SubscriptionNotFound ** サブスクリプション名が存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) # AddTagsToResource Amazon DocumentDB リソースにメタデータタグを追加します。これらのタグをコスト配分レポートで使用して、Amazon DocumentDB リソースに関連付けられているコストを追跡したり、Amazon DocumentDB の AWS Identity and Access Management Amazon DocumentDBポリシーの`Condition`ステートメントで追跡したりできます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** ResourceName ** タグが追加される Amazon DocumentDB リソース。この値は Amazon リソースネーム (ARN) です。 タイプ: 文字列 必須: はい **Tags.Tag.N** Amazon DocumentDB リソースに割り当てられるタグ。 型: [Tag](API_Tag.md) オブジェクトの配列 必須: はい ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBInstanceNotFound ** `DBInstanceIdentifier` は既存のインスタンスを参照していません。 HTTP ステータスコード: 404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` は既存のスナップショットを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) # ApplyPendingMaintenanceAction 保留中のメンテナンスアクションをリソース (例えば Amazon DocumentDB) に適用します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** ApplyAction ** このリソースに適用する保留中のメンテナンスアクション。 有効な値: `system-update`、`db-upgrade` タイプ: 文字列 必須: はい ** OptInType ** オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値。タイプ `immediate` のオプトインリクエストは元に戻すことができません。 有効な値: + `immediate` - メンテナンスアクションをすぐに適用します。 + `next-maintenance` - リソースの次のメンテナンスウィンドウ中にメンテナンスアクションを適用します。 + `undo-opt-in` - 既存の `next-maintenance` オプトインリクエストをキャンセルします。 タイプ: 文字列 必須: はい ** ResourceIdentifier ** 保留中のアクションが適用されるリソースの Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** ResourcePendingMaintenanceActions ** [ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction) の出力を表します。 型: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ** ResourceNotFoundFault ** 指定されたリソース ID は見つかりませんでした。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) # CopyDBClusterParameterGroup 指定されたクラスターパラメータグループをコピーします。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SourceDBClusterParameterGroupIdentifier ** ソースクラスターパラメータグループの識別子または Amazon リソースネーム (ARN)。 制約: + 有効なクラスターグループを指定する必要があります。 + ソースクラスターパラメータグループがコピー AWS リージョン と同じ にある場合は、 などの有効なパラメータグループ識別子`my-db-cluster-param-group`、または有効な ARN を指定します。 + ソースパラメータグループがコピー AWS リージョン とは異なる にある場合は、有効なクラスターパラメータグループ ARN を指定します。たとえば、 です`arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`。 タイプ: 文字列 必須: はい ** TargetDBClusterParameterGroupDescription ** コピーされたクラスターパラメータグループの説明。 タイプ: 文字列 必須: はい ** TargetDBClusterParameterGroupIdentifier ** コピーされたクラスターパラメータグループの識別子。 制約: + null、空、または空白にすることはできません。 + 1 ～ 255 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-cluster-param-group1` タイプ: 文字列 必須: はい **Tags.Tag.N** タグはパラメータグループに割り当てられます。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterParameterGroup ** クラスターパラメータグループに関する詳細情報。 型: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupAlreadyExists ** 同じ名前のパラメータグループがすでに存在します。 HTTP ステータスコード: 400 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** DBParameterGroupQuotaExceeded ** このリクエストにより、パラメータグループの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) # CopyDBClusterSnapshot クラスターのスナップショットをコピーします。 手動の共有クラスタースナップショットからクラスタースナップショットをコピーするには、`SourceDBClusterSnapshotIdentifier` が共有クラスタースナップショットの Amazon リソースネーム (ARN) でなければなりません 共有 DB クラスタースナップショットは、暗号化されているかどうかにかかわらず、同じ AWS リージョン内でコピーのみ行えます。 コピー操作の進行後にキャンセルするには、クラスタースナップショットが *[copying]* ステータスの間に `TargetDBClusterSnapshotIdentifier` で識別されるターゲットクラスタースナップショットを削除します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SourceDBClusterSnapshotIdentifier ** コピーするクラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。 制約: + [*available (使用可能)*] 状態の有効なクラスタースナップショットを指定する必要があります。 + ソースクラスタースナップショットがコピー AWS リージョン と同じ にある場合は、有効なスナップショット識別子を指定します。 + ソースクラスタースナップショットが別の にある AWS リージョン か、別の AWS アカウントによって所有されている場合は、スナップショット ARN を指定します。 例: `my-cluster-snapshot1` タイプ: 文字列 必須: はい ** TargetDBClusterSnapshotIdentifier ** ソースクラスタースナップショットから作成する新しいクラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-cluster-snapshot2` タイプ: 文字列 必須: はい ** CopyTags ** ソースクラスタースナップショットからターゲットクラスタースナップショットにすべてのタグをコピーする場合は `true` に、それ以外の場合は `false` に設定します。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ ** KmsKeyId ** 暗号化されたクラスタースナップショットの AWS KMS キー ID。キー ID AWS KMS は、Amazon リソースネーム (ARN)、 AWS KMS キー識別子、または AWS KMS 暗号化 AWS KMS キーのキーエイリアスです。 から暗号化されたクラスタースナップショットをコピーする場合 AWS アカウント、 の値を指定`KmsKeyId`して、新しい暗号化キーでコピーを AWS KMS 暗号化できます。の値を指定しない場合`KmsKeyId`、クラスタースナップショットのコピーはソースクラスタースナップショットと同じ AWS KMS キーで暗号化されます。 別の から共有されている暗号化されたクラスタースナップショットをコピーする場合は AWS アカウント、 の値を指定する必要があります`KmsKeyId`。 暗号化されたクラスタースナップショットを別の にコピーするには AWS リージョン、 を送信先リージョンのクラスタースナップショットのコピーを暗号化するために使用する AWS KMS キー ID `KmsKeyId`に設定します。 AWS KMS 暗号化キーは、作成された AWS リージョン に固有であり、 AWS リージョン 別の の暗号化キーを使用することはできません AWS リージョン。 暗号化されていないクラスタースナップショットをコピーして `KmsKeyId` パラメータに値を指定すると、エラーが返されます。 タイプ: 文字列 必須: いいえ ** PreSignedUrl ** コピーするソースクラスタースナップショットを含む の API アクションの署名バージョン 4 の署名付きリクエスト`CopyDBClusterSnapshot` AWS リージョン を含む URL。クラスタースナップショットを別の AWS リージョンからコピーする場合は、`PreSignedUrl` パラメータを使用する必要があります。 AWS SDK ツールまたは を使用している場合は AWS CLI、 `PreSignedUrl` を手動で指定する代わりに `SourceRegion` ( `--source-region`の場合は AWS CLI) を指定できます。`SourceRegion` を指定すると、ソース AWS リージョンで実行できる操作の有効なリクエストである署名付き URL が自動生成されます。 署名付き URL は、コピーするクラスタースナップショット AWS リージョン を含むソースで実行できる `CopyDBClusterSnapshot` API アクションの有効なリクエストである必要があります。署名付き URL リクエストでは、以下のパラメータ値を指定する必要があります。 + `SourceRegion` - コピーするスナップショットを含むリージョンの ID。 + `SourceDBClusterSnapshotIdentifier` - コピーする暗号化されたクラスタースナップショットの識別子。この識別子は、ソース AWS リージョンの Amazon リソースネーム (ARN) 形式であることが必要です。例えば、us-east-1 AWS リージョンから暗号化されたクラスタスナップショットをコピーする場合、`SourceDBClusterSnapshotIdentifier` は `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot` のようになります。 + `TargetDBClusterSnapshotIdentifier` - 作成する新しい暗号化されたクラスタースナップショットの識別子。このパラメータでは大文字と小文字は区別されません。 タイプ: 文字列 必須: いいえ **Tags.Tag.N** クラスタースナップショットに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterSnapshot ** クラスタースナップショットに関する詳細情報。 型: [DBClusterSnapshot](API_DBClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterSnapshotAlreadyExistsFault ** 指定された識別子を持つクラスタースナップショットをすでに持っています。 HTTP ステータスコード: 400 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** KMSKeyNotAccessibleFault ** AWS KMS キーへのアクセス中にエラーが発生しました。 HTTP ステータスコード: 400 ** SnapshotQuotaExceeded ** リクエストにより、スナップショットの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) # CreateDBCluster 新しい Amazon DocumentDB クラスターを作成します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** クラスター識別子。このパラメータは小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字にする必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-cluster` タイプ: 文字列 必須: はい ** Engine ** このクラスターに使用されるデータベースエンジン名。 有効な値: `docdb` タイプ: 文字列 必須: はい **AvailabilityZones.AvailabilityZone.N** クラスター内のインスタンスを作成できる Amazon EC2 アベイラビリティーゾーンのリスト。 型: 文字列の配列 必須: いいえ ** BackupRetentionPeriod ** 自動バックアップを保管する日数。最小値 1 を指定しなければなりません。 デフォルト: 1 制約: + 1 ～ 35 の値にする必要があります。 タイプ: 整数 必須: いいえ ** DBClusterParameterGroupName ** このクラスターに関連付けるクラスターパラメータグループの名前。 タイプ: 文字列 必須: いいえ ** DBSubnetGroupName ** このクラスターに関連付けるサブネットグループ。 制約: 既存の `DBSubnetGroup` の名前と一致する必要があります。デフォルト値を使用することはできません。 例: `mySubnetgroup` タイプ: 文字列 必須: いいえ ** DeletionProtection ** このクラスターを削除できるかどうかを指定します。`DeletionProtection` を有効にすると、クラスターが変更され `DeletionProtection` が無効にならない限り、クラスターを削除することができません。`DeletionProtection` はクラスターが誤って削除されるのを防ぎます。 タイプ: ブール値 必須: いいえ **EnableCloudwatchLogsExports.member.N** Amazon CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。監査ログまたはプロファイラーログを有効にすることができます。詳細については、「[Amazon DocumentDB 監査イベント](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)」と「[Amazon DocumentDB オペレーションのプロファイリング](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html)」を参照してください。詳細については、「Amazon DocumentDB イベント監査」と「Amazon DocumentDB 操作プロファイリング」を参照してください。 型: 文字列の配列 必須: いいえ ** EngineVersion ** 使用するデータベースエンジンのバージョン番号。`--engine-version` は、デフォルトで最新のメジャーエンジンバージョンになります。本稼働ワークロードの場合、目的のメジャーエンジンのバージョンで、このパラメータを明示的に宣言することを推奨します。 タイプ: 文字列 必須: いいえ ** GlobalClusterIdentifier ** 新しいグローバルクラスターのクラスター識別子。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: いいえ ** KmsKeyId ** 暗号化されたクラスターの AWS KMS キー識別子。 AWS KMS キー識別子は、 AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用される AWS KMS 暗号化キーを所有 AWS アカウント する と同じ を使用してクラスターを作成する場合は、 AWS KMS 暗号化 AWS KMS キーの ARN の代わりにキーエイリアスを使用できます。 `KmsKeyId` で暗号化キーが指定されていない場合: + `StorageEncrypted` パラメータが `true` の場合、Amazon DocumentDB はデフォルトの暗号化キーを使用します。 AWS KMS は、 のデフォルトの暗号化キーを作成します AWS アカウント。には、それぞれ異なるデフォルトの暗号化キー AWS アカウント があります AWS リージョン。 タイプ: 文字列 必須: いいえ ** ManageMasterUserPassword ** Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理するかどうかを指定します。 `MasterUserPassword` が指定されている場合、Amazon Web Services Secrets Manager でマスターユーザーのパスワードを管理することはできません。 タイプ: ブール値 必須: いいえ ** MasterUsername ** クラスターのマスターユーザーの名前。 制約: + 1～63 文字の英数字である必要があります。 + 最初の文字は文字にする必要があります。 + 選択したデータベースエンジンの予約語は使用できません。 タイプ: 文字列 必須: いいえ ** MasterUserPassword ** マスターデータベースユーザーのパスワードです。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。 制約: 8 ～ 100 文字の長さの英数字である必要があります。 タイプ: 文字列 必須: いいえ ** MasterUserSecretKmsKeyId ** Amazon Web Services Secrets Manager で自動的に生成および管理されるシークレットを暗号化するための Amazon Web Services KMS キー識別子。この設定は、マスターユーザーパスワードが DB クラスターの Amazon Web Services Secrets Manager で Amazon DocumentDB によって管理されている場合にのみ有効です。 Amazon Web Services KMS キー識別子は、KMS キーのキー ARN、キー ID、エイリアス ARN、またはエイリアス名です。別の Amazon Web Services アカウントで KMS キーを使用するには、キー ARN またはエイリアス ARN を指定します。 `MasterUserSecretKmsKeyId` を指定しない場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化します。シークレットが別の Amazon Web Services アカウントにある場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化することはできません。カスタマー管理の KMS キーを使用する必要があります。 Amazon Web Services アカウントにはデフォルトの KMS キーがあります。Amazon Web Services アカウントには Amazon Web Services リージョンごとに異なるデフォルトの KMS キーがあります。 タイプ: 文字列 必須: いいえ ** 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` タイプ: 文字列 必須: いいえ ** Port ** クラスターのインスタンスが接続を受け付けることができるポート番号。 タイプ: 整数 必須: いいえ ** PreferredBackupWindow ** `BackupRetentionPeriod` パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。 デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。 制約: + `hh24:mi-hh24:mi` の形式である必要があります。 + 時間は協定世界時 (UTC) である必要があります。 + 必要なメンテナンス期間と競合してはいけません。 + 少なくとも 30 分以上必要です。 タイプ: 文字列 必須: いいえ ** PreferredMaintenanceWindow ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 形式: `ddd:hh24:mi-ddd:hh24:mi` デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウであり AWS リージョン、ランダムな曜日に発生します。 有効な曜日: 月、火、水、木、金、土、日 制約: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** PreSignedUrl ** 現在サポートされていません。 タイプ: 文字列 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。 型: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) オブジェクト 必須: いいえ ** StorageEncrypted ** クラスターが暗号化されているかどうかを指定します。 タイプ: ブール値 必須: いいえ ** StorageType ** DB クラスターに関連付けるストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です ストレージタイプを `iopt1` に設定して Amazon DocumentDB クラスターを作成すると、ストレージタイプが応答で返されます。この時 `standard` に設定すると、ストレージタイプは返されません。 タイプ: 文字列 必須: いいえ **Tags.Tag.N** クラスターに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ **VpcSecurityGroupIds.VpcSecurityGroupId.N** このクラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterAlreadyExistsFault ** 指定された識別子を持つクラスターをすでに持っています。 HTTP ステータスコード: 400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBClusterParameterGroupNotFound ** `DBClusterParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** DBClusterQuotaExceededFault ** クラスターの最大許容クォータに達したため、クラスターを作成できません。 HTTP ステータスコード: 403 ** DBInstanceNotFound ** `DBInstanceIdentifier` は既存のインスタンスを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** アベイラビリティーゾーンが 1 つしかない場合を除き、サブネットグループ内のサブネットは 2 つ以上のアベイラビリティゾーンをカバーする必要があります。 HTTP ステータスコード: 400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InsufficientStorageClusterCapacity ** 現在のアクションに使用可能なストレージが不十分です。使用できるストレージがより多い別のアベイラビリティーゾーンを使用するようにサブネットグループを更新することで、このエラーを解決できる場合があります。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBSubnetGroupStateFault ** サブネットグループは使用中のため削除できません。 HTTP ステータスコード: 400 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** KMSKeyNotAccessibleFault ** AWS KMS キーへのアクセス中にエラーが発生しました。 HTTP ステータスコード: 400 ** NetworkTypeNotSupported ** ネットワークタイプは、`DBSubnetGroup` または DB エンジンのバージョンではサポートされていません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) # CreateDBClusterParameterGroup 新しいクラスターのパラメータグループを作成します。 クラスターパラメータグループのパラメータは、クラスター内のすべてのインスタンスに適用されます。 クラスターパラメータグループは、最初はクラスターのインスタンスで使用されるデータベースエンジンのデフォルトパラメータで作成されます。Amazon DocumentDBでは、`default.docdb3.6` クラスターパラメータグループに直接変更を加えることはできません。Amazon DocumentDB クラスターがデフォルトのクラスタパラメータグループを使用していて、その中の値を変更する場合は、まず [新しいパラメータグループを作成](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) するか、[既存パラメータグループをコピー](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html) して変更した後に、変更したパラメータグループをクラスターに適用します。新しいクラスターパラメータグループと関連する設定を有効にするには、クラスターのインスタンスをフェイルオーバーなしで再起動する必要があります。詳細については、「[Amazon DocumentDB クラスターパラメータグループの変更](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html)」を参照してください。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** クラスターパラメータグループの名前。 制約: + 既存の `DBClusterParameterGroup` の名前と一致してはなりません。 この値は小文字で保存されます。 タイプ: 文字列 必須: はい ** DBParameterGroupFamily ** クラスターパラメータグループファミリーの名前。 タイプ: 文字列 必須: はい ** Description ** クラスターパラメータグループの説明。 タイプ: 文字列 必須: はい **Tags.Tag.N** クラスターパラメータグループに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterParameterGroup ** クラスターパラメータグループに関する詳細情報。 型: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupAlreadyExists ** 同じ名前のパラメータグループがすでに存在します。 HTTP ステータスコード: 400 ** DBParameterGroupQuotaExceeded ** このリクエストにより、パラメータグループの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) # CreateDBClusterSnapshot クラスターのスナップショットを作成します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** スナップショットを作成するクラスターの識別子。このパラメータは大文字と小文字が区別されません。 制約: + 既存の `DBCluster` の識別子と一致する必要があります。 例: `my-cluster` タイプ: 文字列 必須: はい ** DBClusterSnapshotIdentifier ** クラスタースナップショットの識別子。このパラメータは小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-cluster-snapshot1` タイプ: 文字列 必須: はい **Tags.Tag.N** クラスタースナップショットに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterSnapshot ** クラスタースナップショットに関する詳細情報。 型: [DBClusterSnapshot](API_DBClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBClusterSnapshotAlreadyExistsFault ** 指定された識別子を持つクラスタースナップショットをすでに持っています。 HTTP ステータスコード: 400 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** SnapshotQuotaExceeded ** リクエストにより、スナップショットの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) # CreateDBInstance 新しいインスタンスを作成します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** インスタンスが属するクラスターの識別子。 タイプ: 文字列 必須: はい ** DBInstanceClass ** インスタンスのコンピューティング能力とメモリ容量 (例: `db.r5.large`)。 タイプ: 文字列 必須: はい ** DBInstanceIdentifier ** インスタンス識別子。このパラメータは小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `mydbinstance` タイプ: 文字列 必須: はい ** Engine ** このインスタンスに使用するデータベースエンジンの名前。 有効な値: `docdb` タイプ: 文字列 必須: はい ** AutoMinorVersionUpgrade ** このパラメータは Amazon DocumentDB には適用されません。Amazon DocumentDB は、値セットに関係なく、マイナーバージョンのアップグレードを実行しません。 デフォルト: `false` タイプ: ブール値 必須: いいえ ** AvailabilityZone ** インスタンスが作成される Amazon EC2 アベイラビリティーゾーン。 デフォルト: エンドポイントのランダムなシステム選択のアベイラビリティーゾーン AWS リージョン。 例: `us-east-1d` タイプ: 文字列 必須: いいえ ** CACertificateIdentifier ** DB インスタンスのサーバー証明書に使用する 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)」を参照してください。 タイプ: 文字列 必須: いいえ ** CopyTagsToSnapshot ** タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを示す値。デフォルトでは、タグはコピーされません。 タイプ: ブール値 必須: いいえ ** EnablePerformanceInsights ** DB インスタンスで Performance Insights を有効にするかどうかを示す値。詳細については、「[Amazon Performance Insights の使用](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)」を参照してください。 タイプ: ブール値 必須: いいえ ** PerformanceInsightsKMSKeyId ** Performance Insights データを暗号化するための AWS KMS キー識別子。 AWS KMS キー識別子は、KMS キーのキー ARN、キー ID、エイリアス ARN、またはエイリアス名です。 PerformanceInsightsKMSKeyId に値を指定しない場合、Amazon DocumentDB はデフォルトの KMS キーを使用します。Amazon Web Services アカウントにはデフォルトの KMS キーがあります。Amazon Web Services アカウントには Amazon Web Services リージョンごとに異なるデフォルトの KMS キーがあります。 タイプ: 文字列 必須: いいえ ** PreferredMaintenanceWindow ** 毎週 1 回のシステムメンテナンスを実行できる時間帯、世界標準時 (UTC)。 形式: `ddd:hh24:mi-ddd:hh24:mi` デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウであり AWS リージョン、ランダムな曜日に発生します。 有効な曜日: 月、火、水、木、金、土、日 制約: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** PromotionTier ** 既存のプライマリインスタンスの障害後に、Amazon DocumentDB レプリカがプライマリインスタンスに昇格する順序を指定する値。 デフォルト: 1 有効な値: 0 ～ 15 タイプ: 整数 必須: いいえ **Tags.Tag.N** インスタンスに割り当てられるタグ。インスタンスには最大 10 個のタグを割り当てることができます。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBInstance ** インスタンスに関する詳細情報。 型: [DBInstance](API_DBInstance.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AuthorizationNotFound ** 指定された CIDRIP または Amazon EC2 セキュリティグループは、指定されたセキュリティグループに対して権限がありません。 Amazon DocumentDB には、IAM を使用してお客様に代わって必要なアクションを実行する権限がない場合もあります。 HTTP ステータスコード: 404 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBInstanceAlreadyExists ** 指定された識別子を持つインスタンスをすでに持っています。 HTTP ステータスコード: 400 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** DBSecurityGroupNotFound ** `DBSecurityGroupName` は既存のセキュリティグループを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** アベイラビリティーゾーンが 1 つしかない場合を除き、サブネットグループ内のサブネットは 2 つ以上のアベイラビリティゾーンをカバーする必要があります。 HTTP ステータスコード: 400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** InstanceQuotaExceeded ** リクエストにより、インスタンスの許容数を超過します。 HTTP ステータスコード: 400 ** InsufficientDBInstanceCapacity ** 指定されたインスタンスクラスは、指定されたアベイラビリティーゾーンで利用できません。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** KMSKeyNotAccessibleFault ** AWS KMS キーへのアクセス中にエラーが発生しました。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ** StorageTypeNotSupported ** 指定された `StorageType` のストレージはDBインスタンスに関連付けられません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) # CreateDBSubnetGroup 新しいサブネットグループを作成します。サブネットグループには、 AWS リージョン内の 2 つ以上のアベイラビリティゾーンに 1 つ以上のサブネットが含まれる必要があります。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBSubnetGroupDescription ** サブネットグループの説明。 タイプ: 文字列 必須: はい ** DBSubnetGroupName ** サブネットグループの名前。この値は小文字で保存されます。 制約: 最大 255 文字の英字、数字、ピリオド、アンダースコア、スペース、またはハイフンのみを使用できます。デフォルト値を使用することはできません。 例: `mySubnetgroup` タイプ: 文字列 必須: はい **SubnetIds.SubnetIdentifier.N** サブネットグループの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: はい **Tags.Tag.N** サブネットグループに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBSubnetGroup ** サブネットグループに関する詳細情報。 型: [DBSubnetGroup](API_DBSubnetGroup.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBSubnetGroupAlreadyExists ** `DBSubnetGroupName` は既存のサブネットグループですでに使用されています。 HTTP ステータスコード: 400 ** DBSubnetGroupDoesNotCoverEnoughAZs ** アベイラビリティーゾーンが 1 つしかない場合を除き、サブネットグループ内のサブネットは 2 つ以上のアベイラビリティゾーンをカバーする必要があります。 HTTP ステータスコード: 400 ** DBSubnetGroupQuotaExceeded ** リクエストにより、サブネットグループ許容数を超過します。 HTTP ステータスコード: 400 ** DBSubnetQuotaExceededFault ** リクエストにより、サブネットグループのサブネットの許容数を超過します。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) # CreateEventSubscription Amazon DocumentDB のイベント通知サブスクリプションを作成します。このアクションには、Amazon DocumentDB コンソール、Amazon SNS コンソール、または Amazon SNS API を使用して作成したトピック ARN (Amazon リソースネーム) が必要です。SNS で ARN を取得するには、Amazon SNS でトピックを作成し、そのトピックをサブスクライブする必要があります。ARN は Amazon SNS コンソールに表示されます。 通知を受け取る対象となるソースの種類 (`SourceType`) を指定ができます。また、イベントをトリガーする Amazon DocumentDB ソース (`SourceIds`) のリストを提供して、通知を受けるイベントのカテゴリ (`EventCategories`) のリストを提供できます。例えば、`SourceType = db-instance`、`SourceIds = mydbinstance1, mydbinstance2`、`EventCategories = Availability, Backup` と指定できます。 `SourceType` と `SourceIds` を、[`SourceType = db-instance`] と [`SourceIdentifier = myDBInstance1`] などに指定すると、指定したソースのすべての `db-instance` イベントが通知されます。[`SourceType` SourceType] を指定し、[`SourceIdentifier` SourceIdentifier] を指定しない場合、指定したAmazon DocumentDB ソースのすべてのイベント通知を受け取ります。`SourceType` も `SourceIdentifier` も指定しない場合、顧客アカウントに属する Amazon DocumentDB ソースから生成されたすべてのイベントの通知を受け取ります。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SnsTopicArn ** イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。 タイプ: 文字列 必須: はい ** SubscriptionName ** サブスクリプションの名前。 制約: この名前は 255 文字未満である必要があります。 タイプ: 文字列 必須: はい ** Enabled ** ブール値。サブスクリプションを有効にする場合は `true` に設定し、サブスクリプションを作成するが有効にしない場合は `false` に設定します。 タイプ: ブール値 必須: いいえ **EventCategories.EventCategory.N** サブスクライブする `SourceType` のイベントカテゴリのリスト。 型: 文字列の配列 必須: いいえ **SourceIds.SourceId.N** イベントが返されるイベントソースの識別子のリスト。指定しない場合は、すべてのソースはレスポンスに含まれます。識別子は文字で開始し、ASCII 文字、数字、ハイフンのみを使用できます。最後の文字をハイフンにすることはできず、ハイフンを 2 つ続けて使用することもできません。 制約: + `SourceIds` が指定される場合、`SourceType` も指定する必要があります。 + ソースタイプがインスタンスである場合は、`DBInstanceIdentifier` を指定する必要があります。 + ソースタイプがセキュリティグループである場合は、`DBSecurityGroupName` を指定する必要があります。 + ソースタイプがパラメータグループである場合は、`DBParameterGroupName` を指定する必要があります。 + ソースタイプがスナップショットである場合は、`DBSnapshotIdentifier` を指定する必要があります。 型: 文字列の配列 必須: いいえ ** SourceType ** イベントを生成しているソースの種類。例えば、インスタンスが生成したイベントの通知を受ける場合は、このパラメータを `db-instance` に設定します。この値を指定しない場合、すべてのイベントが返されます。 有効な値:`db-instance`、`db-cluster`、`db-parameter-group`、`db-security-group`、`db-cluster-snapshot` タイプ: 文字列 必須: いいえ **Tags.Tag.N** イベントサブスクリプションに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** EventSubscription ** サブスクライブしたイベントの詳細情報。 型: [EventSubscription](API_EventSubscription.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** EventSubscriptionQuotaExceeded ** イベントサブスクリプション数が最大に達しました。 HTTP ステータスコード: 400 ** SNSInvalidTopic ** Amazon SNS は、指定されたトピックに問題があると回答しました。 HTTP ステータスコード: 400 ** SNSNoAuthorization ** SNS トピックの Amazon リソースネーム (ARN) に発行する権限がありません。 HTTP ステータスコード: 400 ** SNSTopicArnNotFound ** SNS トピックの Amazon リソースネーム (ARN) が存在しません。 HTTP ステータスコード: 404 ** SourceNotFound ** リクエストされたリソースが見つかりませんでした。 HTTP ステータスコード: 404 ** SubscriptionAlreadyExist ** 指定されたサブスクリプション名はすでに存在します。 HTTP ステータスコード: 400 ** SubscriptionCategoryNotFound ** 指定されたカテゴリは存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) # CreateGlobalCluster 複数の AWS リージョンにまたがることができる Amazon DocumentDB グローバルクラスターを作成します。グローバルクラスターには、1 つの読み取り/書き込み機能を備えたプライマリクラスターと、最大 10 個の読み取り専用のセカンダリクラスターが含まれます。グローバルクラスターは、ワークロードのパフォーマンスに影響を与えることなく、専用のインフラストラクチャを使用して、1 秒未満のレイテンシーでリージョンにわたってストレージベースの高速レプリケーションを使用します。 最初は空のグローバルクラスターを作成し、そこにプライマリとセカンダリを追加できます。または、作成操作中に既存のクラスターを指定し、そのクラスターをグローバルクラスターのプライマリにすることもできます。 **注記** このアクションは Amazon DocumentDB クラスターにのみ適用されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** GlobalClusterIdentifier ** 新しいグローバルクラスターのクラスター識別子。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ** DatabaseName ** データベースの名前を、英数字 64 文字以内で入力します。名前を入力しない場合は、Amazon DocumentDB は作成するグローバルクラスター上にデータベースを作成しません。 タイプ: 文字列 必須: いいえ ** DeletionProtection ** 新しいグローバルクラスターの削除保護設定。削除保護が有効な場合、グローバルクラスターは削除できません。 タイプ: ブール値 必須: いいえ ** Engine ** このクラスターに使用されるデータベースエンジン名。 タイプ: 文字列 必須: いいえ ** EngineVersion ** グローバルクラスターのエンジンバージョン。 タイプ: 文字列 必須: いいえ ** SourceDBClusterIdentifier ** グローバルクラスターのプライマリクラスターとして使用する Amazon リソースネーム (ARN)。このパラメータはオプションです。 タイプ: 文字列 必須: いいえ ** StorageEncrypted ** 新しいグローバルクラスターのストレージ暗号化設定。 タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** GlobalClusterAlreadyExistsFault ** `GlobalClusterIdentifier` は既に存在します。新しいグローバルクラスター識別子 (一意の名前) を選択して、新しいグローバルクラスターを作成します。 HTTP ステータスコード: 400 ** GlobalClusterQuotaExceededFault ** このアカウントのグローバルクラスター数は、すでに許容最大数に達しています。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) # DeleteDBCluster 以前にプロビジョニングされたクラスターを削除します。クラスターを削除すると、そのクラスターの自動バックアップはすべて削除され、復旧できません。指定したクラスターの手動 DB クラスタースナップショットは削除されません。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** 削除するクラスターのクラスター識別子。このパラメータでは大文字と小文字は区別されません。 制約: + 既存の `DBClusterIdentifier` と一致する必要があります。 タイプ: 文字列 必須: はい ** FinalDBSnapshotIdentifier ** `SkipFinalSnapshot` が `false` に設定された場合の、作成された新しいクラスタースナップショットのクラスタースナップショット識別子。 このパラメータを指定して `SkipFinalShapshot` パラメータを `true` に設定すると、エラーが発生します。 制約: + 1 ～ 255 の英字、数字、ハイフンである必要があります。 + 最初の文字は文字にする必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 タイプ: 文字列 必須: いいえ ** SkipFinalSnapshot ** クラスターの削除前に最終のクラスタースナップショットを作成するかどうかを指定します。`true` を指定した場合、クラスタースナップショットが作成されます。`false` を指定した場合、DB クラスターの削除前にクラスタースナップショットが作成されます。 `SkipFinalSnapshot` が `false` の場合は、`FinalDBSnapshotIdentifier` パラメータを指定する必要があります。 デフォルト: `false` タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBClusterSnapshotAlreadyExistsFault ** 指定された識別子を持つクラスタースナップショットをすでに持っています。 HTTP ステータスコード: 400 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** SnapshotQuotaExceeded ** リクエストにより、スナップショットの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) # DeleteDBClusterParameterGroup 指定されたクラスターパラメータグループを削除します。削除するクラスターパラメータグループは、どのクラスターにも関連付けることができません。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** クラスターパラメータグループの名前。 制約: + 既存のクラスターパラメータグループ名にする必要があります。 + デフォルトのクラスターパラメータグループは削除できません。 + どのクラスターにも関連付けることができません。 タイプ: 文字列 必須: はい ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** InvalidDBParameterGroupState ** パラメータグループが使用中であるか、無効な状態です。パラメータグループを削除しようとする場合、パラメータグループがこの状態のときは削除できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) # DeleteDBClusterSnapshot クラスタースナップショットを削除します。スナップショットがコピーされている場合、コピー操作は終了します。 **注記** クラスタースナップショットを削除するには `available` の状態にする必要があります。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterSnapshotIdentifier ** 削除するクラスタースナップショットの識別子。 制約: `available` の状態にある既存のクラスタースナップショット名にする必要があります。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterSnapshot ** クラスタースナップショットに関する詳細情報。 型: [DBClusterSnapshot](API_DBClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) # DeleteDBInstance 以前にプロビジョニングされたインスタンスを削除します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBInstanceIdentifier ** 削除するインスタンスのインスタンス識別子。このパラメータでは大文字と小文字は区別されません。 制約: + 既存のインスタンス名と一致する必要があります。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBInstance ** インスタンスに関する詳細情報。 型: [DBInstance](API_DBInstance.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBInstanceNotFound ** `DBInstanceIdentifier` が既存の DB インスタンスを参照していません。 HTTP ステータスコード: 404 ** DBSnapshotAlreadyExists ** `DBSnapshotIdentifier` は既存のスナップショットですでに使用されています。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ** SnapshotQuotaExceeded ** リクエストにより、スナップショットの許容数を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) # DeleteDBSubnetGroup サブネットグループを削除します。 **注記** 指定されたデータベースサブネットグループは、どの DB インスタンスにも関連付けないでください。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBSubnetGroupName ** 削除するデータベースサブネットグループの名前。 デフォルトのサブネットグループを削除することはできません。 制約: 既存の `DBSubnetGroup` の名前と一致する必要があります。デフォルト値を使用することはできません。 例: `mySubnetgroup` タイプ: 文字列 必須: はい ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** InvalidDBSubnetGroupStateFault ** サブネットグループは使用中のため削除できません。 HTTP ステータスコード: 400 ** InvalidDBSubnetStateFault ** サブネットは *利用可能な* 状態にありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) # DeleteEventSubscription Amazon DocumentDB イベント通知サブスクリプション削除します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SubscriptionName ** 削除する Amazon DocumentDB イベント通知サブスクリプションの名前。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** EventSubscription ** サブスクライブしたイベントの詳細情報。 型: [EventSubscription](API_EventSubscription.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InvalidEventSubscriptionState ** 他の誰かがサブスクリプションを変更している可能性があります。数秒後に再度お試しください。 HTTP ステータスコード: 400 ** SubscriptionNotFound ** サブスクリプション名が存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) # DeleteGlobalCluster グローバルクラスターを削除します。グローバルクラスターを削除する前に、プライマリクラスタとセカンダリクラスタがすでにデタッチまたは削除されている必要があります。 **注記** このアクションは Amazon DocumentDB クラスターにのみ適用されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** GlobalClusterIdentifier ** 削除されるグローバルクラスターのクラスター識別子。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) # DescribeCertificates この AWS アカウントに対して Amazon DocumentDB から提供された認証局 (CA) 証明書のリストを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** CertificateIdentifier ** ユーザーが指定する証明書識別子。このパラメータを指定した場合、指定された証明書のみに関する情報を返します。このパラメータを省略すると、最大 `MaxRecords` の証明書のリストが返されます。このパラメータは大文字と小文字が区別されません。 制約 + 既存の `CertificateIdentifier` と一致する必要があります。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前の `DescribeCertificates` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、マーカーと呼ばれるページ割りトークンがレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: + 最小: 20 + 最大: 100 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **Certificates.Certificate.N** この AWS アカウントに関する証明書のリスト。 型: [Certificate](API_Certificate.md) オブジェクトの配列 ** Marker ** 取得されたレコード数が `MaxRecords` より大きい場合に提供されるオプションのページ割りトークン。このパラメータを指定した場合、マーカーはリスト内の次のレコードを指定します。`Marker` の値を次の `DescribeCertificates` への呼び出しに含めると、証明書の次のページに表示されます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** CertificateNotFound ** `CertificateIdentifier` は既存の証明書を参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) # DescribeDBClusterParameterGroups `DBClusterParameterGroup` の説明のリストを返します。`DBClusterParameterGroupName` パラメータを指定した場合、リストには指定した DB クラスターパラメータグループの説明のみが含まれます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** 詳細を返す特定のクラスターパラメータグループ名。 制約: + 指定した場合、既存の `DBClusterParameterGroup` の名前と一致する必要があります。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBClusterParameterGroups.DBClusterParameterGroup.N** クラスターパラメータグループのリスト。 型: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) # DescribeDBClusterParameters 特定のクラスターパラメータグループの詳細なパラメータリストを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** パラメータの詳細を返す特定のクラスターパラメータグループ名。 制約: + 指定した場合、既存の `DBClusterParameterGroup` の名前と一致する必要があります。 タイプ: 文字列 必須: はい **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** Source ** 特定のソースのパラメータのみを返すことを示す値。パラメータのソースは `engine`、`service`、または `customer` のいずれかとすることができます。 タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 **Parameters.Parameter.N** クラスターパラメータグループのパラメータのリストを提供します。 型: [Parameter](API_Parameter.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) # DescribeDBClusters プロビジョニングされた Amazon DocumentDB クラスターに関する情報を返します。この API 操作はページ分割に対応しています。クラスターやインスタンスのライフサイクル管理などの特定の管理機能において、Amazon DocumentDB は Amazon RDS や Amazon Neptune と共有される運用テクノロジーを使用します。Amazon DocumentDB クラスターのみを返すには、`filterName=engine,Values=docdb` フィルターパラメータを使用します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** ユーザーが指定したクラスター識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。 制約: + 指定した場合、既存の `DBClusterIdentifier` と一致する必要があります。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** 記述する 1 つ以上のクラスターを指定するフィルター。 サポートされているフィルター: + `db-cluster-id` - クラスター識別子とクラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関する情報のみが含まれます。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBClusters.DBCluster.N** クラスターのリスト。 型: [DBCluster](API_DBCluster.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) # DescribeDBClusterSnapshotAttributes 手動の DB クラスタースナップショットのクラスタースナップショット属性名と値のリストを返します。 スナップショットを他の と共有する場合 AWS アカウント、 は、手動クラスタースナップショットのコピーまたは復元 AWS アカウント が許可されている の `restore` 属性と IDs のリスト`DescribeDBClusterSnapshotAttributes`を返します。`all` が `restore` 属性の値のリストに含まれている場合、手動クラスタースナップショットは公開されており、すべての AWS アカウントによってコピーまたは復元できます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterSnapshotIdentifier ** 属性を記述するクラスタースナップショット識別子。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterSnapshotAttributesResult ** クラスタースナップショットに関連付けられている属性の詳細情報。 型: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) # DescribeDBClusterSnapshots クラスタースナップショットに関する情報を返します。この API 操作はページ分割に対応しています。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** クラスタースナップショットのリストを取得する DB クラスターの ID。このパラメータは、`DBClusterSnapshotIdentifier` パラメータと併用できません。このパラメータは大文字と小文字が区別されません。 制約: + 指定した場合、既存の `DBCluster` の識別子と一致する必要があります。 タイプ: 文字列 必須: いいえ ** DBClusterSnapshotIdentifier ** 記述する特定のクラスタースナップショット識別子。このパラメータは、`DBClusterIdentifier` パラメータと併用できません。この値は小文字で保存されます。 制約: + 指定した場合、既存の `DBClusterSnapshot` の識別子と一致する必要があります。 + この識別子が自動スナップショット用の場合、`SnapshotType` パラメータも指定する必要があります。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** IncludePublic ** を に設定`true`して、パブリックで、任意の によってコピーまたは復元できる手動クラスタースナップショットを含め AWS アカウント、それ以外の場合は を含めます`false`。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ ** IncludeShared ** に設定`true`して、コピーまたは復元するアクセス許可 AWS アカウント が付与 AWS アカウント されている他の からの共有手動クラスタースナップショットを含め、それ以外の場合は を含めます`false`。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** SnapshotType ** 返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。 + `automated` - Amazon DocumentDB が AWS アカウントに対して自動作成したクラスタースナップショットをすべて返します。 + `manual` - AWS アカウントのために手動作成したクラスタースナップショットをすべて返します。 + `shared` - AWS アカウントに共有される手動クラスタースナップショットをすべて返します。 + `public` - 公開とマークされたクラスタースナップショットをすべて返します。 `SnapshotType` の値を指定しない場合、自動と手動の両方のクラスタースナップショットを返します。`IncludeShared` パラメータを `true` に設定すると、これらの結果に公開クラスタースナップショットを含めることができます。`IncludePublic` パラメータを `true` に設定すると、これらの結果に公開クラスタースナップショットを含めることができます。 `IncludeShared` および `IncludePublic` パラメータは、`manual` または `automated` の `SnapshotType` 値には適用されません。`SnapshotType` が `shared` に設定されている場合、`IncludePublic` パラメータは適用されません。`SnapshotType` が `public` に設定されている場合、`IncludeShared` パラメータは適用されません。 タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBClusterSnapshots.DBClusterSnapshot.N** ユーザーのクラスタースナップショットのリストを提供します。 型: [DBClusterSnapshot](API_DBClusterSnapshot.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) # DescribeDBEngineVersions 利用可能なエンジンのリストを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBParameterGroupFamily ** 詳細を返す特定のパラメータグループファミリー名。 制約: + 指定した場合、既存の `DBParameterGroupFamily` と一致する必要があります。 タイプ: 文字列 必須: いいえ ** DefaultOnly ** 指定されたエンジンまたはエンジンとメジャーバージョンの組み合わせのデフォルトバージョンのみが返されることを示します。 タイプ: ブール値 必須: いいえ ** Engine ** 返されるデータベースエンジン。 タイプ: 文字列 必須: いいえ ** EngineVersion ** 返されるデータベースエンジンのバージョン。 例: `3.6.0` タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** ListSupportedCharacterSets ** このパラメータが指定され、要求されたエンジンが `CreateDBInstance` に対して `CharacterSetName` パラメータをサポートしている場合、レスポンスには各エンジンバージョンでサポートされている文字セットのリストが含まれます。 タイプ: ブール値 必須: いいえ ** ListSupportedTimezones ** このパラメータが指定され、要求されたエンジンが `CreateDBInstance` に対して `TimeZone` パラメータをサポートしている場合、レスポンスには各エンジンバージョンでサポートされているタイムゾーンのリストが含まれます。 タイプ: ブール値 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBEngineVersions.DBEngineVersion.N** 1 つ以上のエンジンのバージョンに関する詳細情報。 型: [DBEngineVersion](API_DBEngineVersion.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) # DescribeDBInstances プロビジョニングされた Amazon DocumentDB インスタンスに関する情報を返します。この API はページ分割をサポートします。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBInstanceIdentifier ** ユーザーが指定したインスタンス識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。 制約: + 指定した場合、既存の `DBInstance` の識別子と一致する必要があります。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** 記述する 1 つ以上のインスタンスを指定するフィルター。 サポートされているフィルター: + `db-cluster-id` - クラスター識別子とクラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関連付けられたインスタンスに関する情報のみが含まれます。 + `db-instance-id` - インスタンス識別子とインスタンス ARN を受け入れます。結果リストには、これらの ARN で識別されるインスタンスに関する情報のみが含まれます。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBInstances.DBInstance.N** 1 つ以上のインスタンスに関する詳細情報。 型: [DBInstance](API_DBInstance.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBInstanceNotFound ** `DBInstanceIdentifier` が既存の DB インスタンスを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) # DescribeDBSubnetGroups `DBSubnetGroup` の説明のリストを返します。`DBSubnetGroupName` を指定した場合、リストには指定した `DBSubnetGroup` 説明のみが含まれます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBSubnetGroupName ** 詳細を返すサブネットグループ名。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **DBSubnetGroups.DBSubnetGroup.N** 1 つ以上のサブネットグループに関する詳細情報。 型: [DBSubnetGroup](API_DBSubnetGroup.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) # DescribeEngineDefaultClusterParameters クラスターのデータベースエンジンのデフォルトのエンジンおよびシステムパラメータ情報を返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBParameterGroupFamily ** エンジンパラメータ情報を返すクラスターパラメータグループファミリー名。 タイプ: 文字列 必須: はい **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** EngineDefaults ** `DescribeEngineDefaultClusterParameters` アクションの呼び出しが成功した結果が含まれています。 型: [EngineDefaults](API_EngineDefaults.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) # DescribeEventCategories すべてのイベントソースタイプか、指定されている場合は、指定されたソースタイプのイベントカテゴリのリストを表示します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** SourceType ** イベントを生成しているソースの種類。 有効な値: `db-instance`、`db-parameter-group`、`db-security-group` タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **EventCategoriesMapList.EventCategoriesMap.N** イベントカテゴリマップのリスト。 型: [EventCategoriesMap](API_EventCategoriesMap.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) # DescribeEvents インスタンス、セキュリティグループ、スナップショット、DB パラメータグループに関連する過去 14 日間のイベントを返します。特定の DB インスタンス、セキュリティグループ、データベーススナップショット、またはパラメータグループに固有のイベントは、名前をパラメータとして指定して取得します。デフォルトでは、過去 1 時間のイベントを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** Duration ** イベントを取得するための分数。 デフォルト: 60 タイプ: 整数 必須: いいえ ** EndTime ** ISO 8601 形式で指定された、イベントを取得する時間間隔の終了時刻。 例: 2009-07-08T18:00Z 型: タイムスタンプ 必須: いいえ **EventCategories.EventCategory.N** イベント通知サブスクリプションの通知をトリガーするイベントカテゴリのリスト。 型: 文字列の配列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** SourceIdentifier ** イベントが返されるイベントソースの識別子。指定しない場合は、すべてのソースはレスポンスに含まれます。 制約: + `SourceIdentifier` を指定した場合、`SourceType` も指定する必要があります。 + ソースタイプが `DBInstance` である場合は、`DBInstanceIdentifier` を指定する必要があります。 + ソースタイプが `DBSecurityGroup` である場合は、`DBSecurityGroupName` を指定する必要があります。 + ソースタイプが `DBParameterGroup` である場合は、`DBParameterGroupName` を指定する必要があります。 + ソースタイプが `DBSnapshot` である場合は、`DBSnapshotIdentifier` を指定する必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 タイプ: 文字列 必須: いいえ ** SourceType ** イベントソースのイベントを取得します。値を指定しない場合、すべてのイベントが返されます。 型: 文字列 有効な値：`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` 必須：いいえ ** StartTime ** ISO 8601 形式で指定された、イベントを取得する時間間隔の開始時刻。 例: 2009-07-08T18:00Z 型: タイムスタンプ 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **Events.Event.N** 1 つ以上のイベントに関する詳細情報。 型: [Event](API_Event.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) # DescribeEventSubscriptions 顧客アカウントのサブスクリプションの説明をすべて表示します。サブスクリプションの説明には、`SubscriptionName`、`SNSTopicARN`、`CustomerID`、`SourceType`、`SourceID`、`CreationTime`、`Status` が含まれます。 `SubscriptionName` を指定すると、そのサブスクリプションの説明をリストアップします。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** SubscriptionName ** 記述する Amazon DocumentDB イベント通知サブスクリプション名。 タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **EventSubscriptionsList.EventSubscription.N** イベントサブスクリプションのリスト。 型: [EventSubscription](API_EventSubscription.md) オブジェクトの配列 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** SubscriptionNotFound ** サブスクリプション名が存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) # DescribeGlobalClusters Amazon DocumentDB グローバルクラスターに関する情報を返します。この API はページ分割をサポートします。 **注記** このアクションは Amazon DocumentDB クラスターにのみ適用されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Filters.Filter.N** 記述する 1 つ以上の DB クラスターを指定するフィルター。 対応するフィルター: `db-cluster-id` は、クラスター識別子とクラスター Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターに関連付けられたインスタンスに関する情報のみが含まれます。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** GlobalClusterIdentifier ** ユーザーが指定した DB クラスター識別子。このパラメータを指定した場合、特定のクラスターからの情報のみを返します。このパラメータでは大文字と小文字は区別されません。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: いいえ ** Marker ** 以前の `DescribeGlobalClusters` リクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、残りの結果を取得できるように、マーカーと呼ばれるページ割りトークンがレスポンスに含まれます。 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **GlobalClusters.GlobalClusterMember.N** 型: [GlobalCluster](API_GlobalCluster.md) オブジェクトの配列 ** Marker ** タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) # DescribeOrderableDBInstanceOptions 指定されたエンジンの指示可能なインスタンスオプションのリストを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** Engine ** インスタンスオプションを取得するエンジン名。 タイプ: 文字列 必須: はい ** DBInstanceClass ** The instance class filter value。このパラメータを指定すると、指定したインスタンスクラスに一致する利用可能なオファリングみが表示されます。 タイプ: 文字列 必須: いいえ ** EngineVersion ** エンジンバージョンフィルターの値。このパラメータを指定すると、指定したエンジンのバージョンに一致する利用可能なオファリングみが表示されます。 タイプ: 文字列 必須: いいえ **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** LicenseModel ** ライセンスモデルフィルター値。このパラメータを指定すると、指定したエンジンのバージョンに一致する利用可能なライセンスモデルのみが表示されます。 タイプ: 文字列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** Vpc ** 仮想プライベートクラウド (VPC) フィルター値。このパラメータを指定すると、 VPC 環境または非 VPC 環境のみが表示されます。 タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 **OrderableDBInstanceOptions.OrderableDBInstanceOption.N** 特定の指示可能なインスタンスで使用できるオプション。 型: [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) # DescribePendingMaintenanceActions 1 つ以上の保留中のメンテナンスアクションを含むリソース (例: インスタンス) のリストを返します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 **Filters.Filter.N** 保留中のメンテナンスアクションを返す 1 つ以上のリソースを指定するフィルター。 サポートされているフィルター: + `db-cluster-id` - クラスター識別子とクラスターの Amazon リソースネーム (ARN) を受け入れます。結果リストには、これらの ARN で識別されるクラスターの保留中のメンテナンスアクションのみが含まれます。 + `db-instance-id` - インスタンス識別子とインスタンス ARN を受け入れます。結果リストには、これらの ARN で識別されるクラスターの保留中のメンテナンスアクションのみが含まれます。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 必須: いいえ ** MaxRecords ** レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 デフォルト: 100 制約: 最小 20、最大 100。 タイプ: 整数 必須: いいえ ** ResourceIdentifier ** 保留中のメンテナンスアクションを返すリソースの ARN。 タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** Marker ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 **PendingMaintenanceActions.ResourcePendingMaintenanceActions.N** 適用されるメンテナンスアクション。 型: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** ResourceNotFoundFault ** 指定されたリソース ID は見つかりませんでした。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) # FailoverDBCluster クラスターのフェイルオーバーを強制実行します。 クラスターのフェイルオーバーにより、クラスター内のAmazon DocumentDB レプリカ （読み取り専用インスタンス) の1つをプライマリインスタンス（クラスターライター）に昇格されます。 プライマリインスタンスに障害が発生した場合、Amazon DocumentDB レプリカが存在すると、自動的にフェイルオーバーします。テストのため、プライマリインスタンスの失敗をシミュレートする場合は、フェイルオーバーを強制できます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** フェイルオーバーを強制するクラスター識別子。このパラメータは大文字と小文字が区別されません。 制約: + 既存の `DBCluster` の識別子と一致する必要があります。 タイプ: 文字列 必須: いいえ ** TargetDBInstanceIdentifier ** プライマリインスタンスに昇格するインスタンスの名前。 クラスター内のAmazon DocumentDB レプリカのインスタンス識別子を指定する必要があります。例えば、`mydbcluster-replica1`。 型: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) # FailoverGlobalCluster グローバルクラスターにフェイルオーバーが発生したときに、指定されたセカンダリ DB クラスターをそのグローバルクラスターのプライマリ DB クラスターに昇格させます。 このオペレーションにより、プライマリリージョンの地域的な災害などの計画外の事象に対応します。どちらのフェイルオーバー方法でも、フェイルオーバーイベントが発生する前に選択したセカンダリにレプリケートされていなかった書き込みトランザクションデータは失われる可能性があります。ただし、選択したセカンダリ DB クラスター上の DB インスタンスをプライマリライター DB インスタンスに昇格させるリカバリプロセスにより、データがトランザクション的に一貫した状態になることが保証されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** GlobalClusterIdentifier ** このオペレーションを適用する Amazon DocumentDB グローバルクラスターの識別子。識別子は、クラスターの作成時にユーザーによって割り当てられる一意のキーです。つまり、グローバルクラスターの名前です。 制約: + 既存のグローバルクラスターの識別子と一致する必要があります。 + 最小長は 1 です｡ 最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ** TargetDbClusterIdentifier ** そのグローバルクラスターのプライマリに昇格させるセカンダリ Amazon DocumentDB クラスターの識別子。Amazon DocumentDB が AWS リージョン内のクラスターを見つけることができるように、識別子に Amazon リソースネーム (ARN) を使用します。 制約: + 既存のセカンダリクラスターの識別子と一致する必要があります。 + 最小長は 1 です｡ 最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ** AllowDataLoss ** このグローバルクラスターオペレーションのデータロスを許可するかどうかを指定します。データロスを許可すると、グローバルフェイルオーバーオペレーションがトリガーされます。 `AllowDataLoss` を指定しない場合、グローバルクラスターオペレーションはデフォルトでスイッチオーバーになります。 制約: + `Switchover` パラメータと一緒に指定することはできません。 タイプ: ブール値 必須: いいえ ** Switchover ** このグローバルデータベースクラスターをスイッチオーバーするかどうかを指定します。 制約: + `AllowDataLoss` パラメータと一緒に指定することはできません。 タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) # ListTagsForResource Amazon DocumentDB リソースのすべてのタグを一覧表示します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** ResourceName ** 一覧されるタグを持つ Amazon DocumentDB リソース。この値は Amazon リソースネーム (ARN) です。 タイプ: 文字列 必須: はい **Filters.Filter.N** このパラメータは、現在サポートされていません。 タイプ: [Filter](API_Filter.md) オブジェクトの配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 **TagList.Tag.N** 1 つ以上のタグのリスト。 型: [Tag](API_Tag.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBInstanceNotFound ** `DBInstanceIdentifier` は既存のインスタンスを参照していません。 HTTP ステータスコード: 404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` は既存のスナップショットを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) # ModifyDBCluster Amazon DocumentDB クラスターの設定を変更します。これらのパラメータとリクエストに新しい値を指定することで、1 つ以上のデータベース設定パラメータを変更できます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** 変更するクラスターのクラスター識別子。このパラメータは大文字と小文字が区別されません。 制約: + 既存の `DBCluster` の識別子と一致する必要があります。 タイプ: 文字列 必須: はい ** AllowMajorVersionUpgrade ** メジャーバージョンアップグレードを許可するかどうかを示す値。 制約: + クラスターの現在のバージョンとは異なるメジャーバージョンである `EngineVersion` パラメータの値を指定する場合は、メジャーバージョンアップグレードを許可する必要があります。 + 一部のパラメータはバージョン固有であるため、変更するには、インプレース MVU の完了後に新しい `ModifyDBCluster` API コールを実行する必要があります。 MVU を実行すると、次のパラメータに直接影響します。 + `MasterUserPassword` + `NewDBClusterIdentifier` + `VpcSecurityGroupIds` + `Port` タイプ: ブール値 必須: いいえ ** ApplyImmediately ** クラスターの `PreferredMaintenanceWindow` の設定に関係なく、このリクエストの変更と保留中の変更をできるだけ早く非同期に適用するかどうかを指定する値。このパラメータを `false` に設定した場合、クラスターへの変更は次のメンテナンスウィンドウ中に適用されます。 `ApplyImmediately` パラメータは、`NewDBClusterIdentifier` 値と `MasterUserPassword` 値のみに影響します。このパラメータ値を `false` に設定すると、`NewDBClusterIdentifier` 値と `MasterUserPassword` 値への変更は次のメンテナンスウィンドウ中に適用されます。他のすべての変更は、`ApplyImmediately` パラメータの値に関係なく、即時に適用されます。 デフォルト: `false` タイプ: ブール値 必須: いいえ ** BackupRetentionPeriod ** 自動バックアップを保管する日数。最小値 1 を指定しなければなりません。 デフォルト: 1 制約: + 1 ～ 35 の値にする必要があります。 タイプ: 整数 必須: いいえ ** CloudwatchLogsExportConfiguration ** 特定のインスタンスまたはクラスターについて、Amazon CloudWatch Logs へのエクスポートを有効にするためのログタイプの設定。`EnableLogTypes` および `DisableLogTypes` の配列では、CloudWatch Logs にエクスポートする (または、エクスポートしない) ログを決定します。 型: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) オブジェクト 必須: いいえ ** DBClusterParameterGroupName ** クラスターに使用するクラスターパラメータグループの名前。 タイプ: 文字列 必須: いいえ ** DeletionProtection ** このクラスターを削除できるかどうかを指定します。`DeletionProtection` を有効にすると、クラスターが変更され `DeletionProtection` が無効にならない限り、クラスターを削除することができません。`DeletionProtection` はクラスターが誤って削除されるのを防ぎます。 タイプ: ブール値 必須: いいえ ** EngineVersion ** アップグレードするデータベースエンジンのバージョン番号。このパラメータを変更すると、機能停止が発生します。`ApplyImmediately` パラメータが true に設定されされない限り、変更は次のメンテナンスウィンドウ中に適用されます。 Amazon DocumentDB に利用可能なエンジンバージョンをすべて一覧表示するには、次のコマンドを使用します。 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"` タイプ: 文字列 必須: いいえ ** ManageMasterUserPassword ** Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理するかどうかを指定します。クラスターが Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理していない場合は、この管理をオンにできます。この場合、`MasterUserPassword` を指定することができます。クラスターが Amazon Web Services Secrets Manager でマスターユーザーパスワードを既に管理しており、マスターユーザーパスワードが Amazon Web Services Secrets Manager で管理されないように指定している場合は、`MasterUserPassword` を指定する必要があります。この場合、Amazon DocumentDB はシークレットを削除し、`MasterUserPassword` で指定されたマスターユーザーの新しいパスワードを使用します。 タイプ: ブール値 必須: いいえ ** MasterUserPassword ** マスターデータベースユーザーのパスワードです。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。 制約: 8 ～ 100 文字の長さの英数字である必要があります。 タイプ: 文字列 必須: いいえ ** MasterUserSecretKmsKeyId ** Amazon Web Services Secrets Manager で自動的に生成および管理されるシークレットを暗号化するための Amazon Web Services KMS キー識別子。 この設定は、次の条件の両方が満たされている場合にのみ有効です。 + クラスターは、Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理しません。クラスターが Amazon Web Services Secrets Manager でマスターユーザーパスワードを既に管理している場合、シークレットの暗号化に使用される KMS キーを変更することはできません。 + `ManageMasterUserPassword` が Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理できるようにします。`ManageMasterUserPassword` をオンにして `MasterUserSecretKmsKeyId` を指定しない場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化します。シークレットが別の Amazon Web Services アカウントにある場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化することはできません。カスタマー管理の KMS キーを使用する必要があります。 Amazon Web Services KMS キー識別子は、KMS キーのキー ARN、キー ID、エイリアス ARN、またはエイリアス名です。別の Amazon Web Services アカウントで KMS キーを使用するには、キー ARN またはエイリアス ARN を指定します。 Amazon Web Services アカウントにはデフォルトの KMS キーがあります。Amazon Web Services アカウントには Amazon Web Services リージョンごとに異なるデフォルトの KMS キーがあります。 タイプ: 文字列 必須: いいえ ** 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` タイプ: 文字列 必須: いいえ ** NewDBClusterIdentifier ** クラスターの名前を変更する場合のクラスターの新しいクラスター識別子。この値は小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-cluster2` タイプ: 文字列 必須: いいえ ** Port ** クラスターが接続を受け入れるポート番号。 制限: `1150` ～ `65535` の値である必要があります。 デフォルト : 元のクラスターと同じポート。 タイプ: 整数 必須: いいえ ** PreferredBackupWindow ** `BackupRetentionPeriod` パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。 デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。 制約: + `hh24:mi-hh24:mi` の形式である必要があります。 + 時間は協定世界時 (UTC) である必要があります。 + 必要なメンテナンス期間と競合してはいけません。 + 少なくとも 30 分以上必要です。 タイプ: 文字列 必須: いいえ ** PreferredMaintenanceWindow ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 形式: `ddd:hh24:mi-ddd:hh24:mi` デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウであり AWS リージョン、ランダムな曜日に発生します。 有効な曜日: 月、火、水、木、金、土、日 制約: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** RotateMasterUserPassword ** Amazon Web Services Secrets Manager によって管理されるマスターユーザーパスワードのシークレットをローテーションするかどうかを指定します。 この設定は、マスターユーザーパスワードがクラスターの Amazon Web Services Secrets Manager で Amazon DocumentDB によって管理されている場合にのみ有効です。シークレット値には、更新されたパスワードが含まれています。 制約: マスターユーザーのパスワードをローテーションするときは、すぐに変更を適用する必要があります。 タイプ: ブール値 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。 型: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) オブジェクト 必須: いいえ ** StorageType ** DB クラスターに関連付けるストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です タイプ: 文字列 必須: いいえ **VpcSecurityGroupIds.VpcSecurityGroupId.N** クラスターに関連付けられる仮想プライベートクラウド （VPC） セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterAlreadyExistsFault ** 指定された識別子を持つクラスターをすでに持っています。 HTTP ステータスコード: 400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBClusterParameterGroupNotFound ** `DBClusterParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBSecurityGroupState ** セキュリティグループの状態では削除できません。 HTTP ステータスコード: 400 ** InvalidDBSubnetGroupStateFault ** サブネットグループは使用中のため削除できません。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** NetworkTypeNotSupported ** ネットワークタイプは、`DBSubnetGroup` または DB エンジンのバージョンではサポートされていません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) # ModifyDBClusterParameterGroup クラスターパラメータグループのパラメータを変更します。複数のパラメータを変更するには、以下のリストを送信します: `ParameterName`、`ParameterValue`、`ApplyMethod`。最大 20 個のパラメータを単一のリクエストで修正できます。 **注記** 動的パラメータの変更は直ちに適用されます。静的パラメータの変更の場合、変更を反映させる前に再起動またはメンテナンスウィンドウが必要です。 **重要** クラスターパラメータグループの作成後、デフォルトのパラメータグループとしてそのクラスターパラメータグループを使用する最初のクラスターが作成されるまで、5 分以上かかります。その間に、Amazon DocumentDB が作成アクションを完了させ、パラメータグループが新しいクラスターのデフォルトとして使用されます。このステップは、クラスターのデフォルトデータベースの作成時に必須になるパラメータ (`character_set_database` パラメータにより定義されるデフォルトデータベースの文字セットなど) に特に重要です。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** 変更するクラスターパラメータグループの名前。 タイプ: 文字列 必須: はい **Parameters.Parameter.N** 変更するクラスターパラメータグループ内のパラメータのリスト。 型: [Parameter](API_Parameter.md) オブジェクトの配列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterParameterGroupName ** クラスターパラメータグループの名前。 制約: + 1 ～ 255 の英数字である必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 この値は小文字で保存されます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** InvalidDBParameterGroupState ** パラメータグループが使用中であるか、無効な状態です。パラメータグループを削除しようとする場合、パラメータグループがこの状態のときは削除できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) # ModifyDBClusterSnapshotAttribute 属性および値を、手動クラスタースナップショットに追加するか、削除します。 手動クラスタースナップショットを他の と共有するには AWS アカウント、 `restore`として を指定し`AttributeName`、 `ValuesToAdd`パラメータを使用して、手動クラスタースナップショットの復元 AWS アカウント が許可されている の IDs のリストを追加します。値 `all` を使用して、手動クラスタースナップショットを公開します。これは、すべての AWS アカウントによってコピーまたは復元できることを意味します。すべての `all` に利用させたくないプライベート情報を含む手動クラスタースナップショットの AWS アカウント値は追加しません。手動クラスタースナップショットが暗号化されている場合は、 `ValuesToAdd`パラメータの AWS アカウント IDsのリストを指定することによってのみ共有できます。この場合、そのパラメータの値として `all` を使用することはできません。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** AttributeName ** 変更するクラスタースナップショット属性名。 手動クラスタースナップショットをコピーまたは復元 AWS アカウント する他のユーザーの認可を管理するには、この値を に設定します`restore`。 タイプ: 文字列 必須: はい ** DBClusterSnapshotIdentifier ** 属性を変更するクラスタースナップショットの識別子。 タイプ: 文字列 必須: はい **ValuesToAdd.AttributeValue.N** `AttributeName` で指定された属性に追加するクラスタースナップショット属性のリスト。 手動クラスタースナップショットのコピーまたは復元 AWS アカウント を他のユーザーに許可するには、1 つ以上の AWS アカウント IDs を含めるようにこのリストを設定します。手動クラスタースナップショットを復元可能にするには AWS アカウント、 に設定します`all`。すべての `all` に利用させたくないプライベート情報を含む手動クラスタースナップショットの AWS アカウント値は追加しません。 型: 文字列の配列 必須: いいえ **ValuesToRemove.AttributeValue.N** `AttributeName` で指定された属性から削除するクラスタースナップショット属性のリスト。 手動クラスタースナップショットをコピーまたは復元 AWS アカウント する他のユーザーの認可を削除するには、1 つ以上の AWS アカウント 識別子を含めるようにこのリストを設定します。クラスタースナップショットをコピーまたは復元 AWS アカウント する の認可を削除するには、 に設定します`all`。を指定しても`all`、アカウント ID AWS アカウント が `restore` 属性に明示的に追加された は、手動クラスタースナップショットをコピーまたは復元できます。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterSnapshotAttributesResult ** クラスタースナップショットに関連付けられている属性の詳細情報。 型: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** SharedSnapshotQuotaExceeded ** 手動 DB スナップショットを共有できるアカウントの最大数を超えました。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) # ModifyDBInstance インスタンスの設定を変更します。これらのパラメータとリクエストに新しい値を指定することで、1 つ以上のデータベース設定パラメータを変更できます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBInstanceIdentifier ** インスタンス識別子。この値は小文字で保存されます。 制約: + 既存の `DBInstance` の識別子と一致する必要があります。 タイプ: 文字列 必須: はい ** ApplyImmediately ** インスタンスの `PreferredMaintenanceWindow` の設定に関係なく、このリクエストの変更と保留中の変更をできるだけ早く非同期に適用するかどうかを指定します。 このパラメータを `false` に設定した場合、クラスターへの変更は次のメンテナンスウィンドウ中に適用されます。パラメータの変更によっては、機能停止を引き起こす可能性があり、次回の再起動時に適用されます。 デフォルト: `false` タイプ: ブール値 必須: いいえ ** AutoMinorVersionUpgrade ** このパラメータは Amazon DocumentDB には適用されません。Amazon DocumentDB は、設定値に関係なく、マイナーバージョンのアップグレードを実行しません。 タイプ: ブール値 必須: いいえ ** CACertificateIdentifier ** インスタンスに関連付ける必要のある証明書を示します。 タイプ: 文字列 必須: いいえ ** CertificateRotationRestart ** SSL/TLS 証明書をローテーションするときに DB インスタンスが再起動されるかどうかを指定します。 デフォルトでは、SSL/TLS 証明書をローテーションすると DB インスタンスが再起動されます。DB インスタンスが再起動されるまで、証明書は更新されません。 DB インスタンスへの接続に SSL/TLS を使用しない場合のみ、このパラメータを設定します。 SSL/TLS を使用して 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)」を参照してください。 タイプ: ブール値 必須: いいえ ** CopyTagsToSnapshot ** すべてのタグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを示す値。デフォルトでは、タグはコピーされません。 タイプ: ブール値 必須: いいえ ** DBInstanceClass ** インスタンスの新しいコンピューティング能力とメモリ容量 (例: `db.r5.large` )。すべてのインスタンスクラスがすべての AWS リージョンで利用できるわけではありません。 インスタンスクラスを変更すると、変更中に機能停止が発生します。`ApplyImmediately` がこのリクエストの `true` として指定されない限り、変更は次のメンテナンスウィンドウ中に適用されます。 デフォルト: 既存の設定を仕様。 タイプ: 文字列 必須: いいえ ** EnablePerformanceInsights ** DB インスタンスで Performance Insights を有効にするかどうかを示す値。詳細については、「[Amazon Performance Insights の使用](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)」を参照してください。 タイプ: ブール値 必須: いいえ ** NewDBInstanceIdentifier ** インスタンス名を変更する場合のインスタンスの新しいインスタンス識別子。インスタンス識別子を変更し、`Apply Immediately` を `true` に設定するとインスタンスの再起動がすぐに実行されます。`Apply Immediately` を `false` に設定した場合、次のメンテナンスウィンドウ中に発生します。この値は小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `mydbinstance` タイプ: 文字列 必須: いいえ ** PerformanceInsightsKMSKeyId ** Performance Insights データを暗号化するための AWS KMS キー識別子。 AWS KMS キー識別子は、KMS キーのキー ARN、キー ID、エイリアス ARN、またはエイリアス名です。 PerformanceInsightsKMSKeyId に値を指定しない場合、Amazon DocumentDB はデフォルトの KMS キーを使用します。Amazon Web Services アカウントにはデフォルトの KMS キーがあります。Amazon Web Services アカウントには Amazon Web Services リージョンごとに異なるデフォルトの KMS キーがあります。 タイプ: 文字列 必須: いいえ ** PreferredMaintenanceWindow ** システムメンテナンスが発生する可能性がある週単位の時間範囲 (UTC) で、停止する可能性があります。次の場合を除き、このパラメータを変更しても機能停止にはならず、変更はできるだけ早く非同期的に適用されます。再起動を引き起こす保留中のアクションがあり、メンテナンスウィンドウが現在の時刻を含めて変更された場合、このパラメータを変更するとインスタンスが再起動されます。このウィンドウを現在の時刻に変更した場合、保留中の変更が確実に適用されるには、現在の時刻からウィンドウの終了まで 30 分以上必要です。 デフォルト: 既存の設定を使用。 形式: `ddd:hh24:mi-ddd:hh24:mi` 有効な曜日: 月、火、水、木、金、土、日 制約: 30 分以上にする必要があります。 タイプ: 文字列 必須: いいえ ** PromotionTier ** 既存のプライマリインスタンスの障害後に、Amazon DocumentDB レプリカがプライマリインスタンスに昇格する順序を指定する値。 デフォルト: 1 有効な値: 0 ～ 15 タイプ: 整数 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBInstance ** インスタンスに関する詳細情報。 型: [DBInstance](API_DBInstance.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AuthorizationNotFound ** 指定された CIDRIP または Amazon EC2 セキュリティグループは、指定されたセキュリティグループに対して権限がありません。 Amazon DocumentDB には、IAM を使用してお客様に代わって必要なアクションを実行する権限がない場合もあります。 HTTP ステータスコード: 404 ** CertificateNotFound ** `CertificateIdentifier` は既存の証明書を参照していません。 HTTP ステータスコード: 404 ** DBInstanceAlreadyExists ** 指定された識別子を持つインスタンスをすでに持っています。 HTTP ステータスコード: 400 ** DBInstanceNotFound ** `DBInstanceIdentifier` は既存のインスタンスを参照していません。 HTTP ステータスコード: 404 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** DBSecurityGroupNotFound ** `DBSecurityGroupName` は既存のセキュリティグループを参照していません。 HTTP ステータスコード: 404 ** DBUpgradeDependencyFailure ** 依存するリソースが変更できないため、アップグレードに失敗しました。 HTTP ステータスコード: 400 ** InsufficientDBInstanceCapacity ** 指定されたインスタンスクラスは、指定されたアベイラビリティーゾーンで利用できません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBSecurityGroupState ** セキュリティグループの状態では削除できません。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ** StorageTypeNotSupported ** 指定された `StorageType` のストレージはDBインスタンスに関連付けられません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) # ModifyDBSubnetGroup 既存サブネットグループを変更します。サブネットグループには、 AWS リージョン内の 2 つ以上のアベイラビリティゾーンに 1 つ以上のサブネットが含まれる必要があります。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBSubnetGroupName ** サブネットグループの名前。この値は小文字で保存されます。デフォルトのサブネットグループを変更することはできません。 制約: 既存の `DBSubnetGroup` の名前と一致する必要があります。デフォルト値を使用することはできません。 例: `mySubnetgroup` タイプ: 文字列 必須: はい **SubnetIds.SubnetIdentifier.N** サブネットグループの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: はい ** DBSubnetGroupDescription ** サブネットグループの説明。 タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBSubnetGroup ** サブネットグループに関する詳細情報。 型: [DBSubnetGroup](API_DBSubnetGroup.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBSubnetGroupDoesNotCoverEnoughAZs ** アベイラビリティーゾーンが 1 つしかない場合を除き、サブネットグループ内のサブネットは 2 つ以上のアベイラビリティゾーンをカバーする必要があります。 HTTP ステータスコード: 400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** DBSubnetQuotaExceededFault ** リクエストにより、サブネットグループのサブネットの許容数を超過します。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** SubnetAlreadyInUse ** サブネットはアベイラビリティーゾーンにすでに使われています。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) # ModifyEventSubscription 既存の Amazon DocumentDB イベント通知サブスクリプションを変更します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SubscriptionName ** Amazon DocumentDB イベント通知サブスクリプション名。 タイプ: 文字列 必須: はい ** Enabled ** ブール値。サブスクリプションを有効にする場合は `true` に設定します。 タイプ: ブール値 必須: いいえ **EventCategories.EventCategory.N** サブスクライブする `SourceType` のイベントカテゴリのリスト。 型: 文字列の配列 必須: いいえ ** SnsTopicArn ** イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。 タイプ: 文字列 必須: いいえ ** SourceType ** イベントを生成しているソースの種類。例えば、インスタンスが生成したイベントの通知を受ける場合は、このパラメータを `db-instance` に設定します。この値を指定しない場合、すべてのイベントが返されます。 有効な値: `db-instance`、`db-parameter-group`、`db-security-group` タイプ: 文字列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** EventSubscription ** サブスクライブしたイベントの詳細情報。 型: [EventSubscription](API_EventSubscription.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** EventSubscriptionQuotaExceeded ** イベントサブスクリプション数が最大に達しました。 HTTP ステータスコード: 400 ** SNSInvalidTopic ** Amazon SNS は、指定されたトピックに問題があると回答しました。 HTTP ステータスコード: 400 ** SNSNoAuthorization ** SNS トピックの Amazon リソースネーム (ARN) に発行する権限がありません。 HTTP ステータスコード: 400 ** SNSTopicArnNotFound ** SNS トピックの Amazon リソースネーム (ARN) が存在しません。 HTTP ステータスコード: 404 ** SubscriptionCategoryNotFound ** 指定されたカテゴリは存在しません。 HTTP ステータスコード: 404 ** SubscriptionNotFound ** サブスクリプション名が存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) # ModifyGlobalCluster Amazon DocumentDB グローバルクラスターの設定を変更します。リクエストでこれらのパラメータと新しい値を指定すると、1 つ以上の設定パラメータ (例: 削除保護) またはグローバルクラスター識別子を変更できます。 **注記** このアクションは Amazon DocumentDB クラスターにのみ適用されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** GlobalClusterIdentifier ** 変更するグローバルクラスターの識別子。このパラメータでは大文字と小文字は区別されません。 制約: + 既存のグローバルクラスターの識別子と一致する必要があります。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ** DeletionProtection ** グローバルクラスターで削除保護を有効にするかどうかを指定します。削除保護が有効な場合、グローバルクラスターは削除できません。 タイプ: ブール値 必須: いいえ ** NewGlobalClusterIdentifier ** グローバルクラスターを変更するときのグローバルクラスターの新しい識別子。この値は小文字で保存されます。 + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 1 字目は文字である必要があります 文字列の最後にハイフンを使用したり、ハイフンを 2 つ続けて使用したりすることはできません。 例: `my-cluster2` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) # RebootDBInstance 通常はメンテナンスのためにインスタンスを再起動する必要があります。例えば、特定の変更を行う場合や、インスタンスに関連付けられたクラスターパラメーターグループを変更した場合は、変更を有効にするためにインスタンスを再起動する必要があります。 インスタンスを再起動すると、データベースエンジンサービスが再起動されます。インスタンスを再起動すると一時的に機能停止になります。その間、DB インスタンスのステータスは [*rebooting*] に設定されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBInstanceIdentifier ** インスタンス識別子。このパラメータは小文字で保存されます。 制約: + 既存の `DBInstance` の識別子と一致する必要があります。 タイプ: 文字列 必須: はい ** ForceFailover ** `true` の場合、再起動はマルチ AZ フェイルオーバーによって行われます。 制約: インスタンスがマルチ AZ 用に設定されていない場合、`true` を指定することはできません。 タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBInstance ** インスタンスに関する詳細情報。 型: [DBInstance](API_DBInstance.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBInstanceNotFound ** `DBInstanceIdentifier` が既存の DB インスタンスを参照していません。 HTTP ステータスコード: 404 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) # RemoveFromGlobalCluster Amazon DocumentDB セカンダリクラスターをグローバルクラスターからデタッチします。クラスターは、読み取り専用で、別のリージョンのプライマリからデータを受信するのではなく、読み取り・書き込み機能を備えたスタンドアロンクラスターになります。 **注記** このアクションは Amazon DocumentDB クラスターにのみ適用されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DbClusterIdentifier ** Amazon DocumentDB グローバルクラスターからデタッチされたクラスターを識別する Amazon リソースネーム (ARN)。 タイプ: 文字列 必須: はい ** GlobalClusterIdentifier ** Amazon DocumentDB グローバルクラスターからデタッチするクラスター識別子。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) # RemoveSourceIdentifierFromSubscription 既存の Amazon DocumentDB イベント通知サブスクリプションからソース識別子を削除します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** SourceIdentifier ** インスタンス用のインスタンス識別子、セキュリティグループ名など、サブスクリプションから削除されるソース識別子。 タイプ: 文字列 必須: はい ** SubscriptionName ** ソース識別子を削除する Amazon DocumentDB イベント通知サブスクリプション名。 タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** EventSubscription ** サブスクライブしたイベントの詳細情報。 型: [EventSubscription](API_EventSubscription.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** SourceNotFound ** リクエストされたリソースが見つかりませんでした。 HTTP ステータスコード: 404 ** SubscriptionNotFound ** サブスクリプション名が存在しません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) # RemoveTagsFromResource Amazon DocumentDB リソースからメタデータタグを削除します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** ResourceName ** タグが削除されたAmazon DocumentDB リソース。この値は Amazon リソースネーム (ARN) です。 タイプ: 文字列 必須: はい **TagKeys.member.N** 削除するタグのタグキー (名前)。 型: 文字列の配列 必須: はい ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBInstanceNotFound ** `DBInstanceIdentifier` は既存のインスタンスを参照していません。 HTTP ステータスコード: 404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` は既存のスナップショットを参照していません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) # ResetDBClusterParameterGroup クラスターパラメータグループのパラメータをデフォルト値に変更します。特定のパラメータをリセットするには、`ParameterName` と `ApplyMethod` のリストを送信します。クラスターパラメータグループ全体をリセットするには、`DBClusterParameterGroupName` と `ResetAllParameters` パラメータを指定します。 グループ全体をリセットすると、動的パラメータは直ちに更新され、静的パラメータは `pending-reboot` に設定され、次回のDB インスタンス再起動時に有効になります。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterParameterGroupName ** リセットするクラスターパラメータグループの名前。 タイプ: 文字列 必須: はい **Parameters.Parameter.N** デフォルト値にリセットするクラスターパラメータグループ内のパラメータ名のリスト。`ResetAllParameters` パラメータが `true` に設定されている場合は、このパラメータを設定することはできません。 タイプ: [Parameter](API_Parameter.md) オブジェクトの配列 必須: いいえ ** ResetAllParameters ** `true` に設定する場合はクラスターパラメータグループ内のすべてのパラメータがデフォルト値にリセットされ、それ以外の場合は `false` に設定される値。`Parameters` パラメータに指定されたパラメータ名のリストがある場合、このパラメータは使用できません。 タイプ: ブール値 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBClusterParameterGroupName ** クラスターパラメータグループの名前。 制約: + 1 ～ 255 の英数字である必要があります。 + 最初の文字は文字にする必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 この値は小文字で保存されます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBParameterGroupNotFound ** `DBParameterGroupName` は既存のパラメータグループを参照していません。 HTTP ステータスコード: 404 ** InvalidDBParameterGroupState ** パラメータグループが使用中であるか、無効な状態です。パラメータグループを削除しようとする場合、パラメータグループがこの状態のときは削除できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) # RestoreDBClusterFromSnapshot スナップショットまたはクラスタースナップショットから新しいクラスターを作成します。 スナップショットを指定した場合、ターゲットクラスターは、デフォルト設定とデフォルトセキュリティグループを使用してソース DB スナップショットから作成されます。 クラスタースナップショットを指定した場合、新しいクラスターが既定のセキュリティグループを使用して作成される場合以外は、ターゲットクラスターは元のソース DB クラスターと同じ構成でソースクラスターの復元ポイントから作成されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** スナップショットまたはクラスタースナップショットから作成するクラスター名。このパラメータでは大文字と小文字は区別されません。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字にする必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `my-snapshot-id` タイプ: 文字列 必須: はい ** Engine ** 新しいクラスターに使用するデータベースエンジン。 デフォルト: ソースオブジェクトと同じ。 制約: ソースのエンジンに対応する必要があります。 タイプ: 文字列 必須: はい ** SnapshotIdentifier ** 復元元のスナップショットまたはクラスタースナップショットの識別子。 クラスタースナップショットを指定するには、名前または Amazon リソースネーム (ARN) のいずれかを使用できます。ただし、スナップショットを指定するには ARN のみを使用できます。 制約: + 既存のスナップショットの識別子と一致する必要があります。 タイプ: 文字列 必須: はい **AvailabilityZones.AvailabilityZone.N** DB クラスターのインスタンスを作成できる Amazon EC2 アベイラビリティーゾーンのリストを提供します。 型: 文字列の配列 必須: いいえ ** DBClusterParameterGroupName ** このクラスターに関連付ける DB クラスターパラメータグループの名前。 *型*:文字列       必須: いいえ この引数を省略すると、指定した DB クラスターのデフォルトのパラメータグループが使用されます。指定した場合、既存の DB クラスターのパラメータグループの名前と一致する必要があります。1 ～ 255 の文字、数字またはハイフンを使用する必要があります。名前は文字で開始し、ハイフン以外で終了する必要があります。ハイフンを 2 つ続けて使用することはできません。 タイプ: 文字列 必須: いいえ ** DBSubnetGroupName ** 新しいクラスターに使用するサブネットグループ名。 制約: 指定した場合、既存の `DBSubnetGroup` の名前と一致する必要があります。 例: `mySubnetgroup` タイプ: 文字列 必須: いいえ ** DeletionProtection ** このクラスターを削除できるかどうかを指定します。`DeletionProtection` を有効にすると、クラスターが変更され `DeletionProtection` が無効にならない限り、クラスターを削除することができません。`DeletionProtection` はクラスターが誤って削除されるのを防ぎます。 タイプ: ブール値 必須: いいえ **EnableCloudwatchLogsExports.member.N** Amazon CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。 型: 文字列の配列 必須: いいえ ** EngineVersion ** 新しいクラスターに使用するデータベースエンジンのバージョン。 タイプ: 文字列 必須: いいえ ** KmsKeyId ** DB スナップショットまたはクラスタースナップショットから暗号化されたクラスターを復元するときに使用する AWS KMS キー識別子。 AWS KMS キー識別子は、 AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用される AWS KMS 暗号化キーを所有 AWS アカウント する と同じ を持つクラスターを復元する場合は、 AWS KMS 暗号化 AWS KMS キーの ARN の代わりにキーエイリアスを使用できます。 `KmsKeyId` パラメータの値を指定しない場合は、以下のようになります。 + のスナップショットまたはクラスタースナップショット`SnapshotIdentifier`が暗号化されている場合、復元されたクラスターは、スナップショットまたはクラスタースナップショットの暗号化に使用された AWS KMS キーを使用して暗号化されます。 + `SnapshotIdentifier` のスナップショットまたはクラスタースナップショットが暗号化されていない場合、復元されたクラスターは暗号化されません。 タイプ: 文字列 必須: いいえ ** 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` タイプ: 文字列 必須: いいえ ** Port ** クラスターが接続を受け入れるポート番号。 制約: `1150` ～ `65535` の値である必要があります。 デフォルト : 元のクラスターと同じポート。 タイプ: 整数 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。 型: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) オブジェクト 必須: いいえ ** StorageType ** DB クラスターに関連付けるストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です タイプ: 文字列 必須: いいえ **Tags.Tag.N** 復元されたクラスターに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ **VpcSecurityGroupIds.VpcSecurityGroupId.N** クラスターに関連付けられる仮想プライベートクラウド （VPC） セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterAlreadyExistsFault ** 指定された識別子を持つクラスターをすでに持っています。 HTTP ステータスコード: 400 ** DBClusterQuotaExceededFault ** クラスターの最大許容クォータに達したため、クラスターを作成できません。 HTTP ステータスコード: 403 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` は既存のスナップショットを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** InsufficientDBClusterCapacityFault ** クラスターには現在の操作に十分な容量がありません。 HTTP ステータスコード: 403 ** InsufficientStorageClusterCapacity ** クラスターには現在の操作に十分な容量がありません。使用できるストレージがより多い別のアベイラビリティーゾーンを使用するようにサブネットグループを更新することで、このエラーを解決できる場合があります。 HTTP ステータスコード: 400 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBSnapshotState ** スナップショットの状態では削除できません。 HTTP ステータスコード: 400 ** InvalidRestoreFault ** 仮想プライベートクラウド （VPC） のバックアップから VPC以外の DB インスタンスには復元できません。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** KMSKeyNotAccessibleFault ** AWS KMS キーへのアクセス中にエラーが発生しました。 HTTP ステータスコード: 400 ** NetworkTypeNotSupported ** ネットワークタイプは、`DBSubnetGroup` または DB エンジンのバージョンではサポートされていません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) # RestoreDBClusterToPointInTime クラスターを任意の時点に復元します。ユーザーは `LatestRestorableTime` より前の任意の時点に最大 `BackupRetentionPeriod` 日間復元できます。ターゲットクラスターは、新しいクラスターがデフォルトのセキュリティグループで作成されない場合、元のクラスターと同じ構成で作成されます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** 作成する新しいクラスターの名前。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 タイプ: 文字列 必須: はい ** SourceDBClusterIdentifier ** 復元されるソースクラスターの識別子。 制約: + 既存の `DBCluster` の識別子と一致する必要があります。 タイプ: 文字列 必須: はい ** DBSubnetGroupName ** 新しいクラスターに使用するサブネットグループ名。 制約: 指定した場合、既存の `DBSubnetGroup` の名前と一致する必要があります。 例: `mySubnetgroup` タイプ: 文字列 必須: いいえ ** DeletionProtection ** このクラスターを削除できるかどうかを指定します。`DeletionProtection` を有効にすると、クラスターが変更され `DeletionProtection` が無効にならない限り、クラスターを削除することができません。`DeletionProtection` はクラスターが誤って削除されるのを防ぎます。 タイプ: ブール値 必須: いいえ **EnableCloudwatchLogsExports.member.N** Amazon CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。 型: 文字列の配列 必須: いいえ ** KmsKeyId ** 暗号化されたクラスターを暗号化されたクラスターから復元するときに使用する AWS KMS キー識別子。 AWS KMS キー識別子は、 AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用される AWS KMS 暗号化キーを所有 AWS アカウント する と同じ を持つクラスターを復元する場合は、 AWS KMS 暗号化 AWS KMS キーの ARN の代わりにキーエイリアスを使用できます。 新しいクラスターに復元し、ソースクラスターの暗号化に使用される AWS KMS キーとは異なる AWS KMS キーを使用して新しいクラスターを暗号化できます。新しい DB クラスターは、 `KmsKeyId`パラメータで識別される AWS KMS キーで暗号化されます。 `KmsKeyId` パラメータの値を指定しない場合は、以下のようになります。 + クラスターが暗号化されている場合、復元されたクラスターは、ソースクラスターの暗号化に使用された AWS KMS キーを使用して暗号化されます。 + クラスターが暗号化されていない場合、復元されたクラスターは暗号化されません。 `DBClusterIdentifier` が暗号化されていないクラスターを参照している場合、復元リクエストは拒否されます。 タイプ: 文字列 必須: いいえ ** 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` タイプ: 文字列 必須: いいえ ** Port ** クラスターが接続を受け入れるポート番号。 制約:`1150` ～ `65535` の値である必要があります。 デフォルト : エンジンのデフォルトポート。 タイプ: 整数 必須: いいえ ** RestoreToTime ** クラスターを復元する日時。 有効な値: 協定世界時 (UTC) 形式の時刻でなければなりません。 制約: + インスタンスの復元可能な最新時刻より前である必要があります。 + `UseLatestRestorableTime` パラメータを指定しない場合は、指定する必要があります。 + `UseLatestRestorableTime` パラメータが `true` である場合は、指定することはできません。 + `RestoreType` パラメータが `copy-on-write` である場合は、指定することはできません。 例: `2015-03-07T23:45:00Z` 型: タイムスタンプ 必須: いいえ ** RestoreType ** 実行する復元のタイプ。次のいずれかの値を指定できます。 + `full-copy` - 新しい DB クラスターは、ソース DB クラスターのフルコピーとして復元されます。 + `copy-on-write` - 新しい DB クラスターは、ソース DB クラスターのクローンとして復元されます。 制約 : ソース DB クラスターのエンジンバージョンが 1.11 より前である場合、`copy-on-write` を指定できません。 `RestoreType` 値を指定しない場合、新しい DB クラスターは、ソース DB クラスターのフルコピーとして復元されます。 タイプ: 文字列 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。 型: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) オブジェクト 必須: いいえ ** StorageType ** DB クラスターに関連付けるストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です タイプ: 文字列 必須: いいえ **Tags.Tag.N** 復元されたクラスターに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ ** UseLatestRestorableTime ** `true` に設定する場合はクラスターを最新の復元可能なバックアップ時間に復元し、それ以外の場合は `false` に設定される値。 デフォルト: `false` 制約: `RestoreToTime` パラメータを指定した場合は、指定することはできません。 タイプ: ブール値 必須: いいえ **VpcSecurityGroupIds.VpcSecurityGroupId.N** 新しいクラスターが属する VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterAlreadyExistsFault ** 指定された識別子を持つクラスターをすでに持っています。 HTTP ステータスコード: 400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** DBClusterQuotaExceededFault ** クラスターの最大許容クォータに達したため、クラスターを作成できません。 HTTP ステータスコード: 403 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。 HTTP ステータスコード: 404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` は既存のサブネットグループを参照していません。 HTTP ステータスコード: 404 ** InsufficientDBClusterCapacityFault ** クラスターには現在の操作に十分な容量がありません。 HTTP ステータスコード: 403 ** InsufficientStorageClusterCapacity ** クラスターには現在の操作に十分な容量がありません。使用できるストレージがより多い別のアベイラビリティーゾーンを使用するようにサブネットグループを更新することで、このエラーを解決できる場合があります。 HTTP ステータスコード: 400 ** InvalidDBClusterSnapshotStateFault ** 指定された値は有効なクラスタースナップショット状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBSnapshotState ** スナップショットの状態では削除できません。 HTTP ステータスコード: 400 ** InvalidRestoreFault ** 仮想プライベートクラウド （VPC） のバックアップから VPC以外の DB インスタンスには復元できません。 HTTP ステータスコード: 400 ** InvalidSubnet ** 要求されたサブネットが無効であるか、共通の仮想プライベートクラウド （VPC） 内に存在しない複数のサブネットが要求されました。 HTTP ステータスコード: 400 ** InvalidVPCNetworkStateFault ** サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。 HTTP ステータスコード: 400 ** KMSKeyNotAccessibleFault ** AWS KMS キーへのアクセス中にエラーが発生しました。 HTTP ステータスコード: 400 ** NetworkTypeNotSupported ** ネットワークタイプは、`DBSubnetGroup` または DB エンジンのバージョンではサポートされていません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) # StartDBCluster `DBClusterIdentifier` で指定された停止中のクラスターを再起動します。詳細については、「[Amazon DocumentDB クラスターの停止と起動](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)」を参照してください。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** 再開するクラスターの識別子。例: `docdb-2019-05-28-15-24-52` タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) # StopDBCluster `DBClusterIdentifier` で指定された実行中のクラスターを停止します。クラスターは *利用可能な* 状態でなければなりません。詳細については、「[Amazon DocumentDB クラスターの停止と起動](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)」を参照してください。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** 停止するクラスターの識別子。例: `docdb-2019-05-28-15-24-52` タイプ: 文字列 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidDBInstanceState ** 指定されたインスタンスは *利用可能な* 状態ではありません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) # SwitchoverGlobalCluster 指定されたセカンダリ Amazon DocumentDB クラスターをグローバルデータベースクラスターの新しいプライマリ Amazon DocumentDB クラスターに切り替えます。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** GlobalClusterIdentifier ** 切り替える Amazon DocumentDB グローバルデータベースクラスターの識別子。識別子は、クラスターの作成時にユーザーによって割り当てられる一意のキーです。つまり、グローバルクラスターの名前と言えます。このパラメータでは大文字と小文字は区別されません。 制約: + 既存のグローバルクラスター (Amazon DocumentDB グローバルデータベース) の識別子と一致する必要があります。 + 最小長は 1 です｡ 最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ** TargetDbClusterIdentifier ** グローバルデータベースクラスターの新しいプライマリに昇格させるセカンダリ Amazon DocumentDB クラスターの識別子。Amazon DocumentDB が AWS リージョン内のクラスターを見つけることができるように、識別子に Amazon リソースネーム (ARN) を使用します。 制約: + 既存のセカンダリクラスターの識別子と一致する必要があります。 + 最小長は 1 です｡ 最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 255 です。 パターン: `[A-Za-z][0-9A-Za-z-:._]*` 必須: はい ## レスポンス要素 以下の要素がサービスによって返されます。 ** GlobalCluster ** Amazon DocumentDB グローバルクラスターを表すデータ型。 型: [GlobalCluster](API_GlobalCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` は既存のクラスターを参照していません。 HTTP ステータスコード: 404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` は既存のグローバルクラスターを参照していません。 HTTP ステータスコード: 404 ** InvalidDBClusterStateFault ** クラスターは有効な状態ではありません。 HTTP ステータスコード: 400 ** InvalidGlobalClusterStateFault ** 要求された操作は、クラスターがこの状態にある間は実行できません。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) # Amazon DocumentDB Elastic Clusters Amazon DocumentDB Elastic クラスターでは、以下のアクションがサポートされています。 + [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) + [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) + [CreateCluster](API_elastic_CreateCluster.md) + [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) + [DeleteCluster](API_elastic_DeleteCluster.md) + [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) + [GetCluster](API_elastic_GetCluster.md) + [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) + [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) + [ListClusters](API_elastic_ListClusters.md) + [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) + [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) + [ListTagsForResource](API_elastic_ListTagsForResource.md) + [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) + [StartCluster](API_elastic_StartCluster.md) + [StopCluster](API_elastic_StopCluster.md) + [TagResource](API_elastic_TagResource.md) + [UntagResource](API_elastic_UntagResource.md) + [UpdateCluster](API_elastic_UpdateCluster.md) # ApplyPendingMaintenanceAction リソースに適用される保留中のメンテナンスアクションのタイプ。 ## リクエストの構文 ``` POST /pending-action HTTP/1.1 Content-type: application/json { "applyAction": "string", "applyOn": "string", "optInType": "string", "resourceArn": "string" } ``` ## URI リクエストパラメータ リクエストでは URI パラメータを使用しません。 ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** リソースに適用する保留中のメンテナンスアクション。 有効なアクションは以下のとおりです。 + `ENGINE_UPDATE ` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 256 です。 必須: はい ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値。タイプ `IMMEDIATE` のオプトインリクエストは元に戻すことができません。 型: 文字列 有効な値：`IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN` 必須: はい ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム)。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 256 です。 必須: はい ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 保留中のメンテナンスアクションを適用する特定の日付。オプトインタイプが `APPLY_ON` の場合は必須です。形式: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 256 です。 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) ** 適用されている保留中のメンテナンスアクションの出力。 型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) # CopyClusterSnapshot Elastic クラスターのスナップショットをコピーします。 ## リクエストの構文 ``` POST /cluster-snapshot/snapshotArn/copy HTTP/1.1 Content-type: application/json { "copyTags": boolean, "kmsKeyId": "string", "tags": { "string" : "string" }, "targetSnapshotName": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** Elastic クラスタースナップショットの Amazon リソースネーム (ARN) 識別子。 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** コピー元のクラスタースナップショットから作成される新しい Elastic クラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 例: `elastic-cluster-snapshot-5` タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 63 です。 必須: はい ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** コピー元のクラスタースナップショットからコピー先のクラスタースナップショットにすべてのタグをコピーする場合は `true` に設定します。デフォルトは `false` です。 タイプ: ブール値 必須: いいえ ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 暗号化された Elastic クラスタースナップショットの AWS KMS キー ID。 AWS KMS キー ID は、Amazon リソースネーム (ARN)、 AWS KMS キー識別子、または AWS KMS 暗号化キーの KMS AWS キーエイリアスです。 AWS アカウントから暗号化された Elastic クラスタースナップショットをコピーする場合、 の値を指定`KmsKeyId`して、新しい S AWS KMS 暗号化キーでコピーを暗号化できます。`KmsKeyId` の値を指定しない場合、Elastic クラスタースナップショットのコピーはコピー元の Elastic クラスタースナップショットと同じ `AWS` KMS キーで暗号化されます。 暗号化されていない Elastic クラスタースナップショットをコピーして `KmsKeyId` パラメータに値を指定すると、エラーが返されます。 タイプ: 文字列 必須: いいえ ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** Elastic クラスタースナップショットに割り当てるタグ。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) ** 特定のエラスティッククラスタースナップショットに関する情報を返します。 型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) # CreateCluster 新しい Amazon DocumentDB エラスティッククラスターを作成し、そのクラスターの構造を返します。 ## リクエストの構文 ``` POST /cluster HTTP/1.1 Content-type: application/json { "adminUserName": "string", "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "clusterName": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータ リクエストでは URI パラメータを使用しません。 ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB エラスティッククラスター管理者の名前。 *制約*: + 1～63 文字の英数字である必要があります。 + 最初の文字は文字である必要があります。 + 予約語は使用できません。 タイプ: 文字列 必須: はい ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB エラスティッククラスター管理者のパスワード。パスワードは、印刷可能な任意の ASCII 文字で構成することができます。 *制約*: + 8 〜 100 文字で構成する必要があります。 + スラッシュ (/)、二重引用符 (「」)、または「at」記号 (@) を含むことはできません。 タイプ: 文字列 必須: はい ** [authType](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。 型: 文字列 有効な値：`PLAIN_TEXT | SECRET_ARN` 必須: はい ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターの名前。このパラメータは小文字で保存されます。 *制約*: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 *例*: `my-cluster` タイプ: 文字列 必須: はい ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。 タイプ: 整数 必須: はい ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。 タイプ: 整数 必須: はい ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) ** 自動スナップショットが保持される日数。 タイプ: 整数 必須: いいえ ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターのクライアントトークン。 タイプ: 文字列 必須: いいえ ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターの暗号化に使用する KMS キー識別子。 KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。 暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。 タイプ: 文字列 必須: いいえ ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) ** `backupRetentionPeriod` に応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。 タイプ: 文字列 必須: いいえ ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式:* `ddd:hh24:mi-ddd:hh24:mi` *デフォルト*: それぞれ 8 時間の時間ブロックからランダムに選択された AWS リージョン 30 分のウィンドウ。ランダムな曜日に発生します。 *有効な曜日*: 月、火、水、木、金、土、日 *制約*: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値 が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。 タイプ: 整数 必須: いいえ ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) ** 新しい エラスティッククラスターの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: いいえ ** [tags](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターに割り当てるタグ。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) ** このクラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) ** 作成された新しい エラスティッククラスター。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) # CreateClusterSnapshot エラスティッククラスターのスナップショットを作成します。 ## リクエストの構文 ``` POST /cluster-snapshot HTTP/1.1 Content-type: application/json { "clusterArn": "string", "snapshotName": "string", "tags": { "string" : "string" } } ``` ## URI リクエストパラメータ リクエストでは URI パラメータを使用しません。 ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** スナップショットを作成するエラスティッククラスターの ARN 識別子。 タイプ: 文字列 必須: はい ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 新しい エラスティッククラスタースナップショットの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 63 です。 必須: はい ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 新しいエラスティッククラスターに割り当てるタグ。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) ** 新しいエラスティッククラスタースナップショットに関する情報を返します。 型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) # DeleteCluster エラスティッククラスターを削除します。 ## リクエストの構文 ``` DELETE /cluster/clusterArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) ** 削除するエラスティッククラスターの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) ** 新たに削除されたエラスティッククラスタースナップショットに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) # DeleteClusterSnapshot エラスティッククラスタースナップショットを削除します。 ## リクエストの構文 ``` DELETE /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) ** 削除する エラスティッククラスタースナップショットの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) ** 新たに削除されたエラスティッククラスタースナップショットに関する情報を返します。 型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) # GetCluster 特定のエラスティッククラスターに関する情報を返します。 ## リクエストの構文 ``` GET /cluster/clusterArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) # GetClusterSnapshot 特定のエラスティッククラスターナップショットに関する情報を返す ## リクエストの構文 ``` GET /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) ** エラスティッククラスタースナップショットの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) ** 特定のエラスティッククラスタースナップショットに関する情報を返します。 型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) # GetPendingMaintenanceAction 保留中のすべてのメンテナンスアクションを取得します。 ## リクエストの構文 ``` GET /pending-action/resourceArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) ** 特定の Amazon リソースネーム (ARN) の保留中のメンテナンスアクションを取得します。 長さの制約: 最小長は 1 です。最大長は 256 です。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) ** リソースの保留中のメンテナンスアクションに関する情報を入力します。 型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) # ListClusters プロビジョニングした Amazon DocumentDB クラスターに関する情報を返します。 ## リクエストの構文 ``` GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) ** レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。 有効範囲: 最小値 1。最大値は 100 です。 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。 レスポンスにデータがなくなると、`nextToken` は返されません。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "clusters": [ { "clusterArn": "string", "clusterName": "string", "status": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) ** Amazon DocumentDB エラスティッククラスターのリスト。 型: [ClusterInList](API_elastic_ClusterInList.md) オブジェクトの配列 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。 レスポンスにデータがなくなると、`nextToken` は返されません。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) # ListClusterSnapshots 指定された Elastic クラスターのスナップショットに関する情報を返します。 ## リクエストの構文 ``` GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) ** レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。 有効範囲: 最小値 は 20 です。最大値は 100 です。 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。 レスポンスにデータがなくなると、`nextToken` は返されません。 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。 + `automated` - Amazon DocumentDB が AWS アカウントに対して自動的に作成したすべてのクラスタースナップショットを返します。 + `manual` - AWS アカウント用に手動で作成したすべてのクラスタースナップショットを返します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "snapshots": [ { "clusterArn": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。 レスポンスにデータがなくなると、`nextToken` は返されません。 タイプ: 文字列 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 指定した Elastic クラスターのスナップショットのリスト。 型: [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) オブジェクトの配列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) # ListPendingMaintenanceActions 保留中のすべてのメンテナンスアクションのリストを取得します。 ## リクエストの構文 ``` GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** レスポンスに含める結果の最大数。指定された `maxResults` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。 有効範囲: 最小値 1。最大値は 100 です。 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `maxResults` で指定された値まで、マーカーを超えるレコードのみが含まれます。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resourcePendingMaintenanceActions": [ { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** リソースの保留中のメンテナンスアクションに関する情報を入力します。 型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクトの配列 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータが表示された場合、レスポンスには `maxResults` で指定された値まで、マーカーを超えるレコードのみが含まれます。 タイプ: 文字列 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) # ListTagsForResource エラスティッククラスターリソースのすべてのタグを一覧表示します。 ## リクエストの構文 ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) ** 指定されたエラスティッククラスターリソースに対するタグのリスト。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) # RestoreClusterFromSnapshot スナップショットからエラスティッククラスターの復元します。 ## リクエストの構文 ``` POST /cluster-snapshot/snapshotArn/restore HTTP/1.1 Content-type: application/json { "clusterName": "string", "kmsKeyId": "string", "shardCapacity": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスタースナップショットの ARN 識別子。 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスターの名前。 タイプ: 文字列 必須: はい ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新しい Amazon DocumentDB エラスティッククラスターの暗号化に使用する KMS キー識別子。 KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。 ここで暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。 タイプ: 文字列 必須: いいえ ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新しく復元された Elastic クラスター内の各シャードの容量。 タイプ: 整数 必須: いいえ ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値 が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。 タイプ: 整数 必須: いいえ ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: いいえ ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 復元されたエラスティッククラスターに割り当てるキーと値のペアの配列形式でのタグ名のリスト。キーがタグ名、値がキー値です。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) ** 復元されたエラスティッククラスターに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) # StartCluster `clusterARN` で指定された停止中の Elastic クラスターを再開します。 ## リクエストの構文 ``` POST /cluster/clusterArn/start HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) # StopCluster `clusterArn` で指定された実行中の Elastic クラスターを停止します。これには、この Elastic クラスターが *利用可能な* 状態である必要があります。 ## リクエストの構文 ``` POST /cluster/clusterArn/stop HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) # TagResource エラスティッククラスターリソースにメタデータタグを追加します ## リクエストの構文 ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [tags](#API_elastic_TagResource_RequestSyntax) ** エラスティッククラスターリソースに割り当てられているタグ。 タイプ: 文字列間のマッピング キーの長さ制限: 最小長さは 1 です。最大長は 128 です。 キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 必須: はい ## レスポンスの構文 ``` HTTP/1.1 200 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) # UntagResource エラスティッククラスターリソースからメタデータタグを削除します。 ## リクエストの構文 ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) ** エラスティッククラスターリソースから削除するタグのキー。 配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。 長さの制限：最小長 1、最大長は 128 です。 パターン: `(?!aws:)[a-zA-Z+-=._:/]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) # UpdateCluster エラスティッククラスターを変更します。これには、管理者ユーザー名/パスワードの更新、API バージョンのアップグレード、バックアップウィンドウとメンテナンスウィンドウの設定が含まれます ## リクエストの構文 ``` PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスター管理者に関連付けられているパスワード。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。 制約: 8 ～ 100 文字の長さの英数字である必要があります。 タイプ: 文字列 必須: いいえ ** [authType](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。 型: 文字列 有効な値：`PLAIN_TEXT | SECRET_ARN` 必須：いいえ ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) ** 自動スナップショットが保持される日数。 タイプ: 整数 必須: いいえ ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターのクライアントトークン。 タイプ: 文字列 必須: いいえ ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) ** `backupRetentionPeriod` に応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。 タイプ: 文字列 必須: いいえ ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式:* `ddd:hh24:mi-ddd:hh24:mi` *デフォルト*: それぞれ 8 時間の時間ブロックからランダムに選択された AWS リージョン 30 分のウィンドウ。ランダムな曜日に発生します。 *有効な曜日*: 月、火、水、木、金、土、日 *制約*: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。 タイプ: 整数 必須: いいえ ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。 タイプ: 整数 必須: いいえ ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値 が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。 タイプ: 整数 必須: いいえ ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。 型: 文字列の配列 必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) ** 更新されたエラスティッククラスターに関する情報を返します。 型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) # データ型 次のデータ型は でサポートされています 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) # 共通エラー このセクションでは、AWS のすべてのサービスの API アクションに共通のエラーを一覧表示しています。このサービスの API アクションに固有のエラーについては、その API アクションのトピックを参照してください。 **AccessDeniedException** このアクションを実行する十分なアクセス権限がありません。 HTTP ステータスコード: 400 **IncompleteSignature** リクエストの署名が AWS 基準に適合しません。 HTTP ステータスコード: 400 **InternalFailure** リクエストの処理が、不明なエラー、例外、または障害により実行できませんでした。 HTTP ステータスコード: 500 **InvalidAction** リクエストされたアクション、またはオペレーションは無効です。アクションが正しく入力されていることを確認してください。 HTTP ステータスコード: 400 **InvalidClientTokenId** 指定された X.509 証明書または AWS アクセスキー ID がレコード内に見つかりません。 HTTP ステータスコード: 403 **NotAuthorized** このアクションを実行するためのアクセス許可がありません。 HTTP ステータスコード: 400 **OptInRequired** サービスを利用するためには、AWS アクセスキー ID を取得する必要があります。 HTTP ステータスコード: 403 **RequestExpired** リクエストの日付スタンプの 15 分以上後またはリクエストの有効期限 (署名付き URL の場合など) の 15 分以上後に、リクエストが到着しました。または、リクエストの日付スタンプが現在より 15 分以上先です。 HTTP ステータスコード: 400 **ServiceUnavailable** サーバーの一時的な障害により、リクエストは失敗しました。 HTTP ステータスコード: 503 **ThrottlingException** リクエストのスロットリングにより、リクエストが拒否されました。 HTTP ステータスコード: 400 **ValidationError** 入力が、AWS サービスで指定された制約を満たしていません。 HTTP ステータスコード: 400 # 共通パラメータ 次のリストには、すべてのアクションが署名バージョン 4 リクエストにクエリ文字列で署名するために使用するパラメータを示します。アクション固有のパラメータは、アクションのトピックに示されています。Signature Version 4 の詳細については、「IAM ユーザーガイド」の「[AWS API リクエストの署名](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)」を参照してください。 **Action** 実行するアクション。 型: 文字列 必須: はい **Version** リクエストが想定している API バージョンである、YYYY-MM-DD 形式で表示されます。 型: 文字列 必須: はい **X-Amz-Algorithm** リクエストの署名を作成するのに使用したハッシュアルゴリズム。 条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。 型: 文字列 有効な値：`AWS4-HMAC-SHA256` 必須: 条件による **X-Amz-Credential** 認証情報スコープの値で、アクセスキー、日付、対象とするリージョン、リクエストしているサービス、および終了文字列 ("aws4\$1request") を含む文字列です。値は次の形式で表現されます: [*access\$1key*/*YYYYMMDD*/*リージョン*/*サービス*/aws4\$1request]。 詳細については、「IAM ユーザーガイド」の「[署名付きAWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。 条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。 型: 文字列 必須: 条件による **X-Amz-Date** 署名を作成するときに使用する日付です。形式は ISO 8601 基本形式の YYYYMMDD'T'HHMMSS'Z' でなければなりません。例えば、日付 `20120325T120000Z` は、有効な X-Amz-Date の値です。 条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 ベーシック形式で日付ヘッダーが指定されている場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、「IAM ユーザーガイド」の「[AWS API リクエスト署名の要素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)」を参照してください。 タイプ: 文字列 必須: 条件による **X-Amz-Security-Token** AWS Security Token Service (AWS STS) へのを呼び出しで取得された一時的なセキュリティトークン。AWS STS の一時的なセキュリティ認証情報をサポートするサービスのリストについては、「IAM ユーザーガイド」の「[IAM と連携するAWS のサービス](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)」を参照してください。 条件:AWS STS の一時的なセキュリティ認証情報を使用する場合、セキュリティトークンを含める必要があります。 タイプ: 文字列 必須: 条件による **X-Amz-Signature** 署名する文字列と派生署名キーから計算された 16 進符号化署名を指定します。 条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。 型: 文字列 必須: 条件による **X-Amz-SignedHeaders** 正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名付きヘッダーの指定に関する詳細については、「IAM ユーザーガイド」の「[署名付き AWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。 条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。 型: 文字列 必須: 条件による