Resource Orchestration Service:ALIYUN::ECS::InstanceGroup

Syntax

{
  "Type": "ALIYUN::ECS::InstanceGroup",
  "Properties": {
    "DedicatedHostId": String,
    "ResourceGroupId": String,
    "SystemDiskDescription": String,
    "InstanceChargeType": String,
    "RamRoleName": String,
    "SystemDiskPerformanceLevel": String,
    "ImageId": String,
    "SystemDiskDiskName": String,
    "Tags": List,
    "HostName": String,
    "LaunchTemplateName": String,
    "VSwitchId": String,
    "Period": Number,
    "ZoneIds": List,
    "LaunchTemplateId": String,
    "DeletionProtection": "Boolean",
    "SecurityGroupIds": List,
    "SecurityEnhancementStrategy": String,
    "InternetChargeType": String,
    "InstanceName": String,
    "DeploymentSetId": String,
    "InternetMaxBandwidthOut": Integer,
    "VpcId": String,
    "LaunchTemplateVersion": String,
    "PeriodUnit": String,
    "AutoReleaseTime": String,
    "PrivateIpAddress": String,
    "Description": String,
    "DiskMappings": List,
    "SystemDiskSize": Number,
    "UserData": String,
    "AutoRenew": String,
    "Ipv6Addresses": List,
    "MaxAmount": Integer,
    "SystemDiskAutoSnapshotPolicyId": String,
    "Ipv6AddressCount": Integer,
    "NetworkType": String,
    "SpotPriceLimit": String,
    "InstanceType": String,
    "AllocatePublicIP": "Boolean",
    "SpotStrategy": String,
    "Password": String,
    "PasswordInherit": Boolean,
    "AutoRenewPeriod": Number,
    "KeyPairName": String,
    "IoOptimized": String,
    "ZoneId": String,
    "HpcClusterId": String,
    "SecurityGroupId": String,
    "SystemDiskCategory": String,
    "EniMappings": List,
    "SystemDiskProvisionedIops": Integer,
    "SystemDiskBurstingEnabled": Boolean,
    "SpotInterruptionBehavior": String,
    "SpotDuration": Integer,
    "UpdatePolicy": String,
    "SystemDiskEncrypted": String,
		"SystemDiskEncryptAlgorithm": String,
		"SystemDiskStorageClusterId": String,
		"SystemDiskKMSKeyId": String
  }
}

Properties

DiskMappings syntax

"DiskMappings": [
  {
    "Category": String,
    "DiskName": String,
    "Description": String,
    "Device": String,
    "SnapshotId": String,
    "Size": String,
    "Encrypted": String,
    "KMSKeyId": String,
    "PerformanceLevel": String,
    "AutoSnapshotPolicyId": String,
    "ProvisionedIops": Integer,
    "BurstingEnabled": Boolean
  }
]

DiskMappings properties

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

EniMappings syntax

"EniMappings": [
  {
    "SecurityGroupId": String,
    "VSwitchId": String,
    "Description": String,
    "NetworkInterfaceName": String,
    "PrimaryIpAddress": String
  }
]

EniMappings properties

Return values

Fn::GetAtt

• InstanceIds: the IDs of the instances. An instance ID is a GUID that is generated by the system for an instance.

• PrivateIps: the private IP addresses of instances in the VPC. This property takes effect when NetworkType is set to vpc. The value is a JSON array that can contain up to 100 IP addresses separated by commas (,). Example: ["172.16.XX.XX", "172.16.XX.XX", … "172.16.XX.XX"].

• InnerIps: the private IP addresses of instances in the classic network. This property takes effect when NetworkType is set to classic. The value is a JSON array that can contain up to 100 IP addresses separated by commas (,). Example: ["10.1.XX.XX", "10.1.XX.XX", … "10.1.XX.XX"].

• PublicIps: the public IP addresses of instances in the classic network. This property takes effect when NetworkType is set to classic. The value is a JSON array that can contain up to 100 IP addresses separated by commas (,). Example: ["42.1.XX.XX", "42.1.XX.XX", … "42.1.XX.XX"].

• HostNames: the hostnames of the instances.

