翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateCluster
クラスターを作成します。クラスターのすべてのノードで、同じプロトコルに準拠するエンジンソフトウェアが実行されます。
リクエストの構文
{
"ACLName": "string
",
"AutoMinorVersionUpgrade": boolean
,
"ClusterName": "string
",
"DataTiering": boolean
,
"Description": "string
",
"EngineVersion": "string
",
"KmsKeyId": "string
",
"MaintenanceWindow": "string
",
"NodeType": "string
",
"NumReplicasPerShard": number
,
"NumShards": number
,
"ParameterGroupName": "string
",
"Port": number
,
"SecurityGroupIds": [ "string
" ],
"SnapshotArns": [ "string
" ],
"SnapshotName": "string
",
"SnapshotRetentionLimit": number
,
"SnapshotWindow": "string
",
"SnsTopicArn": "string
",
"SubnetGroupName": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"TLSEnabled": boolean
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは、 JSON形式の次のデータを受け入れます。
- ACLName
-
クラスターに関連付けられているアクセスコントロールリストの名前。
型: 文字列
長さの制限:最小長は 1 です。
パターン:
[a-zA-Z][a-zA-Z0-9\-]*
必須:はい
- AutoMinorVersionUpgrade
-
true に設定すると、クラスターは、起動後にマイナーエンジンバージョンのアップグレードを自動的に受信します。
型: ブール値
必須:いいえ
- ClusterName
-
クラスターの名前。この値は、クラスター識別子としても機能するため、一意である必要があります。
型: 文字列
必須: はい
- DataTiering
-
データの階層化を有効にします。データ階層化は、r6gd ノードタイプを使用するクラスターでのみサポートされます。r6gd ノードを使用する場合は、このパラメータを設定する必要があります。詳細については、データ階層化を参照してください。
型: ブール値
必須:いいえ
- Description
-
クラスターの説明 (任意)。
タイプ: 文字列
必須: いいえ
- EngineVersion
-
クラスターに使用する Redis OSS エンジンのバージョン番号。
タイプ: 文字列
必須: いいえ
- KmsKeyId
-
クラスターの暗号化に使用されるKMSキーの ID。
タイプ: 文字列
必須: いいえ
- MaintenanceWindow
-
クラスターの週次メンテナンスを実行する時間範囲を指定します。これは、ddd:hh24:mi-ddd:hh24:mi (24H クロック UTC) の形式で範囲として指定されます。最短メンテナンス期間は 60 分です。
ddd
の有効値は、次のとおりです。-
sun
-
mon
-
tue
-
wed
-
thu
-
fri
-
sat
例:
sun:23:00-mon:01:30
タイプ: 文字列
必須: いいえ
-
- NodeType
-
クラスター内のノードのコンピューティング能力とメモリ容量。
型: 文字列
必須: はい
- NumReplicasPerShard
-
各シャードに適用するレプリカの数。デフォルト値は 1 です。最大数は 5 です。
タイプ: 整数
必須:いいえ
- NumShards
-
クラスターに含まれるシャードの数。デフォルト値は 1 です。
タイプ: 整数
必須:いいえ
- ParameterGroupName
-
このクラスターに関連付けられたパラメータグループの名前。
タイプ: 文字列
必須: いいえ
- Port
-
各ノードが接続を受け付けるポート番号。
タイプ: 整数
必須:いいえ
- SecurityGroupIds
-
このクラスターに関連付けるセキュリティグループ名のリスト。
タイプ:文字列の配列
必須:いいえ
- SnapshotArns
-
Amazon S3 に保存されているRDBスナップショットファイルを一意に識別する Amazon リソースネーム (ARN) のリスト。 Amazon S3 スナップショットファイルは、新しいクラスターを作成するために使用されます。の Amazon S3 オブジェクト名にカンマを含めるARNことはできません。
タイプ:文字列の配列
必須:いいえ
- SnapshotName
-
新しいクラスターにデータを復元するスナップショットの名前。新しいクラスターの作成中は、スナップショットのステータスがリストア中に変わります。
タイプ: 文字列
必須: いいえ
- SnapshotRetentionLimit
-
MemoryDB によって自動スナップショットが保持される日数。この日数を超えると、自動スナップショットは削除されます。例えば、 SnapshotRetentionLimit を 5 に設定すると、今日作成されたスナップショットは 5 日間保持され、その後削除されます。
タイプ: 整数
必須:いいえ
- SnapshotWindow
-
MemoryDB UTCがシャードの毎日のスナップショットの作成を開始する毎日の時間範囲 ( )。
例: 5:00~9:00
このパラメータを指定しないと、MemoryDB によって自動的に適切な時間範囲が選択されます。
タイプ: 文字列
必須: いいえ
- SnsTopicArn
-
通知が送信される Amazon Simple Notification Service (ARN) トピックの Amazon リソースネーム (SNS)。
タイプ: 文字列
必須: いいえ
- SubnetGroupName
-
クラスターに使用されるサブネットグループの名前。
タイプ: 文字列
必須: いいえ
- Tags
-
このリソースに追加するタグのリスト。タグはカンマで区切られたキーと値のペアです (例: Key=myKey, Value=myKeyValue。Key=、Value=Key=myKey、Value=mySecondKeyValue myKeyValue mySecondKeyのように複数のタグを含めることができます。
型: Tag オブジェクトの配列
配列メンバー: 最大数は 200 項目です。
必須:いいえ
- TLSEnabled
-
転送時の暗号化をクラスターで有効にできるフラグ。
型: ブール値
必須:いいえ
レスポンスの構文
{
"Cluster": {
"ACLName": "string",
"ARN": "string",
"AutoMinorVersionUpgrade": boolean,
"AvailabilityMode": "string",
"ClusterEndpoint": {
"Address": "string",
"Port": number
},
"DataTiering": "string",
"Description": "string",
"EnginePatchVersion": "string",
"EngineVersion": "string",
"KmsKeyId": "string",
"MaintenanceWindow": "string",
"Name": "string",
"NodeType": "string",
"NumberOfShards": number,
"ParameterGroupName": "string",
"ParameterGroupStatus": "string",
"PendingUpdates": {
"ACLs": {
"ACLToApply": "string"
},
"Resharding": {
"SlotMigration": {
"ProgressPercentage": number
}
},
"ServiceUpdates": [
{
"ServiceUpdateName": "string",
"Status": "string"
}
]
},
"SecurityGroups": [
{
"SecurityGroupId": "string",
"Status": "string"
}
],
"Shards": [
{
"Name": "string",
"Nodes": [
{
"AvailabilityZone": "string",
"CreateTime": number,
"Endpoint": {
"Address": "string",
"Port": number
},
"Name": "string",
"Status": "string"
}
],
"NumberOfNodes": number,
"Slots": "string",
"Status": "string"
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SnsTopicArn": "string",
"SnsTopicStatus": "string",
"Status": "string",
"SubnetGroupName": "string",
"TLSEnabled": boolean
}
}
レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを返します。
次のデータは、サービスによって JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- ACLNotFoundFault
-
HTTP ステータスコード: 400
- ClusterAlreadyExistsFault
-
HTTP ステータスコード: 400
- ClusterQuotaForCustomerExceededFault
-
HTTP ステータスコード: 400
- InsufficientClusterCapacityFault
-
HTTP ステータスコード: 400
- InvalidACLStateFault
-
HTTP ステータスコード: 400
- InvalidCredentialsException
-
HTTP ステータスコード: 400
- InvalidParameterCombinationException
-
HTTP ステータスコード: 400
- InvalidParameterValueException
-
HTTP ステータスコード: 400
- InvalidVPCNetworkStateFault
-
HTTP ステータスコード: 400
- NodeQuotaForClusterExceededFault
-
HTTP ステータスコード: 400
- NodeQuotaForCustomerExceededFault
-
HTTP ステータスコード: 400
- ParameterGroupNotFoundFault
-
HTTP ステータスコード: 400
- ServiceLinkedRoleNotFoundFault
-
HTTP ステータスコード: 400
- ShardsPerClusterQuotaExceededFault
-
HTTP ステータスコード: 400
- SubnetGroupNotFoundFault
-
HTTP ステータスコード: 400
- TagQuotaPerResourceExceeded
-
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。