翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateDBInstance
新しいインスタンスを作成します。
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- DBClusterIdentifier
-
インスタンスが属するクラスターの識別子。
型: 文字列
必須: はい
- DBInstanceClass
-
インスタンスのコンピューティング能力とメモリ容量 (例:
db.r5.large
)。型: 文字列
必須: はい
- DBInstanceIdentifier
-
インスタンス識別子。このパラメータは小文字で保存されます。
制約:
-
1 ~ 63 の文字、数字またはハイフンを使用する必要があります。
-
1 字目は文字である必要があります。
-
ハイフンを、文字列の最後に使用したり、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証明書の更新」と「転送中のデータの暗号化」を参照してください。
型: 文字列
必須: いいえ
- CopyTagsToSnapshot
-
タグを DB インスタンスから DB インスタンスのスナップショットにコピーするかどうかを示す値。デフォルトでは、タグはコピーされません。
型: ブール値
必須:いいえ
- EnablePerformanceInsights
-
DB インスタンスで Performance Insights を有効にするかどうかを示す値。詳細については、「Amazon Performance Insights の使用」を参照してください。
型: ブール値
必須:いいえ
- PerformanceInsightsKMSKeyId
-
パフォーマンスインサイトデータの暗号化の 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
デフォルトは、1 週間のうちのランダムな日に起こる、AWS リージョン あたり 8 時間の範囲からランダムに選択された、30 分の時間枠です。
有効な日: 月、火、水、木、金、土、日
制約: 最小限の 30 分単位のウィンドウ。
型: 文字列
必須: いいえ
- PromotionTier
-
既存のプライマリインスタンスの障害後に、Amazon DocumentDB レプリカがプライマリインスタンスに昇格する順序を指定する値。
デフォルト: 1
有効な値: 0 ~ 15
型: 整数
必須:いいえ
- Tags.Tag.N
-
インスタンスに割り当てられるタグ。インスタンスには最大 10 個のタグを割り当てることができます。
型: Tag オブジェクトの配列
必須:いいえ
レスポンス要素
以下の要素がサービスによって返されます。
- DBInstance
-
インスタンスに関する詳細情報。
型: DBInstance オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- 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 SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。