Skip to content

EIPAssociation

This class encapsulates and extends the ROS resource type ALIYUN::VPC::EIPAssociation, which is used to associate an elastic IP address (EIP) with a cloud service instance.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.EIPAssociation(
  scope: Construct,
  id: str,
  allocation_id: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  mode: typing.Union[str, IResolvable] = None,
  private_ip_address: 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.
allocation_id typing.Union[str, ros_cdk_core.IResolvable] Property allocationId: EIP instance id to bind.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: ECS\/SLB\/NAT\/HaVip\/ENI instance id to bid the EIP.
mode typing.Union[str, ros_cdk_core.IResolvable] Property mode: The mode of association.
private_ip_address typing.Union[str, ros_cdk_core.IResolvable] Property privateIpAddress: An IP address in the CIDR block of the VSwitch.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

allocation_idRequired

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

Property allocationId: EIP instance id to bind.


instance_idRequired

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

Property instanceId: ECS\/SLB\/NAT\/HaVip\/ENI instance id to bid the EIP.


modeOptional

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

Property mode: The mode of association.

Valid values: NAT(Default): NAT mode. BINDED: Cut-through mode. MULTI_BINDED: Multi-EIP to ENI mode. This is required only when the value of InstanceType is NetworkInterface.


private_ip_addressOptional

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

Property privateIpAddress: An IP address in the CIDR block of the VSwitch.

If you leave the option empty, the system allocates a private IP address according to the VPC ID and VSwitch ID.


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

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.