Address

This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Address, which is used to query the information about a created elastic IP address (EIP).

Initializers

from ros_cdk_vpc import datasource
datasource.Address(
  scope: Construct,
  id: str,
  allocation_id: typing.Union[str, IResolvable],
  refresh_options: 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: The ID of the EIP instance.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

allocation_id^Required

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

Property allocationId: The ID of the EIP instance.

---

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.

---

enable_resource_property_constraint^Optional

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

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

from ros_cdk_vpc import datasource
datasource.Address.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_address_name	ros_cdk_core.IResolvable	Attribute AddressName: The name of the EIP.
attr_allocation_id	ros_cdk_core.IResolvable	Attribute AllocationId: The ID of the EIP instance.
attr_bandwidth	ros_cdk_core.IResolvable	Attribute Bandwidth: The peak bandwidth of the EIP.
attr_bandwidth_package_bandwidth	ros_cdk_core.IResolvable	Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP.
attr_bandwidth_package_id	ros_cdk_core.IResolvable	Attribute BandwidthPackageId: The ID of the added shared bandwidth.
attr_bandwidth_package_type	ros_cdk_core.IResolvable	Attribute BandwidthPackageType: The type of bandwidth.
attr_business_status	ros_cdk_core.IResolvable	Attribute BusinessStatus: The business status of the EIP instance.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the EIP was created.
attr_deletion_protection	ros_cdk_core.IResolvable	Attribute DeletionProtection: Whether the delete protection function is turned on.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the EIP instance.
attr_eip_bandwidth	ros_cdk_core.IResolvable	Attribute EipBandwidth: AN EIP is added to an Internet shared bandwidth before or exit purchase an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.
attr_expired_time	ros_cdk_core.IResolvable	Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.
attr_has_reservation_data	ros_cdk_core.IResolvable	Attribute HasReservationData: Whether there is renewal data.
attr_hd_monitor_status	ros_cdk_core.IResolvable	Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP.
attr_instance_id	ros_cdk_core.IResolvable	Attribute InstanceId: The ID of the current bound instance.
attr_instance_region_id	ros_cdk_core.IResolvable	Attribute InstanceRegionId: The region ID of the currently bound resource.
attr_instance_type	ros_cdk_core.IResolvable	Attribute InstanceType: The type of the current bound instance.
attr_ip_address	ros_cdk_core.IResolvable	Attribute IpAddress: The IP address of the EIP.
attr_isp	ros_cdk_core.IResolvable	Attribute Isp: Service providers.
attr_netmode	ros_cdk_core.IResolvable	Attribute Netmode: Network type.
attr_operation_locks	ros_cdk_core.IResolvable	Attribute OperationLocks: Lock details.
attr_payment_type	ros_cdk_core.IResolvable	Attribute PaymentType: The billing method of the EIP.
attr_public_ip_address_pool_id	ros_cdk_core.IResolvable	Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs.
attr_reservation_active_time	ros_cdk_core.IResolvable	Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.
attr_reservation_bandwidth	ros_cdk_core.IResolvable	Attribute ReservationBandwidth: Renewal bandwidth, in Mbps.
attr_reservation_internet_charge_type	ros_cdk_core.IResolvable	Attribute ReservationInternetChargeType: Renewal Payment type.
attr_reservation_order_type	ros_cdk_core.IResolvable	Attribute ReservationOrderType: Renewal order type.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.
attr_second_limited	ros_cdk_core.IResolvable	Attribute SecondLimited: Whether a secondary speed limit is configured.
attr_security_protection_types	ros_cdk_core.IResolvable	Attribute SecurityProtectionTypes: Security protection level.
attr_segment_instance_id	ros_cdk_core.IResolvable	Attribute SegmentInstanceId: The ID of the consecutive EIPs.
attr_service_managed	ros_cdk_core.IResolvable	Attribute ServiceManaged: Indicates the resource created for the service account.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tag of the resource.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_address_name^Required

attr_address_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AddressName: The name of the EIP.

---

attr_allocation_id^Required

attr_allocation_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AllocationId: The ID of the EIP instance.

---

attr_bandwidth^Required

attr_bandwidth: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The peak bandwidth of the EIP.

Unit: Mbps.

---

attr_bandwidth_package_bandwidth^Required

attr_bandwidth_package_bandwidth: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BandwidthPackageBandwidth: The bandwidth value of the Internet shared bandwidth added to the EIP.

The unit is Mbps.

---

attr_bandwidth_package_id^Required

attr_bandwidth_package_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BandwidthPackageId: The ID of the added shared bandwidth.

---

attr_bandwidth_package_type^Required

attr_bandwidth_package_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BandwidthPackageType: The type of bandwidth.

Only CommonBandwidthPackage (shared bandwidth) is supported.

---

attr_business_status^Required

attr_business_status: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BusinessStatus: The business status of the EIP instance.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the EIP was created.

---

attr_deletion_protection^Required

attr_deletion_protection: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DeletionProtection: Whether the delete protection function is turned on.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the EIP instance.

---

attr_eip_bandwidth^Required

attr_eip_bandwidth: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EipBandwidth: AN EIP is added to an Internet shared bandwidth before or exit purchase an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.

---

attr_expired_time^Required

attr_expired_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.

---

attr_has_reservation_data^Required

attr_has_reservation_data: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HasReservationData: Whether there is renewal data.

---

attr_hd_monitor_status^Required

attr_hd_monitor_status: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HdMonitorStatus: Whether the second-level monitoring is enabled for the EIP.

---

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the current bound instance.

---

attr_instance_region_id^Required

attr_instance_region_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceRegionId: The region ID of the currently bound resource.

---

attr_instance_type^Required

attr_instance_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute InstanceType: The type of the current bound instance.

---

attr_ip_address^Required

attr_ip_address: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpAddress: The IP address of the EIP.

---

attr_isp^Required

attr_isp: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Isp: Service providers.

---

attr_netmode^Required

attr_netmode: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Netmode: Network type.

---

attr_operation_locks^Required

attr_operation_locks: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OperationLocks: Lock details.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: The billing method of the EIP.

---

attr_public_ip_address_pool_id^Required

attr_public_ip_address_pool_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PublicIpAddressPoolId: The ID of the IP address pool to which the EIP belongs.

---

attr_reservation_active_time^Required

attr_reservation_active_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReservationActiveTime: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.

---

attr_reservation_bandwidth^Required

attr_reservation_bandwidth: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReservationBandwidth: Renewal bandwidth, in Mbps.

---

attr_reservation_internet_charge_type^Required

attr_reservation_internet_charge_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReservationInternetChargeType: Renewal Payment type.

---

attr_reservation_order_type^Required

attr_reservation_order_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReservationOrderType: Renewal order type.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

---

attr_second_limited^Required

attr_second_limited: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecondLimited: Whether a secondary speed limit is configured.

---

attr_security_protection_types^Required

attr_security_protection_types: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecurityProtectionTypes: Security protection level.

---

attr_segment_instance_id^Required

attr_segment_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SegmentInstanceId: The ID of the consecutive EIPs.

---

attr_service_managed^Required

attr_service_managed: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ServiceManaged: Indicates the resource created for the service account.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tag of the resource.

---