ALIYUN::VPC::EIP is used to apply for an elastic IP address (EIP).
Syntax
{
"Type": "ALIYUN::VPC::EIP",
"Properties": {
"DeletionProtection": Boolean,
"Name": String,
"Tags": List,
"Isp": String,
"Netmode": String,
"Period": Number,
"ResourceGroupId": String,
"AutoPay": Boolean,
"InstanceChargeType": String,
"PricingCycle": String,
"Bandwidth": Number,
"InternetChargeType": String,
"Description": String,
"SecurityProtectionTypes": List,
"PublicIpAddressPoolId": String,
"Zone": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
DeletionProtection | Boolean | No | No | Specifies whether to enable deletion protection. | Valid values:
|
Name | String | No | Yes | The name of the EIP. | The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter and cannot start with |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None. |
Netmode | String | No | No | The network type of the EIP. | Set the value to public. A value of public specifies that data is transferred over the Internet. |
Bandwidth | Number | No | Yes | The bandwidth of the EIP. | Default value: 5. Unit: Mbit/s. If you leave this property empty, the default value is used. |
InternetChargeType | String | No | No | The metering method of the EIP. | Valid values:
|
InstanceChargeType | String | No | No | The billing method of the EIP. | Valid values:
|
PricingCycle | String | No | No | The billing cycle of the EIP. | Valid values:
Note This property must be specified when InstanceChargeType is set to Prepaid. |
Period | Number | No | No | The subscription duration of the EIP. | Valid values:
Default value: 1. Note This property must be specified when InstanceChargeType is set to Prepaid. |
AutoPay | Boolean | No | No | Specifies whether to enable automatic payment. | Valid values:
Note This property must be specified when InstanceChargeType is set to Prepaid. |
Isp | String | No | No | The line type. | Valid values:
BGP (Multi-ISP) lines are supported in all regions. BGP (Multi-ISP) Pro lines are supported only in the China (Hong Kong) region. |
Description | String | No | Yes | The description of the EIP. | The description must be 2 to 256 characters in length. The description must start with a letter and cannot start with |
Tags | List | No | Yes | The tags of the EIP. | You can add up to 20 tags. Each tag is a key-value pair. You can leave the tag value empty. For more information, see Tags syntax and Tags properties. |
SecurityProtectionTypes | List | No | No | The editions of Anti-DDoS. | Valid values:
Note You can configure up to 10 editions of Anti-DDoS. |
PublicIpAddressPoolId | String | No | No | The ID of the IP address pool. | EIPs are allocated from the IP address pool that you specify. The IP address pool feature is available only to users whose accounts are granted the required permissions for trial use. To use the feature, submit a ticket. |
Zone | String | No | No | The zone of the EIP. | None. |
Tags syntax
"Tags": [
{
"Key": String,
"Value": 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 |
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain |
Return values
Fn::GetAtt
EipAddress: the allocated EIP.
AllocationId: the ID of the instance to which the EIP is allocated.
OrderId: the ID of the order. This property is returned only if InstanceChargeType is set to Prepaid.
Isp: the line type.