CreateCluster - Amazon 内存 DB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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 }

请求参数

有关所有操作的公用参数的信息,请参阅 Commm Parameters

请求接受采用 JSON 格式的以下数据。

ACLName

要与集群关联的访问控制列表的名称。

类型:字符串

长度限制:最小长度为 1。

模式:[a-zA-Z][a-zA-Z0-9\-]*

必需:是

AutoMinorVersionUpgrade

设置为 true 时,集群将在启动后自动接收次要引擎版本升级。

类型:布尔值

必需:否

ClusterName

集群的名称。此值必须是唯一的,因为它也用作群集标识符。

类型:字符串

必需:是

DataTiering

启用数据分层。只有使用 r6gd 节点类型的集群才支持数据分层。使用 r6gd 节点时,必须设置此参数。有关更多信息,请参阅数据分层

类型:布尔值

必需:否

Description

集群的可选描述。

类型:字符串

必需:否

EngineVersion

用于集群的 Redis 引擎的版本号。

类型:字符串

必需:否

KmsKeyId

用于加密集群的 KMS 密钥的 ID。

类型:字符串

必需:否

MaintenanceWindow

指定每周执行集群维护的时间范围。它被指定为 ddd:hh24:mi-ddd:hh24:mi 格式(24 小时制 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)列表。快照文件用于填充新集群。ARN 中的 Amazon S3 对象名称不能包含逗号。

类型:字符串数组

必需:否

SnapshotName

一个快照的名称,可通过该快照将数据还原到新集群中。创建新时,快照状态将更改为还原。

类型:字符串

必需:否

SnapshotRetentionLimit

MemoryDB 在删除自动快照之前保留这些快照的天数。例如,如果将设置 SnapshotRetentionLimit 为 5,则今天拍摄的快照将在保留 5 天后删除。

类型:整数

必需:否

SnapshotWindow

MemoryDB 将开始获取分片的每日快照的日常时间范围 (UTC)。

示例:05:00-09:00

如果您不指定此参数,MemoryDB 会自动选择适当的时间范围。

类型:字符串

必需:否

SnsTopicArn

向其发送通知的 Amazon Simple Notification Service (SNS) 主题的 Amazon 资源名称(ARN)。

类型:字符串

必需:否

SubnetGroupName

要用于集群的子网组的名称。

类型:字符串

必需:否

Tags

要添加到此资源的标签列表。标签是逗号分隔的键/值对(例如,键=myKey,值=)myKeyValue。您可以包含多个标签,如下所示:键=mymyKeyValue KeymySecondKey,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 } }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

Cluster

新创建的集群。

类型:Cluster 对象

错误

有关所有操作常见错误的信息,请参阅常见错误

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

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: