ALIYUN::ENS::Instance is used to create an Edge Node Service (ENS) instance.

Syntax

{
  "Type": "ALIYUN::ENS::Instance",
  "Properties": {
    "AutoRenewPeriod": Integer,
    "KeyPairName": String,
    "PrivateIpAddress": String,
    "UserData": String,
    "IpType": String,
    "SystemDiskSize": Integer,
    "AutoRenew": String,
    "VSwitchId": String,
    "Period": Integer,
    "Quantity": Integer,
    "InternetChargeType": String,
    "ImageId": String,
    "PaymentType": String,
    "DataDiskSize": Integer,
    "EnsRegionId": String,
    "InstanceType": String,
    "HostName": String,
    "InstanceName": String,
    "UniqueSuffix": Boolean,
    "Password": String
  }
}

Properties

Property Type Required Editable Description Constraint
AutoRenewPeriod Integer No No The auto-renewal period for the instance. This parameter is required when the AutoRenew parameter is set to True.

Valid values: 1 to 12.

Unit: months.

KeyPairName String No No The name of the key pair. None
PrivateIpAddress String No No The internal IP address. None
UserData String No No The user data. None
IpType String No No The type of the IP address. Default value: ipv4. Valid values:
  • ipv4
  • ipv6
  • ipv4Andipv6
SystemDiskSize Integer Yes No The size of the system disk. Set the value to a multiple of 10. The minimum value is 20.

Unit: GiB.

Note The system disk size must be larger than the image size.
AutoRenew String No No Specifies whether to enable auto-renewal for the instance. Default value: False. Valid values:
  • True
  • False
VSwitchId String No No The ID of the vSwitch. This parameter is required if the PrivateIpAddress parameter is specified.
Period Integer Yes No The subscription period of the instance. Valid values:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 12

Unit: months.

Quantity Integer Yes No The number of instances. None
InternetChargeType String No No The billing method for network usage. This parameter is required if you create instances for the first time. The existing billing method is used by default if you have created an instance. Valid values:
  • BandwidthByDay: daily peak bandwidth
  • 95BandwidthByMonth: monthly 95th percentile bandwidth
ImageId String Yes No The ID of the image file that is used to create the instance. None
PaymentType String No No The billing method of the instance. Set the value to Subscription.
DataDiskSize Integer Yes No The size of the data disk. Valid values: 20 to 500.

Unit: GiB.

EnsRegionId String Yes No The region ID of the instance. None
InstanceType String Yes No The instance type.

None
HostName String No No The hostname of the instance. The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). It cannot contain periods (.) or contain only digits.
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
InstanceName String No No The name of the instance. The name must be 2 to 128 characters in length and can contain letters, digits, colons(:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

If this parameter is not specified, the instance ID is used.

UniqueSuffix Boolean No No Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter. The sequential suffix ranges from 001 to 999.
Password String No No The password that is used to log on to the instance. The password must be 8 to 30 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ( ) ` ~ ! @ # $ % ^ & * - _ + = | { } [ ] : ; ' < > , . ? /

Response parameters

Fn::GetAtt

  • AutoRenewPeriod: the auto-renewal period for the instance.
  • KeyPairName: the name of the key pair.
  • PrivateIpAddress: the internal IP address.
  • UserData: the user data.
  • IpType: the type of the IP address.
  • InstanceId: the ID of the instance.
  • SystemDiskSize: the size of the system disk.
  • AutoRenew: indicates whether auto-renewal is enabled.
  • VSwitchId: the ID of the vSwitch.
  • Period: the subscription period of the instance.
  • Quantity: the number of instances.
  • InternetChargeType: the billing method for network usage.
  • PublicIps: the list of public IP addresses.
  • PrivateIps: the list of private IP addresses.
  • ImageId: the ID of the image file.
  • PaymentType: the billing method of the instance.
  • DataDiskSize: the size of the data disk.
  • EnsRegionId: the region ID of the instance.
  • InstanceType: the instance type.
  • HostName: the hostname of the instance.
  • InstanceName: the name of the instance.
  • UniqueSuffix: indicates whether sequential suffixes are appended to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter.

Examples

  • YAMLformat

    ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ENSInstance:
    Type: ALIYUN::ENS::Instance
    Properties:
      EnsRegionId: cn-chengdu-telecom-3
      ImageId: centos_6_08_64_20G_alibase_20171208
      InstanceType: ens.sn1.stiny
      InternetChargeType: 95BandwidthByMonth
      Password: Enstest123
      Period: 1
      Quantity: 2
      SystemDiskSize: 20
      DataDiskSize: 20
      PaymentType: Subscription
Outputs: {}

  • JSONformat

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ENSInstance": {
      "Type": "ALIYUN::ENS::Instance",
      "Properties": {
        "EnsRegionId": "cn-chengdu-telecom-3",
        "ImageId": "centos_6_08_64_20G_alibase_20171208",
        "InstanceType": "ens.sn1.stiny",
        "InternetChargeType": "95BandwidthByMonth",
        "Password": "Enstest123",
        "Period": 1,
        "Quantity": 2,
        "SystemDiskSize": 20,
        "DataDiskSize": 20,
        "PaymentType": "Subscription"
      }
    }
  },
  "Outputs": {
  }
}