ALIYUN::HBR::BackupClients is used to install backup clients on Elastic Compute Service (ECS) instances.
Syntax
{
"Type": "ALIYUN::HBR::BackupClients",
"Properties": {
"InstanceIds": List,
"Tags": List
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
InstanceIds | List | Yes | No | The IDs of ECS instances on which you want to install backup clients. | You can install backup clients on a maximum of 20 ECS instances at a time. |
Tags | List | No | Yes | The tags that you want to add to the ECS instances. | For more information, see Tags properties. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length, and cannot contain http:// or https:// . The tag key cannot start with aliyun or acs: .
|
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain http:// or https:// . The tag value cannot start with aliyun or acs: .
|
Response parameters
Fn::GetAtt
- InstanceIds: the IDs of ECS instances on which backup clients are installed.
- ClientIds: the IDs of backup clients.
Examples
JSON
format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"InstanceIds": {
"Type": "Json",
"Description": "ID list of instances to install backup client",
"MinLength": 1,
"MaxLength": 20
}
},
"Resources": {
"BackupClients": {
"Type": "ALIYUN::HBR::BackupClients",
"Properties": {
"InstanceIds": {
"Ref": "InstanceIds"
}
}
}
},
"Outputs": {
"InstanceIds": {
"Description": "ID list of instances to install backup client",
"Value": {
"Fn::GetAtt": [
"BackupClients",
"InstanceIds"
]
}
},
"ClientIds": {
"Description": "ID list of clients installed in instances",
"Value": {
"Fn::GetAtt": [
"BackupClients",
"ClientIds"
]
}
}
}
}
YAML
format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
InstanceIds:
Type: Json
Description: ID list of instances to install backup client
MinLength: 1
MaxLength: 20
Resources:
BackupClients:
Type: 'ALIYUN::HBR::BackupClients'
Properties:
InstanceIds:
Ref: InstanceIds
Outputs:
InstanceIds:
Description: ID list of instances to install backup client
Value:
'Fn::GetAtt':
- BackupClients
- InstanceIds
ClientIds:
Description: ID list of clients installed in instances
Value:
'Fn::GetAtt':
- BackupClients
- ClientIds