public class CreateInstancesRequest extends AbstractModel
Constructor and Description |
---|
CreateInstancesRequest() |
CreateInstancesRequest(CreateInstancesRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
Long |
getAutoRenew()
Get Auto-renewal flag.
|
Long |
getBillingMode()
Get Billing mode.
|
Boolean |
getDryRun()
Get false: send a normal request and create an instance directly after the check is passed (default value); true: send a check request without creating an instance.
|
Long |
getGoodsNum()
Get Number of instances.
|
String |
getInstanceName()
Get Instance name, which can contain up to 60 letters, digits, underscores, or hyphens.
|
Long |
getMemSize()
Get Memory capacity in MB, which must be a multiple of 1,024.
|
Boolean |
getNoAuth()
Get Whether to support the password-free feature.
|
RedisNodeInfo[] |
getNodeSet()
Get Node information of the instance.
|
String |
getPassword()
Get Instance password.
|
Long |
getPeriod()
Get Length of purchase in months, which is required when creating a monthly subscribed instance.
|
String |
getProductVersion()
Get Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition).
|
Long |
getProjectId()
Get Project ID.
|
String |
getRedisClusterId()
Get Dedicated cluster ID, which is required when `ProductVersion` is "cdc".
|
Long |
getRedisReplicasNum()
Get Number of replicas in the instance.
|
Long |
getRedisShardNum()
Get Number of shards in an instance.
|
Boolean |
getReplicasReadonly()
Get Whether to support read-only replicas.
|
ResourceTag[] |
getResourceTags()
Get Tag bound to the instance to be purchased
|
String[] |
getSecurityGroupIdList()
Get Array of security group IDs.
|
String |
getSubnetId()
Get In the classic network, `subnetId` is invalid.
|
String |
getTemplateId()
Get ID of the parameter template applied to the created instance.
|
Long |
getTypeId()
Get Instance type.
|
String |
getVpcId()
Get VPC ID such as vpc-sad23jfdfk.
|
Long |
getVPort()
Get User-defined port.
|
Long |
getZoneId()
Get ID of the AZ where the instance resides.
|
String |
getZoneName()
Get Name of the AZ where the instance resides.
|
void |
setAutoRenew(Long AutoRenew)
Set Auto-renewal flag.
|
void |
setBillingMode(Long BillingMode)
Set Billing mode.
|
void |
setDryRun(Boolean DryRun)
Set false: send a normal request and create an instance directly after the check is passed (default value); true: send a check request without creating an instance.
|
void |
setGoodsNum(Long GoodsNum)
Set Number of instances.
|
void |
setInstanceName(String InstanceName)
Set Instance name, which can contain up to 60 letters, digits, underscores, or hyphens.
|
void |
setMemSize(Long MemSize)
Set Memory capacity in MB, which must be a multiple of 1,024.
|
void |
setNoAuth(Boolean NoAuth)
Set Whether to support the password-free feature.
|
void |
setNodeSet(RedisNodeInfo[] NodeSet)
Set Node information of the instance.
|
void |
setPassword(String Password)
Set Instance password.
|
void |
setPeriod(Long Period)
Set Length of purchase in months, which is required when creating a monthly subscribed instance.
|
void |
setProductVersion(String ProductVersion)
Set Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition).
|
void |
setProjectId(Long ProjectId)
Set Project ID.
|
void |
setRedisClusterId(String RedisClusterId)
Set Dedicated cluster ID, which is required when `ProductVersion` is "cdc".
|
void |
setRedisReplicasNum(Long RedisReplicasNum)
Set Number of replicas in the instance.
|
void |
setRedisShardNum(Long RedisShardNum)
Set Number of shards in an instance.
|
void |
setReplicasReadonly(Boolean ReplicasReadonly)
Set Whether to support read-only replicas.
|
void |
setResourceTags(ResourceTag[] ResourceTags)
Set Tag bound to the instance to be purchased
|
void |
setSecurityGroupIdList(String[] SecurityGroupIdList)
Set Array of security group IDs.
|
void |
setSubnetId(String SubnetId)
Set In the classic network, `subnetId` is invalid.
|
void |
setTemplateId(String TemplateId)
Set ID of the parameter template applied to the created instance.
|
void |
setTypeId(Long TypeId)
Set Instance type.
|
void |
setVpcId(String VpcId)
Set VPC ID such as vpc-sad23jfdfk.
|
void |
setVPort(Long VPort)
Set User-defined port.
|
void |
setZoneId(Long ZoneId)
Set ID of the AZ where the instance resides.
|
void |
setZoneName(String ZoneName)
Set Name of the AZ where the instance resides.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public CreateInstancesRequest()
public CreateInstancesRequest(CreateInstancesRequest source)
public Long getTypeId()
public void setTypeId(Long TypeId)
TypeId
- Instance type. Valid values: `2` (Redis 2.8 Memory Edition in standard architecture), `3` (CKV 3.2 Memory Edition in standard architecture), `4` (CKV 3.2 Memory Edition in cluster architecture), `6` (Redis 4.0 Memory Edition in standard architecture), `7` (Redis 4.0 Memory Edition in cluster architecture), `8` (Redis 5.0 Memory Edition in standard architecture), `9` (Redis 5.0 Memory Edition in cluster architecture), `15` (Redis 6.0 Memory Edition in standard architecture), `16` (Redis 6.0 Memory Edition in cluster architecture)public Long getMemSize()
public void setMemSize(Long MemSize)
MemSize
- Memory capacity in MB, which must be a multiple of 1,024. It is subject to the purchasable specifications returned by the [DescribeProductInfo API](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1).
If `TypeId` is the standard architecture, `MemSize` indicates the total memory capacity of the instance; if `TypeId` is the cluster architecture, `MemSize` indicates the memory capacity per shard.public Long getGoodsNum()
public void setGoodsNum(Long GoodsNum)
GoodsNum
- Number of instances. The actual quantity purchasable at a time is subject to the specifications returned by the [DescribeProductInfo API](https://intl.cloud.tencent.com/document/api/239/30600?from_cn_redirect=1).public Long getPeriod()
public void setPeriod(Long Period)
Period
- Length of purchase in months, which is required when creating a monthly subscribed instance. Valid values: [1,2,3,4,5,6,7,8,9,10,11,12,24,36]. For pay-as-you-go instances, set the parameter to `1`.public Long getBillingMode()
public void setBillingMode(Long BillingMode)
BillingMode
- Billing mode. 0: pay-as-you-gopublic Long getZoneId()
public void setZoneId(Long ZoneId)
ZoneId
- ID of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).public String getPassword()
public void setPassword(String Password)
Password
- Instance password. If the input parameter `NoAuth` is `true` and a VPC is used, the `Password` is optional; otherwise, it is required.
If the instance `TypeId` is Redis 2.8, 4.0, or 5.0, the password cannot start with "/" and must contain 8–30 characters in at least two of the following character types: lowercase letters, uppercase letters, digits, and special symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/).
If the instance `TypeId` is CKV 3.2, the password can contain 8–30 letters and digits.public String getVpcId()
public void setVpcId(String VpcId)
VpcId
- VPC ID such as vpc-sad23jfdfk. If this parameter is not passed in, the classic network will be selected by default. Use the VPC list querying API to query.public String getSubnetId()
public void setSubnetId(String SubnetId)
SubnetId
- In the classic network, `subnetId` is invalid. In a VPC subnet, the value is the subnet ID, such as subnet-fdj24n34j2.public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- Project ID. The value is subject to the `projectId` returned by user account > user account querying APIs > project list.public Long getAutoRenew()
public void setAutoRenew(Long AutoRenew)
AutoRenew
- Auto-renewal flag. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabledpublic String[] getSecurityGroupIdList()
public void setSecurityGroupIdList(String[] SecurityGroupIdList)
SecurityGroupIdList
- Array of security group IDs.public Long getVPort()
public void setVPort(Long VPort)
VPort
- User-defined port. If this parameter is left empty, 6379 will be used by default. Value range: [1024,65535].public Long getRedisShardNum()
public void setRedisShardNum(Long RedisShardNum)
RedisShardNum
- Number of shards in an instance. This parameter is required for Cluster Edition instances. Valid values: [3,5,8,12,16,24,32,64,96,128].public Long getRedisReplicasNum()
public void setRedisReplicasNum(Long RedisReplicasNum)
RedisReplicasNum
- Number of replicas in the instance. Redis 2.8 Standard Edition and CKV Standard Edition support 1 replica. Standard/Cluster Edition 4.0 and 5.0 support 1–5 replicas.public Boolean getReplicasReadonly()
public void setReplicasReadonly(Boolean ReplicasReadonly)
ReplicasReadonly
- Whether to support read-only replicas. Neither Redis 2.8 Standard Edition nor CKV Standard Edition supports read-only replicas. Read/write separation will be automatically enabled for an instance after it enables read-only replicas. Write requests will be directed to the master node and read requests will be distributed to replica nodes. To enable read-only replicas, we recommend you create two or more replicas.public String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName
- Instance name, which can contain up to 60 letters, digits, underscores, or hyphens.public Boolean getNoAuth()
public void setNoAuth(Boolean NoAuth)
NoAuth
- Whether to support the password-free feature. Valid values: true (password-free instance), false (password-enabled instance). Default value: false. Only instances in a VPC support the password-free access.public RedisNodeInfo[] getNodeSet()
public void setNodeSet(RedisNodeInfo[] NodeSet)
NodeSet
- Node information of the instance. Currently, information about the node type (master or replica) and node AZ can be passed in. This parameter is not required for single-AZ deployed instances.public ResourceTag[] getResourceTags()
public void setResourceTags(ResourceTag[] ResourceTags)
ResourceTags
- Tag bound to the instance to be purchasedpublic String getZoneName()
public void setZoneName(String ZoneName)
ZoneName
- Name of the AZ where the instance resides. For more information, see [Regions and AZs](https://intl.cloud.tencent.com/document/product/239/4106?from_cn_redirect=1).public String getTemplateId()
public void setTemplateId(String TemplateId)
TemplateId
- ID of the parameter template applied to the created instance. If this parameter is left blank, the default parameter template will be applied.public Boolean getDryRun()
public void setDryRun(Boolean DryRun)
DryRun
- false: send a normal request and create an instance directly after the check is passed (default value); true: send a check request without creating an instance.public String getProductVersion()
public void setProductVersion(String ProductVersion)
ProductVersion
- Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition). Default value: `local` (local disk edition)public String getRedisClusterId()
public void setRedisClusterId(String RedisClusterId)
RedisClusterId
- Dedicated cluster ID, which is required when `ProductVersion` is "cdc".Copyright © 2023. All rights reserved.