Skip to content

EIPPro

This class encapsulates and extends the ROS resource type ALIYUN::VPC::EIPPro, which is used to create an elastic IP address (EIP).

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.EIPPro(
  scope: Construct,
  id: str,
  auto_pay: typing.Union[bool, IResolvable] = None,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  ip_address: typing.Union[str, IResolvable] = None,
  isp: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  netmode: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  public_ip_address_pool_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_protection_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Automatic Payment.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: Bandwidth for the output network.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Whether to enable deletion protection.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Optional.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The resource charge type.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the requested EIP.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: The network charge type.
ip_address typing.Union[str, ros_cdk_core.IResolvable] Property ipAddress: The IP address of the requested EIP.
isp typing.Union[str, ros_cdk_core.IResolvable] Property isp: The line type.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the EIP.
netmode typing.Union[str, ros_cdk_core.IResolvable] Property netmode: The network type.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: Prepaid time period.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: Price cycle of the resource.
public_ip_address_pool_id typing.Union[str, ros_cdk_core.IResolvable] Property publicIpAddressPoolId: The ID of the IP address pool.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
security_protection_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityProtectionTypes: The edition of Anti-DDoS.
tags typing.List[TagsProperty] Property tags: Tags to attach to eip.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_payOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoPay: Automatic Payment.

Default is true.

bandwidthOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property bandwidth: Bandwidth for the output network.

Default is 5MB.

deletion_protectionOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional

  • Type: typing.Union[str, 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://.

instance_charge_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceChargeType: The resource charge type.

Default value is Postpaid

instance_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of the requested EIP.

internet_charge_typeOptional

  • Type: typing.Union[str, 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.

ip_addressOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipAddress: The IP address of the requested EIP.

ispOptional

  • Type: typing.Union[str, 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

  • Type: typing.Union[str, 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

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property netmode: The network type.

Valid value: public (public network).

periodOptional

  • Type: typing.Union[typing.Union[int, float], 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.

pricing_cycleOptional

  • Type: typing.Union[str, 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.

public_ip_address_pool_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property publicIpAddressPoolId: The ID of the IP address pool.

The EIP is allocated from the IP address pool.

resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: Resource group id.

security_protection_typesOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, 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

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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_vpc
ros_cdk_vpc.EIPPro.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_allocation_id ros_cdk_core.IResolvable Attribute AllocationId: ID that Aliyun assigns to represent the allocation of the address for use with VPC.
attr_eip_address ros_cdk_core.IResolvable Attribute EipAddress: IP address of created EIP.
attr_isp ros_cdk_core.IResolvable Attribute ISP: The line type.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Order ID of prepaid EIP instance.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_allocation_idRequired 

attr_allocation_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AllocationId: ID that Aliyun assigns to represent the allocation of the address for use with VPC.

Returned only for VPC elastic IP addresses.

attr_eip_addressRequired 

attr_eip_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EipAddress: IP address of created EIP.

attr_ispRequired 

attr_isp: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ISP: The line type.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Order ID of prepaid EIP instance.