• OrderId: the order ID of the instances.

• ZoneIds: the zone IDs of the instances.

• Ipv6AddressIds: the IDs of IPv6 addresses of the instances.

  Note

  The IPv6 address IDs are returned in a list that has two levels of nesting. If an ECS instance does not have an IPv6 address, the element at the relevant position in the list is empty. If none of the ECS instances have an IP address, null is returned.

• Ipv6Addresses: the IPv6 addresses of the instances.

  Note

  The IPv6 addresses are returned in a list that has two levels of nesting. If an ECS instance does not have an IPv6 address, the element at the relevant position in the list is empty. If none of the ECS instances have an IP address, null is returned.

Examples

The following sample code provides examples on how to create the OpsEcsInstance and ProdEcsInstance ECS instances and configure password-free logon for the ProdEcsInstance instance.

If you want to receive signals of the execution results of user-data scripts of the ECS instance, you can configure ALIYUN::ROS::WaitCondition and ALIYUN::ROS::WaitConditionHandle. For more information, see ALIYUN::ROS::WaitConditionHandle and ALIYUN::ROS::WaitCondition.

• YAML format

  ROSTemplateFormatVersion: '2015-09-01'
  Description: Creates VPC ECS instance
  Parameters:
    VpcId:
      AssociationProperty: ALIYUN::ECS::VPC::VPCId
      Type: String
      Description:
        en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
         
      Label:
        en: VPC ID
         
    VSwitchZoneId:
      AssociationProperty: ALIYUN::ECS::Instance:ZoneId
      Type: String
      Description:
         
        en: VSwitch Availability Zone
      Label:
         
        en: VSwitch Availability Zone
    VSwitchId:
      AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
      AssociationPropertyMetadata:
        VpcId: ${VpcId}
        ZoneId: ${VSwitchZoneId}
      Type: String
      Description:
        en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
         
      Label:
        en: VSwitch ID
         
    SecurityGroupId:
      Type: String
      AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
      AssociationPropertyMetadata:
        VpcId: ${VpcId}
      Description:
        en: Please search the business security group ID starting with(sg-xxx)from console-ECS-Network & Security
         
      Label:
        en: Business Security Group ID
         
    InstanceType:
      Type: String
      Description:
         
        en: Fill in the specifications that can be used under the VSwitch availability zone.
      Label:
         
        en: Instance Type
      AssociationProperty: ALIYUN::ECS::Instance::InstanceType
      AssociationPropertyMetadata:
        ZoneId: ${VSwitchZoneId}
    SystemDiskCategory:
      Type: String
      Label:
        en: System Disk Type
         
      Description:
        en: System Disk Type
         
      AssociationProperty: ALIYUN::ECS::Disk::SystemDiskCategory
      AssociationPropertyMetadata:
        ZoneId: ${VSwitchZoneId}
        InstanceType: ${InstanceType}
  Resources:
    OpsEcsInstance:
      Type: ALIYUN::ECS::InstanceGroup
      Properties:
        MaxAmount: 1
        HostName: OpsEcsInstance
        UserData:
          Fn::Sub:
            - |
              #!/bin/bash
              RootPassword=${RootPassword}
              ProdIP=${ProdIP}
              SSHConfig() {
              echo '[ ! -f /root/.ssh/id_rsa.pub ] && ssh-keygen -t rsa -P "" -f ~/.ssh/id_rsa &>/dev/null' >> /tmp/auto_ssh.sh
              echo 'while read line;do' >> /tmp/auto_ssh.sh
              echo '        ip=`echo $line | cut -d " " -f1`' >> /tmp/auto_ssh.sh
              echo '        user_name=`echo $line | cut -d " " -f2`' >> /tmp/auto_ssh.sh
              echo '        pass_word=`echo $line | cut -d " " -f3`' >> /tmp/auto_ssh.sh
              echo 'expect <<EOF' >> /tmp/auto_ssh.sh
              echo '        spawn ssh-copy-id -i /root/.ssh/id_rsa.pub $user_name@$ip' >> /tmp/auto_ssh.sh
              echo '        expect {' >> /tmp/auto_ssh.sh
              echo '                  "yes/no" { send "yes\n";exp_continue}' >> /tmp/auto_ssh.sh
              echo '                  "password" { send "$pass_word\n"}' >> /tmp/auto_ssh.sh
              echo '        }' >> /tmp/auto_ssh.sh
              echo '        expect eof' >> /tmp/auto_ssh.sh
              echo 'EOF' >> /tmp/auto_ssh.sh
              echo 'done < /tmp/host_ip.txt' >> /tmp/auto_ssh.sh
              }
              SetHostsConfig() {
              echo "`ifconfig eth0 | awk '/inet /{print $2}'` root ${RootPassword}" >> /tmp/host_ip.txt
              echo "${ProdIP} root ${RootPassword}" >> /tmp/host_ip.txt
              sh /tmp/auto_ssh.sh
              }
              main() {
              yum install -y expect
              SSHConfig
              SetHostsConfig
              rm -rf /tmp/host_ip.txt
              }
              main
            - ProdIP:
                Fn::Select:
                  - '0'
                  - Fn::GetAtt:
                      - ProdEcsInstance
                      - PrivateIps
              RootPassword: Admin@123!
        VpcId:
          Ref: VpcId
        SecurityGroupId:
          Ref: SecurityGroupId
        VSwitchId:
          Ref: VSwitchId
        ImageId: centos_7
        AllocatePublicIP: false
        InstanceType:
          Ref: InstanceType
        SystemDiskSize: 40
        SystemDiskCategory:
          Ref: SystemDiskCategory
        Password: Admin@123!
    ProdEcsInstance:
      Type: ALIYUN::ECS::InstanceGroup
      Properties:
        MaxAmount: 1
        HostName: ProdEcsInstance
        SystemDiskCategory:
          Ref: SystemDiskCategory
        VpcId:
          Ref: VpcId
        SecurityGroupId:
          Ref: SecurityGroupId
        SystemDiskSize: 40
        ImageId: centos_7
        VSwitchId:
          Ref: VSwitchId
        Password: Admin@123!
        InstanceType:
          Ref: InstanceType
        AllocatePublicIP: false
  Outputs: {}                  

