Skip to content

EIPSegment

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,
  netmode: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
eip_mask typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property eipMask: The mask of the contiguous EIP group.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The maximum bandwidth of the contiguous EIPs.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: The metering method of the contiguous EIPs.
netmode typing.Union[str, ros_cdk_core.IResolvable] Property netmode: The network type.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the EIPs belong.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

eip_maskRequired

  • 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.

bandwidthOptional

  • 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_typeOptional

  • 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.

netmodeOptional

  • 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_idOptional

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

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

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.EIPSegment.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_eip_addresses ros_cdk_core.IResolvable Attribute EipAddresses: List of EIP addresses.
attr_eip_segment_instance_id ros_cdk_core.IResolvable Attribute EipSegmentInstanceId: The ID of the contiguous EIP group.

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_eip_addressesRequired 

attr_eip_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EipAddresses: List of EIP addresses.

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

attr_eip_segment_instance_idRequired 

attr_eip_segment_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EipSegmentInstanceId: The ID of the contiguous EIP group.