Skip to content

Addresses

This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Addresses, which is used to query the information about elastic IP addresses (EIPs).

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
address_name typing.Union[str, ros_cdk_core.IResolvable] Property addressName: The name of the EIP.
allocation_id typing.Union[str, ros_cdk_core.IResolvable] Property allocationId: The ID of the EIP that you want to query.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the cloud resource.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The type of the current bound instance.
ip_address typing.Union[str, ros_cdk_core.IResolvable] Property ipAddress: The IP address pool to which the EIP that you want to query belongs.
isp typing.Union[str, ros_cdk_core.IResolvable] Property isp: The line type.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: The billing method of the EIP.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the EIPs belong.
segment_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property segmentInstanceId: The ID of the consecutive EIPs.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

address_nameOptional

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

Property addressName: The name of the EIP.

allocation_idOptional

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

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

instance_idOptional

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

Property instanceId: The ID of the cloud resource.

instance_typeOptional

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

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

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

ispOptional

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

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

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

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

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

segment_instance_idOptional

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

from ros_cdk_vpc import datasource
datasource.Addresses.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_addresses ros_cdk_core.IResolvable Attribute Addresses: The details about the EIP.
attr_allocation_ids ros_cdk_core.IResolvable Attribute AllocationIds: The list of allocation IDs.

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_addressesRequired 

attr_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Addresses: The details about the EIP.

attr_allocation_idsRequired 

attr_allocation_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AllocationIds: The list of allocation IDs.