ALIYUN::ECS::Command类型用于新建云助手命令。
语法
{
"Type": "ALIYUN::ECS::Command",
"Properties": {
"Name": String,
"WorkingDir": String,
"CommandContent": String,
"Timeout": Integer,
"Type": String,
"Description": String,
"EnableParameter": Boolean,
"Username": String,
"WindowsPasswordName": String,
"ResourceGroupId": String,
"ContainerName": String,
"ContainerId": String,
"RepeatMode": String
"Tags": List
}
}
属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
Name | String | 否 | 是 | 命令名称。 | 长度为1~128个字符。支持全字符集。 |
WorkingDir | String | 否 | 是 | 您创建的命令在ECS实例中运行的目录。 | 默认值:
|
CommandContent | String | 否 | 否 | 命令Base64编码后的内容。 | 该参数的值必须使用Base64编码后传输,且脚本内容的大小在Base64编码之后不能超过16KB。 命令内容支持使用自定义参数形式,具体通过指定参数EnableParameter取值为true启用自定义参数功能:
|
Timeout | Integer | 否 | 是 | 您创建的命令在ECS实例中执行时的超时时间。 | 当因为某种原因无法运行您创建的命令时,会出现超时现象;超时后,会强制终止命令进程,即取消命令的PID。 默认值:60。 单位:秒。 |
Type | String | 是 | 否 | 命令的类型。 | 取值:
|
Description | String | 否 | 是 | 命令描述。 | 长度为1~512个字符。支持全字符集。 |
EnableParameter | Boolean | 否 | 否 | 创建的命令是否使用自定义参数。 | 取值
|
Tags | List | 否 | 否 | 实例的标签。最多支持添加20个标签。 | 更多信息,请参见Tags属性。 |
RepeatMode | String | 否 | 否 | 设置命令执行的方式。 | 取值范围:
默认值:
注意事项:
|
ResourceGroupId | String | 否 | 否 | 命令执行的资源组ID。 | 当指定该参数时:
|
ContainerName | String | 否 | 否 | 容器名称。 | 注意事项:
|
ContainerId | String | 否 | 否 | 容器ID。 | 仅支持64位16进制字符串。支持使用 注意事项:
|
Username | String | 否 | 否 | 在ECS实例中执行命令的用户名称。 | 长度不得超过255个字符。
您也可以指定实例中已存在的其他用户执行命令,以普通用户执行云助手命令更加安全。更多信息,请参见设置普通用户执行云助手命令。 |
WindowsPasswordName | String | 否 | 否 | 在Windows实例中执行命令的用户的密码名称。 | 长度不得超过255个字符。 当您希望以非默认用户(System)在Windows实例中执行命令时,需要同时传入 说明 当您使用Linux实例的root用户或Windows实例的 System用户执行命令时,不需要传递该参数。 |
Tags语法
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
Key | String | 是 | 否 | 标签键。 | 长度为1~128个字符,不能以 |
Value | String | 否 | 否 | 标签值。 | 长度为0~128个字符,不能以 |
返回值
Fn::GetAtt
CommandId:命令ID。
如果您只需要执行一次性命令,请参见ALIYUN::ECS::RunCommand。