EIPSegment

• Implements: IEIPSegment

This class encapsulates and extends the ROS resource type ALIYUN::VPC::EIPSegment, which is used to apply for contiguous elastic IP addresses (EIPs).

Initializers

import ros_cdk_vpc
ros_cdk_vpc.EIPSegment(
  scope: Construct,
  id: str,
  eip_mask: typing.Union[typing.Union[int, float], IResolvable],
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  isp: typing.Union[str, IResolvable] = None,
  netmode: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  zone: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

eip_mask^Required

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

Property eipMask: The mask of the contiguous EIP group.

Valid values: 28: 16 contiguous EIPs are allocated for one call. 27: 32 contiguous EIPs are allocated for one call. 26: 64 contiguous EIPs are allocated for one call. 25: 128 contiguous EIPs are allocated for one call. 24: 256 contiguous EIPs are allocated for one call. Note The actual number of assigned EIPs may be less than the expected number because one, three, or four EIPs may be reserved.

bandwidth^Optional

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

Property bandwidth: The maximum bandwidth of the contiguous EIPs.

Unit: Mbit/s. Default value: 5.

internet_charge_type^Optional

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

Property internetChargeType: The metering method of the contiguous EIPs.

Valid values: PayByBandwidth: Fees are charged based on bandwidth usage. This is the default value. PayByTraffic: Fees are charged based on data transfer. Note If the Netmode parameter is set to hybrid, InternetChargeType is set to PayByBandwidth.

isp^Optional

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

Property isp: The line type.

Valid values:

• BGP (default): BGP (multi-line). All regions support BGP (multi-line) EIPs.
• BGP_PRO: BGP (multi-line)_Premium. Currently supported only in China (Hong Kong), Singapore, Japan (Tokyo), Malaysia (Kuala Lumpur), Philippines (Manila), India (Jakarta), and Thailand (Bangkok).

For more information about BGP (multi-line) and BGP (multi-line)_Premium, see EIP Line Type.

If you are a single-bandwidth whitelist user, you can also choose:

• ChinaTelecom: China Telecom
• ChinaUnicom: China Unicom
• ChinaMobile: China Mobile
• ChinaTelecom_L2: China Telecom L2
• ChinaUnicom_L2: China Unicom L2
• ChinaMobile_L2: China Mobile L2

If you are a Hangzhou Finance Cloud user, this field is required with value: BGP_FinanceCloud.

netmode^Optional

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

Property netmode: The network type.

Valid values: public: the Internet. This is the default value. After contiguous EIPs are associated with cloud resources, the cloud resources can access the Internet by using the EIPs. hybrid: the hybrid cloud. After contiguous EIPs are associated with cloud resources, the cloud resources can access the hybrid cloud by using the EIPs. Note This network type is available only to users who are added to the whitelist. To use this network type, contact your customer manager.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which the EIPs belong.

zone^Optional

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

Property zone: The zone of the contiguous EIP group.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_eip_addresses^Required

attr_eip_addresses: typing.Union[str, IResolvable]

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

Attribute EipAddresses: List of EIP addresses.

like [{"AllocationId": "eip-xxx", "IpAddress": "xx.xx.xx.xx"}]

attr_eip_segment_instance_id^Required

attr_eip_segment_instance_id: typing.Union[str, IResolvable]

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

Attribute EipSegmentInstanceId: The ID of the contiguous EIP group.

props^Required

props: EIPSegmentProps

• Type: EIPSegmentProps