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
-
Amazon DocumentDB エラスティッククラスター管理者の名前。
制約:
-
1～63 文字の英数字である必要があります。
-
1 字目は文字である必要があります。
-
予約語は使用できません。
型: 文字列
必須: はい
-
- adminUserPassword
-
Amazon DocumentDB エラスティッククラスター管理者のパスワード。パスワードは、印刷可能な任意の ASCII 文字で構成することができます。
制約:
-
8 〜 100 文字で構成する必要があります。
-
スラッシュ (/)、二重引用符 (「」)、または「at」記号 (@) を含むことはできません。
型: 文字列
必須: はい
-
- authType
-
エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、
PLAIN_TEXTまたはSECRET_ARNです。型: 文字列
有効な値:
PLAIN_TEXT | SECRET_ARN必須: はい
- clusterName
-
新しいエラスティッククラスターの名前。このパラメータは小文字で保存されます。
制約:
-
1 ～ 63 の文字、数字またはハイフンを使用する必要があります。
-
1 字目は文字である必要があります。
-
ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。
例:
my-cluster型: 文字列
必須: はい
-
- shardCapacity
-
各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。
型: 整数
必須: はい
- shardCount
-
エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。
型: 整数
必須: はい
- backupRetentionPeriod
-
自動スナップショットが保持される日数。
型: 整数
必須：いいえ
- clientToken
-
エラスティッククラスターのクライアントトークン。
型: 文字列
必須: いいえ
- kmsKeyId
-
新しいエラスティッククラスターの暗号化に使用する KMS キー識別子。
KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。
暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。
型: 文字列
必須: いいえ
- preferredBackupWindow
-
backupRetentionPeriodに応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。型: 文字列
必須: いいえ
- preferredMaintenanceWindow
-
週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。
形式:
ddd:hh24:mi-ddd:hh24:miデフォルト: 各 AWS リージョン true の 1 週間のうちのランダムな曜日に起こる 8 時間の時間範囲からランダムに選択された 30 分のウィンドウ。
有効な曜日: 月、火、水、木、金、土、日
制約: 最小限の 30 分単位のウィンドウ。
型: 文字列
必須: いいえ
- shardInstanceCount
-
Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。
shardInstanceCount値 が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。型: 整数
必須：いいえ
- subnetIds
-
新しい エラスティッククラスターの Amazon EC2 サブネット ID。
型: 文字列の配列
必須：いいえ
-
新しいエラスティッククラスターに割り当てるタグ。
型: 文字列間のマッピング
キーの長さ制限: 最小長さは 1 です。最大長は 128 です。
キーパターン:
^(?!aws:)[a-zA-Z+-=._:/]+$値の長さの制限: 最小長は 0 です。最大長は 256 です。
必須：いいえ
- vpcSecurityGroupIds
-
このクラスターに関連付ける 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 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
アクションを実行するための十分なアクセス許可がない場合に発生する例外。
HTTP ステータスコード: 403
- ConflictException
-
アクセス競合が発生しました。
HTTP ステータスコード: 409
- InternalServerException
-
内部サーバーエラーが発生しました。
HTTP ステータスコード：500
- ServiceQuotaExceededException
-
アクションのサービスクォータを超えました。
HTTP ステータスコード: 402
- ThrottlingException
-
ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。
HTTP ステータスコード: 429
- ValidationException
-
検証例外の定義がある構造。
HTTP ステータスコード：400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
