ALIYUN::ECS::InstanceGroup
更新时间:2020-05-13 15:16:33
ALIYUN::ECS::InstanceGroup类型用于创建一组相同配置的ECS实例。 通过 取值:
说明 如果设置PrivateIpAddress,MaxAmount取值只能为1。
修改该参数,不会影响已创建的实例,新创建的实例会使用修改后的值。 如果使用自定义镜像创建系统盘,需要保证系统盘大于自定义镜像大小。 取值:
说明 该参数即将停止使用,为提高兼容性,请尽量使用其他参数。
Fn::GetAtt语法
{
"Type": "ALIYUN::ECS::InstanceGroup",
"Properties": {
"SystemDiskAutoSnapshotPolicyId": String,
"DedicatedHostId": String,
"Period": Number,
"LaunchTemplateName": String,
"AutoRenew": String,
"RamRoleName": String,
"IoOptimized": String,
"InternetChargeType": String,
"PrivateIpAddress": String,
"KeyPairName": String,
"SystemDiskDiskName": String,
"PeriodUnit": String,
"Description": String,
"Tags": List,
"HostName": String,
"AutoRenewPeriod": Number,
"ImageId": String,
"ResourceGroupId": String,
"InstanceChargeType": String,
"VSwitchId": String,
"EniMappings": List,
"Password": String,
"InstanceType": String,
"MaxAmount": Integer,
"AutoReleaseTime": String,
"SystemDiskCategory": String,
"UserData": String,
"LaunchTemplateId": String,
"LaunchTemplateVersion": String,
"SystemDiskSize": Number,
"ZoneId": String,
"InternetMaxBandwidthOut": Integer,
"VpcId": String,
"SpotStrategy": String,
"InstanceName": String,
"InternetMaxBandwidthIn": Integer,
"DeletionProtection": Boolean,
"DeploymentSetId": String,
"Ipv6AddressCount": Integer,
"SecurityGroupId": String,
"SpotPriceLimit": String,
"HpcClusterId": String,
"AllocatePublicIP": Boolean,
"SystemDiskDescription": String,
"Ipv6Addresses": List,
"NetworkType": String,
"DiskMappings": List,
"SystemDiskPerformanceLevel": String
}
}
属性
属性名称
类型
必须
允许更新
描述
约束
ResourceGroupId
String
否
是
实例所在的企业资源组ID
无
HpcClusterId
String
否
是
实例所属的HPC集群ID
无
MaxAmount
Integer
是
是
一次性创建ECS实例的个数
取值范围:1~100
Description
String
否
是
描述信息
最长256个字符
InstanceType
String
是
是
ECS实例规格
详情请参见ECS实例规格。
ImageId
String
是
是
用于启动ECS实例的镜像ID,包括公共镜像、自定义镜像和云市场镜像。
支持通过模糊的方式指定公共镜像ID,而不需要指定一个完整的公共镜像ID。例如:
详情请参见请求参数。
SecurityGroupId
String
否
否
指定创建实例所属安全组
无
InstanceName
String
否
否
实例名称
最长128个字符。可包含英文、中文、数字、下划线(_)、英文句点(.)和短划线(-)。
name_prefix[begin_number,bits]name_suffix
格式为各个ECS实例指定不同的实例名,详情请参见请求参数
Password
String
否
是
ECS实例登录密码
如果传入Password参数,请使用HTTPS协议调用API,以免发生密码泄露。
:( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? /
HostName
String
否
否
主机名
长度最少2个字符。英文句点(.)和短划线(-)不能作为hostname的首尾字符,且不能连续使用。详情请参见请求参数。
AllocatePublicIP
Boolean
否
否
是否创建公网IP
如果InternetMaxBandwidthOut为0,则不会分配公网IP。
AutoReleaseTime
String
否
否
ECS实例自动释放的时间
时间格式必须遵守ISO8601规范,例如
"yyyy-MM-ddTHH:mm:ssZ"
。释放时间不能超过三年。
PrivateIpAddress
String
否
否
实例私网IP地址
专有网络VPC类型ECS实例设置私网IP地址时,必须从虚拟交换机的空闲网段中选择。
DiskMappings
List
否
是
为ECS实例创建的数据盘
最多创建16块数据盘。
InternetChargeType
String
否
否
公网访问带宽计费方式
取值:
InternetMaxBandwidthIn
Integer
否
否
公网最大入网带宽
InternetMaxBandwidthOut
Integer
否
否
公网出带宽最大值
IoOptimized
String
否
否
是否创建I/O优化实例
取值:
SystemDiskCategory
String
否
是
系统盘类型
取值:
SystemDiskDescription
String
否
是
系统盘描述信息
无
SystemDiskDiskName
String
否
是
系统盘名称
无
SystemDiskSize
Number
否
是
系统盘大小
取值范围:40GB~500GB。
Tags
List
否
是
用户自定义标签
最多支持20个标签,格式:
[{"Key":"tagKey","Value":"tagValue"},{"Key":"tagKey2","Value":"tagValue2"}]
。
UserData
String
否
是
创建ECS实例时传递的用户数据。
内容需要限制在16KB以内。无需用Base64转码,特殊字符需要使用转义符。
ZoneId
String
否
否
可用区ID
无
VpcId
String
否
否
虚拟专有网络ID
无
VSwitchId
String
否
否
交换机ID
无
KeyPairName
String
否
是
ECS实例绑定的密钥对名称
RamRoleName
String
否
是
实例RAM角色名称
您可以调用ListRoles查询实例RAM角色名称,详情请参见CreateRole和ListRoles。
SpotPriceLimit
String
否
否
实例的每小时最高价格
最大支持3位小数。当SpotStrategy为SpotWithPriceLimit时,此参数生效。
SpotStrategy
String
否
否
后付费实例的竞价策略
当InstanceChargeType为PostPaid时,此参数生效。取值:
DedicatedHostId
String
否
否
专有宿主机ID
无
LaunchTemplateName
String
否
是
启动模板名称
无
PeriodUnit
String
否
是
购买资源的时长周期
取值:
AutoRenewPeriod
Number
否
是
每次自动续费的时长
当AutoRenew为True时,此参数为必填参数。
AutoRenew
String
否
是
是否要自动续费
当InstanceChargeType为PrePaid时,此参数生效。取值:
InstanceChargeType
String
否
是
实例的付费方式
取值:
当取值为PrePaid时,您必须确认自己的账号支持余额支付/信用支付,否则将返回InvalidPayMethod错误消息提示。
EniMappings
List
否
是
附加到实例的弹性网卡
附加到实例的弹性网卡个数最多为1个
LaunchTemplateId
String
否
是
启动模板ID
无
LaunchTemplateVersion
String
否
是
启动模板的版本
如果没有指定版本,则使用默认版本。
Period
Number
否
是
购买资源的时长
当InstanceChargeType为PrePaid时,该参数生效且为必选参数。一旦指定了DedicatedHostId,则取值不能超过专有宿主机的订阅时长。
NetworkType
String
否
否
ECS实例网络类型
取值:
DeletionProtection
Boolean
否
否
实例释放保护属性,指定是否支持通过控制台或API(DeleteInstance)释放实例。
取值:
DeploymentSetId
String
否
是
部署集ID
无
Ipv6AddressCount
Integer
否
是
为弹性网卡指定随机生成的IPv6地址数量
不能同时指定参数Ipv6Addresses和Ipv6AddressCount。
Ipv6Addresses
List
否
是
为弹性网卡指定一个或多个IPv6地址
最多指定一个IPv6地址。属性的更改不影响现有实例。不能同时指定Ipv6Addresses和Ipv6AddressCount。
SystemDiskAutoSnapshotPolicyId
String
否
是
系统盘自动快照策略ID
无
SystemDiskPerformanceLevel
String
否
否
创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。
取值:
有关如何选择ESSD性能等级,请参见ESSD云盘。
DiskMappings语法
"DiskMappings": [
{
"Category": String,
"DiskName": String,
"Description": String,
"Device": String,
"SnapshotId": String,
"Size": String,
"Encrypted": String,
"KMSKeyId": String,
"PerformanceLevel": String,
"AutoSnapshotPolicyId": String
}
]
DiskMappings属性
属性名称
类型
必须
允许更新
描述
约束
Size
String
是
否
数据盘大小
单位:GB。
Category
String
否
否
数据盘的类型
取值:
对于I/O优化实例,默认值为cloud_efficiency。对于非I/O优化实例,默认值为cloud。
DiskName
String
否
否
数据盘的名称
最长128个字符。可包含英文、中文、数字、下划线(_)、英文句点(.)和短划线(-)。
Description
String
否
否
数据盘的描述
长度为2~256个字符。不能以
http://
或https://
开头。
Device
String
否
否
数据盘在ECS中的名称。
无
SnapshotId
String
否
否
快照ID
无
Encrypted
Boolean
否
否
数据盘是否加密
取值:
KMSKeyId
String
否
否
数据盘对应的KMS密钥ID
无
AutoSnapshotPolicyId
String
否
是
自动快照策略ID
无
PerformanceLevel
String
否
否
创建ESSD云盘作为数据盘使用时,设置云盘的性能等级。
取值:
有关如何选择ESSD性能等级,请参见ESSD云盘。
Tags语法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags属性
属性名称
类型
必须
允许更新
描述
约束
Key
String
是
否
标签键
长度为1~128个字符,不能以
aliyun
和acs:
开头,不能包含http://
或者https://
。
Value
String
否
否
标签值
长度为0~128个字符,不能以
aliyun
和acs:
开头,不能包含http://
或者https://
。
EniMappings语法
"EniMappings": [
{
"SecurityGroupId": String,
"VSwitchId": String,
"Description": String,
"NetworkInterfaceName": String,
"PrimaryIpAddress": String
}
]
EniMappings属性
属性名称
类型
必须
允许更新
描述
约束
SecurityGroupId
String
是
是
安全组ID
所属的安全组ID必须是同一个VPC下的安全组。
VSwitchId
String
是
否
交换机ID
无
Description
String
否
是
弹性网卡的描述信息
长度为2~256个英文或中文字符,不能以
http://
或https://
开头。
NetworkInterfaceName
String
否
是
弹性网卡名称
http://
或https://
开头。
PrimaryIpAddress
String
否
否
弹性网卡的主私有IP地址
指定的IP必须是在所属交换机的地址段内的空闲地址。如果不指定IP,则默认随机分配该交换机中的空闲地址。
返回值
["172.16.XX.XX", "172.16.XX.XX", … "172.16.XX.XX"]
,最多100个IP,用半角逗号字符隔开。
["10.1.XX.XX", "10.1.XX.XX", … "10.1.XX.XX"]
,最多100个IP,用半角逗号字符隔开。
["42.1.XX.XX", "42.1.XX.XX", … "42.1.XX.XX"]
,最多100个IP,用半角逗号(,)隔开。
示例
{
"ROSTemplateFormatVersion":"2015-09-01",
"Resources":{
"WebServer": {
"Type": "ALIYUN::ECS::InstanceGroup",
"Properties": {
"ImageId":"m-25l0r****",
"InstanceType": "ecs.t1.small",
"SecurityGroupId": "sg-25zwc****",
"ZoneId": "cn-beijing-b",
"MaxAmount":1,
"Tags": [{
"Key": "tiantt",
"Value": "ros"
},{
"Key": "tiantt1",
"Value": "ros1"
}
]
}
}
},
"Outputs": {
"InstanceIds": {
"Value":{"get_attr": ["WebServer","InstanceIds"]}
},
"PublicIps": {
"Value":{"get_attr": ["WebServer","PublicIps"]}
}
}
}