ALIYUN::ECS::Instance類型用於建立ECS執行個體。
文法
{
"Type": "ALIYUN::ECS::Instance",
"Properties": {
"DedicatedHostId": String,
"Period": Number,
"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,
"Password": String,
"PasswordInherit": Boolean,
"InstanceType": String,
"SystemDiskCategory": String,
"UserData": String,
"SystemDiskSize": Number,
"ZoneId": String,
"InternetMaxBandwidthOut": Integer,
"VpcId": String,
"SpotStrategy": String,
"InstanceName": String,
"DeletionProtection": Boolean,
"DeploymentSetId": String,
"SecurityGroupIds": List,
"SecurityGroupId": String,
"SecurityEnhancementStrategy": String,
"SpotPriceLimit": String,
"HpcClusterId": String,
"AllocatePublicIP": Boolean,
"SystemDiskDescription": String,
"SystemDiskPerformanceLevel": String,
"DiskMappings": List,
"SpotInterruptionBehavior": String,
"ZoneIds": List,
"SpotDuration": Integer,
"CreditSpecification": String,
"PrivatePoolOptions": Map,
"StorageSetId": String,
"HttpTokens": String,
"HttpEndpoint": String,
"Tenancy": String,
"StorageSetPartitionNumber": Integer,
"DeploymentSetGroupNo": Integer,
"Affinity": String,
"UseAdditionalService": Boolean,
"ImageFamily": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ResourceGroupId | String | 否 | 是 | 資源群組ID。 | 無 |
SpotInterruptionBehavior | String | 否 | 否 | 搶佔執行個體中斷模式。 | 目前僅支援Terminate(預設)直接釋放執行個體。 |
ZoneIds | List | 否 | 否 | 可用性區域列表。 | 僅在控制台選取參數時生效。 |
SpotDuration | Integer | 否 | 否 | 搶佔式執行個體的保留時間長度。 | 取值範圍:0~6。 單位:小時。
|
SecurityGroupIds | List | 否 | 否 | 安全性群組ID列表。 | SecurityGroupId和SecurityGroupIds僅能指定其中一個。 |
ImageId | String | 否 | 是 | 鏡像ID。包括公用鏡像、自訂鏡像和雲市場鏡像。 | 支援通過模糊的方式指定公用鏡像ID,無需指定一個完整的公用鏡像ID。例如:
|
InstanceType | String | 是 | 是 | ECS執行個體規格。 | 關於ECS執行個體規格的更多資訊,請參見執行個體規格類型系列。 |
SecurityGroupId | String | 否 | 否 | 安全性群組ID。 | SecurityGroupId和SecurityGroupIds僅能指定其中一個。 |
SecurityEnhancementStrategy | String | 否 | 否 | 是否開啟安全強化。 | 取值:
|
Description | String | 否 | 是 | 描述資訊。 | 長度為2~256個字元。 |
InstanceName | String | 否 | 是 | 執行個體名稱。 | 長度為2~128個字元。必須以英文字母或漢字開頭,不能以 如果沒有指定該屬性,預設值為執行個體的InstanceId。 |
Password | String | 否 | 是 | ECS執行個體登入密碼。 | 長度為8~30個字元。必須同時包含大寫英文字母、小寫英文字母、數字和特殊字元中至少三種,支援特殊字元: |
PasswordInherit | Boolean | 否 | 否 | 是否使用鏡像預設的密碼。 | 取值:
說明 使用該屬性時,Password必須為空白,同時您需要確保使用的鏡像已經設定了密碼。 |
HostName | String | 否 | 是 | 雲端服務器的主機名稱。 | 最小長度為2個字元。半形句號(.)和短劃線(-)不能作為主機名稱的首尾字元,且不能連續使用。
|
AllocatePublicIP | Boolean | 否 | 否 | 是否分配公網IP。 | 取值:
說明 如果InternetMaxBandwidthOut取值大於0,則會分配公網IP。 |
PrivateIpAddress | String | 否 | 否 | 在專用網路環境下,指定的內網IP。 | IP地址不能與專用網路下的其它執行個體重複。 |
InternetChargeType | String | 否 | 是 | 訪問公網計費方式。 | 取值:
|
InternetMaxBandwidthOut | Integer | 否 | 是 | 公網出頻寬最大值。 | 取值範圍:0~100。 預設值:0。 單位:Mbps。 |
IoOptimized | String | 否 | 否 | 是否建立I/O最佳化執行個體。 | 取值:
|
DiskMappings | List | 否 | 是 | 需要掛載的資料盤。 | 最多支援16塊資料盤。 更多資訊,請參見DiskMappings文法和DiskMappings屬性。 |
SystemDiskCategory | String | 否 | 是 | 系統硬碟類型。 | 取值:
已停售的執行個體規格且非I/O最佳化執行個體預設值為cloud,否則預設值為cloud_efficiency。 |
SystemDiskDescription | String | 否 | 否 | 系統硬碟描述資訊。 | 無 |
SystemDiskDiskName | String | 否 | 否 | 系統硬碟名稱。 | 長度為2~128個字元。必須以英文字母或漢字開頭,不能以 |
SystemDiskSize | Number | 否 | 是 | 系統硬碟大小。 | 取值範圍:20~500。 單位:GB。 如果使用自訂鏡像建立系統硬碟,需要保證系統硬碟大於自訂鏡像大小。 |
Tags | List | 否 | 是 | 使用者自訂標籤。 | 最多支援20個標籤,格式: |
UserData | String | 否 | 是 | 建立ECS執行個體時傳遞的使用者資料。 | 內容需要限制在16 KB以內,不需要使用Base64轉碼,特殊字元需要使用反斜線(\)轉義。 |
ZoneId | String | 否 | 否 | 可用性區域ID。 | 無 |
HpcClusterId | String | 否 | 否 | 執行個體所屬的HPC叢集ID。 | 無 |
VpcId | String | 否 | 否 | 專用網路ID。 | 無 |
VSwitchId | String | 否 | 否 | 交換器ID。 | 無 |
InstanceChargeType | String | 否 | 否 | ECS執行個體付費類型。 | 取值:
|
Period | Number | 否 | 否 | 付費周期。 | 當InstanceChargeType取值為PrePaid時,Period為必選屬性;當InstanceChargeType取值為PostPaid時,Period為可選屬性。 |
KeyPairName | String | 否 | 是 | ECS執行個體綁定的金鑰組名稱。 | 當執行個體類型為Windows時,請忽略該屬性;當執行個體類型為Linux時,密碼登入方式會被初始化為禁止。為提高執行個體安全性,建議您使用金鑰組的串連方式。 |
RamRoleName | String | 否 | 否 | 執行個體RAM角色名稱。 | 更多資訊,請參見CreateRole和ListRoles。 |
SpotPriceLimit | String | 否 | 否 | 執行個體的每小時最高價格。 | 支援最多3位小數。當SpotStrategy取值為SpotWithPriceLimit時,該屬性生效。 |
SpotStrategy | String | 否 | 否 | 隨用隨付執行個體的競價策略。 | 當InstanceChargeType取值為PostPaid時,SpotStrategy為必選屬性。 取值:
|
DedicatedHostId | String | 否 | 否 | ECS執行個體建立指定Dedicated Host上。 | 您可以通過調用DescribeDedicatedHosts介面查詢Dedicated HostID列表 。由於Dedicated Host不支援建立搶佔式執行個體,指定DedicatedHostId後,請求中的SpotStrategy和SpotPriceLimit設定將被自動忽略。 |
PeriodUnit | String | 否 | 否 | 購買資源的時間長度。 | 取值:
|
AutoRenewPeriod | Number | 否 | 否 | 每次自動續約的時間長度。 | 當AutoRenew取值為True時,AutoRenewPeriod為必選屬性。 取值:
|
AutoRenew | String | 否 | 否 | 是否自動續約。 | 取值:
當InstanceChargeType取值PrePaid時,AutoRenew為必選屬性。 |
DeletionProtection | Boolean | 否 | 是 | 執行個體釋放保護屬性,指定是否支援通過控制台或DeleteInstance介面釋放執行個體。 | 取值:
說明 該屬性僅適用於隨用隨付執行個體,且只能限制手動釋放操作,對系統釋放操作不生效。 |
DeploymentSetId | String | 否 | 否 | 部署集ID。 | 無 |
SystemDiskPerformanceLevel | String | 否 | 是 | 建立ESSD雲端硬碟作為系統硬碟使用時,設定雲端硬碟的效能等級。 | 取值:
關於如何選擇ESSD效能等級,請參見ESSD雲端硬碟。 |
CreditSpecification
| String | 否 | 是 | 設定突發效能執行個體的運行模式。 | 取值:
|
PrivatePoolOptions | Map | 否 | 否 | 執行個體啟動的私人池容量選項。 | 更多資訊,請參考PrivatePoolOptions屬性。 |
StorageSetId | String | 否 | 否 | 儲存集ID。 | 無 |
HttpTokens | String | 否 | 是 | 訪問執行個體中繼資料時是否強制使用加固模式(IMDSv2)。 | 取值:
說明 有關訪問執行個體中繼資料的模式,請參見執行個體中繼資料訪問模式。 |
HttpEndpoint | String | 否 | 是 | 是否啟用執行個體中繼資料的訪問通道。 | 取值範圍:
說明 有關執行個體中繼資料的資訊,請參見ECS執行個體中繼資料概述。 |
Tenancy | String | 否 | 否 | 是否在Dedicated Host上建立執行個體。 | 取值:
|
StorageSetPartitionNumber | Integer | 否 | 否 | 儲存集中的最大分區數量。 | 取值範圍:大於等於2。 |
DeploymentSetGroupNo | Integer | 否 | 否 | 如果您設定的部署集對應的策略為部署集組高可用策略(AvailabilityGroup),可以通過該參數指定執行個體在部署集中的分組號。 | 取值範圍:1~7。 |
Affinity | String | 否 | 否 | Dedicated Host執行個體是否與Dedicated Host關聯。 | 取值:
|
UseAdditionalService | Boolean | 否 | 否 | 是否使用阿里雲提供的虛擬機器系統配置(Windows:NTP、KMS;Linux:NTP、YUM)。 | 取值:
|
ImageFamily | String | 否 | 否 | 鏡像族系名稱。 | 通過設定該參數來擷取當前鏡像族系內最新可用鏡像來建立執行個體。
說明 阿里雲官方鏡像關聯的鏡像族系資訊請參見公用鏡像概述。 |
DiskMappings文法
"DiskMappings": [
{
"Category": String,
"DiskName": String,
"Description": String,
"Device": String,
"SnapshotId": String,
"PerformanceLevel": String,
"Size": String
}
]
DiskMappings屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Size | String | 是 | 否 | 資料盤大小。 | 取值範圍:20~500。 單位:GB。 |
Category | String | 否 | 否 | 資料盤類型。 | 取值:
I/O最佳化執行個體的預設值為cloud_efficiency,非I/O最佳化執行個體的預設值為cloud。 如果自訂鏡像已包含了一個資料盤,那麼建立ECS執行個體時,若要在ROS模板中指定資料盤類型,可以將Category指定為需要的資料盤類型。例如:
|
DiskName | String | 否 | 否 | 資料盤名稱。 | 長度為2~128個字元。必須以英文字母或漢字開頭,不能以 |
Description | String | 否 | 否 | 描述資訊。 | 長度為2~256個字元,不能以 |
Device | String | 否 | 否 | 掛載點。 | 無 |
PerformanceLevel | String | 否 | 否 | 建立ESSD雲端硬碟作為資料盤使用時,設定雲端硬碟的效能等級。 | 取值:
關於如何選擇ESSD效能等級,請參見ESSD雲端硬碟。 |
SnapshotId | String | 否 | 否 | 資料盤使用的快照ID。 | 無 |
Tags文法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標籤鍵。 | 長度為1~128個字元,不能以 |
Value | String | 否 | 否 | 標籤值。 | 長度為0~128個字元,不能以 |
PrivatePoolOptions文法
"PrivatePoolOptions": [
{
"Id": String,
"MatchCriteria": String
}
]
PrivatePoolOptions屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Id | String | 否 | 否 | 私人池ID。即彈性保障服務ID或容量預定服務ID。 | 無 |
MatchCriteria | String | 否 | 否 | 彈性保障服務或容量預定服務在生效後會產生私人池容量,供執行個體啟動時選擇。 | 取值:
以下任一情境,執行個體啟動的私人池容量選項只能取值
|
傳回值
Fn::GetAtt
InstanceId:執行個體ID。由系統產生,執行個體的全域唯一標識。
PrivateIp:VPC類型執行個體的私網IP地址。
InnerIp:Classic類型執行個體的內網IP地址。
PublicIp:Classic類型執行個體的公網IP地址。
ZoneId:可用性區域ID。
HostName:雲端服務器的主機名稱。
PrimaryNetworkInterfaceId:主網卡ID。
SecurityGroupIds:已建立執行個體的安全性群組ID列表。
樣本
建立兩台ECS執行個體(OpsEcsInstance、ProdEcsInstance),並為ProdEcsInstance執行個體完成OpsEcsInstance免密登入操作。
如果您需要對ECS執行個體的Userdata指令碼執行結果進行訊息通知。更多資訊,請參見ALIYUN::ROS::WaitConditionHandle和ALIYUN::ROS::WaitCondition。