• JSON format

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Description": "Creates VPC ECS instance",
    "Parameters": {
      "VpcId": {
        "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
        "Type": "String",
        "Description": {
          "en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud",
           
        },
        "Label": {
          "en": "VPC ID",
           
        }
      },
      "VSwitchZoneId": {
        "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
        "Type": "String",
        "Description": {
           
          "en": "VSwitch Availability Zone"
        },
        "Label": {
           
          "en": "VSwitch Availability Zone"
        }
      },
      "VSwitchId": {
        "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
        "AssociationPropertyMetadata": {
          "VpcId": "${VpcId}",
          "ZoneId": "${VSwitchZoneId}"
        },
        "Type": "String",
        "Description": {
          "en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query",
           
        },
        "Label": {
          "en": "VSwitch ID",
           
        }
      },
      "SecurityGroupId": {
        "Type": "String",
        "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
        "AssociationPropertyMetadata": {
          "VpcId": "${VpcId}"
        },
        "Description": {
          "en": "Please search the business security group ID starting with(sg-xxx)from console-ECS-Network & Security",
           
        },
        "Label": {
          "en": "Business Security Group ID",
           
        }
      },
      "InstanceType": {
        "Type": "String",
        "Description": {
           
          "en": "Fill in the specifications that can be used under the VSwitch availability zone."
        },
        "Label": {
           
          "en": "Instance Type"
        },
        "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
        "AssociationPropertyMetadata": {
          "ZoneId": "${VSwitchZoneId}"
        }
      },
      "SystemDiskCategory": {
        "Type": "String",
        "Label": {
          "en": "System Disk Type",
           
        },
        "Description": {
          "en": "System Disk Type",
           
        },
        "AssociationProperty": "ALIYUN::ECS::Disk::SystemDiskCategory",
        "AssociationPropertyMetadata": {
          "ZoneId": "${VSwitchZoneId}",
          "InstanceType": "${InstanceType}"
        }
      }
    },
    "Resources": {
      "OpsEcsInstance": {
        "Type": "ALIYUN::ECS::InstanceGroup",
        "Properties": {
          "MaxAmount": 1,
          "HostName": "OpsEcsInstance",
          "UserData": {
            "Fn::Sub": [
              "#!/bin/bash\nRootPassword=${RootPassword}\nProdIP=${ProdIP}\nSSHConfig() {\necho '[ ! -f /root/.ssh/id_rsa.pub ] && ssh-keygen -t rsa -P \"\" -f ~/.ssh/id_rsa &>/dev/null' >> /tmp/auto_ssh.sh\necho 'while read line;do' >> /tmp/auto_ssh.sh\necho '        ip=`echo $line | cut -d \" \" -f1`' >> /tmp/auto_ssh.sh\necho '        user_name=`echo $line | cut -d \" \" -f2`' >> /tmp/auto_ssh.sh\necho '        pass_word=`echo $line | cut -d \" \" -f3`' >> /tmp/auto_ssh.sh\necho 'expect <<EOF' >> /tmp/auto_ssh.sh\necho '        spawn ssh-copy-id -i /root/.ssh/id_rsa.pub $user_name@$ip' >> /tmp/auto_ssh.sh\necho '        expect {' >> /tmp/auto_ssh.sh\necho '                  \"yes/no\" { send \"yes\\n\";exp_continue}' >> /tmp/auto_ssh.sh\necho '                  \"password\" { send \"$pass_word\\n\"}' >> /tmp/auto_ssh.sh\necho '        }' >> /tmp/auto_ssh.sh\necho '        expect eof' >> /tmp/auto_ssh.sh\necho 'EOF' >> /tmp/auto_ssh.sh\necho 'done < /tmp/host_ip.txt' >> /tmp/auto_ssh.sh\n}\nSetHostsConfig() {\necho \"`ifconfig eth0 | awk '/inet /{print $2}'` root ${RootPassword}\" >> /tmp/host_ip.txt\necho \"${ProdIP} root ${RootPassword}\" >> /tmp/host_ip.txt\nsh /tmp/auto_ssh.sh\n}\nmain() {\nyum install -y expect\nSSHConfig\nSetHostsConfig\nrm -rf /tmp/host_ip.txt\n}\nmain\n",
              {
                "ProdIP": {
                  "Fn::Select": [
                    "0",
                    {
                      "Fn::GetAtt": [
                        "ProdEcsInstance",
                        "PrivateIps"
                      ]
                    }
                  ]
                },
                "RootPassword": "Admin@123!"
              }
            ]
          },
          "VpcId": {
            "Ref": "VpcId"
          },
          "SecurityGroupId": {
            "Ref": "SecurityGroupId"
          },
          "VSwitchId": {
            "Ref": "VSwitchId"
          },
          "ImageId": "centos_7",
          "AllocatePublicIP": false,
          "InstanceType": {
            "Ref": "InstanceType"
          },
          "SystemDiskSize": 40,
          "SystemDiskCategory": {
            "Ref": "SystemDiskCategory"
          },
          "Password": "Admin@123!"
        }
      },
      "ProdEcsInstance": {
        "Type": "ALIYUN::ECS::InstanceGroup",
        "Properties": {
          "MaxAmount": 1,
          "HostName": "ProdEcsInstance",
          "SystemDiskCategory": {
            "Ref": "SystemDiskCategory"
          },
          "VpcId": {
            "Ref": "VpcId"
          },
          "SecurityGroupId": {
            "Ref": "SecurityGroupId"
          },
          "SystemDiskSize": 40,
          "ImageId": "centos_7",
          "VSwitchId": {
            "Ref": "VSwitchId"
          },
          "Password": "Admin@123!",
          "InstanceType": {
            "Ref": "InstanceType"
          },
          "AllocatePublicIP": false
        }
      }
    },
    "Outputs": {
    }
  }                    

For more examples, see InstanceGroup.json and InstanceGroup.yml. In the examples, the following resource types are used: ALIYUN::ECS::InstanceGroup, ALIYUN::ECS::InstanceClone, ALIYUN::ECS::Command, and ALIYUN::ECS::Invocation.