Addresses

• Implements: ros_cdk_vpc.datasource.IAddresses

This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Addresses.

Initializers

from ros_cdk_vpc import datasource
datasource.Addresses(
  scope: Construct,
  id: str,
  address_name: typing.Union[str, IResolvable] = None,
  allocation_id: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  ip_address: typing.Union[str, IResolvable] = None,
  isp: typing.Union[str, IResolvable] = None,
  payment_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  segment_instance_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

address_name^Optional

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

Property addressName: The name of the EIP.

allocation_id^Optional

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

Property allocationId: The ID of the EIP that you want to query.

instance_id^Optional

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

Property instanceId: The ID of the cloud resource.

instance_type^Optional

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

Property instanceType: The type of the current bound instance.

• EcsInstance: an ECS instance of the VPC type.
• SlbInstance: an SLB instance of the VPC type.
• Nat:NAT gateway.
• HaVip: a highly available virtual IP address.
• NetworkInterface: Secondary ENI.

ip_address^Optional

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

Property ipAddress: The IP address pool to which the EIP that you want to query belongs.

isp^Optional

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

Property isp: The line type.

Valid values: BGP (default): BGP (Multi-ISP) lines. All regions support BGP (Multi-ISP) EIPs. BGP_PRO: BGP (Multi-ISP) Pro lines. Only the following regions support BGP (Multi-ISP) Pro lines: China (Hong Kong), Singapore, Malaysia (Kuala Lumpur), Philippines (Manila), Indonesia (Jakarta), and Thailand (Bangkok). For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types. If you are allowed to use single-ISP bandwidth, you can also choose one of the following values: 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 your services are deployed in China East 1 Finance, you must set this parameter to BGP_FinanceCloud.

payment_type^Optional

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

Property paymentType: The billing method of the EIP.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.

segment_instance_id^Optional

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

Property segmentInstanceId: The ID of the consecutive EIPs.

This parameter value is returned only if the EIP is a continuous EIP.

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

from ros_cdk_vpc import datasource
datasource.Addresses.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_addresses^Required

attr_addresses: typing.Union[str, IResolvable]

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

Attribute Addresses: The details about the EIP.

attr_allocation_ids^Required

attr_allocation_ids: typing.Union[str, IResolvable]

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

Attribute AllocationIds: The list of allocation IDs.

props^Required

props: AddressesProps

• Type: AddressesProps