Skip to content

EIPProps

Properties for defining a EIP.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-eip

Initializer 

import { EIPProps } from '@alicloud/ros-cdk-vpc'
const eIPProps: EIPProps = { ... }

Properties

Name Type Description
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Automatic Payment.
bandwidth number | @alicloud/ros-cdk-core.IResolvable Property bandwidth: Bandwidth for the output network.
deletionProtection boolean | @alicloud/ros-cdk-core.IResolvable Property deletionProtection: Whether to enable deletion protection.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Optional.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: The resource charge type.
internetChargeType string | @alicloud/ros-cdk-core.IResolvable Property internetChargeType: The network charge type.
isp string | @alicloud/ros-cdk-core.IResolvable Property isp: The line type.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the EIP.
netmode string | @alicloud/ros-cdk-core.IResolvable Property netmode: The network type.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.
pricingCycle string | @alicloud/ros-cdk-core.IResolvable Property pricingCycle: Price cycle of the resource.
publicIpAddressPoolId string | @alicloud/ros-cdk-core.IResolvable Property publicIpAddressPoolId: The ID of the IP address pool.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
securityProtectionTypes @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property securityProtectionTypes: The edition of Anti-DDoS.
tags TagsProperty[] Property tags: Tags to attach to eip.
zone string | @alicloud/ros-cdk-core.IResolvable Property zone: Availability zone of the elastic public network IP.

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Automatic Payment.

Default is true.

bandwidthOptional 

public readonly bandwidth: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property bandwidth: Bandwidth for the output network.

Default is 5MB.

deletionProtectionOptional 

public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Optional.

The description of the EIP. The description must be 2 to 256 characters in length. It must start with a letter. It cannot start with http:\/\/ or https:\/\/.

instanceChargeTypeOptional 

public readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceChargeType: The resource charge type.

Default value is Postpaid

internetChargeTypeOptional 

public readonly internetChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property internetChargeType: The network charge type.

Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByBandwidth. PayByTraffic will charge by hour, PayByBandwidth will charge by day.

ispOptional 

public readonly isp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property isp: The line type.

You can set this parameter only when you create a pay-as-you-go EIP. Valid values: BGP: BGP (Multi-ISP) lines. Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines. BGP (Multi-ISP) Pro lines optimize data transmission to China and improve connection quality for international services. Compared with traditional BGP (Multi-ISP) lines, BGP (Multi-ISP) Pro lines can be used to establish direct connections without using international ISP services. Therefore, BGP (Multi-ISP) Pro lines reduce network latency.

nameOptional 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the EIP.

The name must be 2 to 128 characters in length. It must start with a letter. It can contain numbers, periods (.), underscores (_), and hyphens (-). It cannot start with http:\/\/ or https:\/\/

netmodeOptional 

public readonly netmode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property netmode: The network type.

Valid value: public (public network).

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: Prepaid time period.

While choose by pay by month, it could be from 1 to 9 or 12, 24, 36. While choose pay by year, it could be from 1 to 3.

pricingCycleOptional 

public readonly pricingCycle: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property pricingCycle: Price cycle of the resource.

This property has no default value. If ChargeType is specified as Postpaid, this value will be ignore.

publicIpAddressPoolIdOptional 

public readonly publicIpAddressPoolId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property publicIpAddressPoolId: The ID of the IP address pool.

The EIP is allocated from the IP address pool.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

securityProtectionTypesOptional 

public readonly securityProtectionTypes: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property securityProtectionTypes: The edition of Anti-DDoS.

If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro\/Premium is used.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to eip.

Max support 20 tags to add during create eip. Each tag with two properties Key and Value, and Key is required.

zoneOptional 

public readonly zone: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zone: Availability zone of the elastic public network IP.