PublicIpAddressPools
This class encapsulates and extends the ROS resource type DATASOURCE::VPC::PublicIpAddressPools
, which is used to query available IP address pools.
Initializers
from ros_cdk_vpc import datasource
datasource.PublicIpAddressPools(
scope: Construct,
id: str,
isp: typing.Union[str, IResolvable] = None,
public_ip_address_pool_name: typing.Union[str, IResolvable] = None,
refresh_options: 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. |
isp |
typing.Union[str, ros_cdk_core.IResolvable] |
Property isp: The line type. |
public_ip_address_pool_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property publicIpAddressPoolName: The name of the IP address pool. |
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 IP address pool belongs. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
isp
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property isp: The line type.
Valid values: BGP (default): BGP (Multi-ISP) lines BGP_PRO: BGP (Multi-ISP) Pro lines 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, this parameter is required and you must set the value to BGP_FinanceCloud.
public_ip_address_pool_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property publicIpAddressPoolName: The name of the IP address pool.
This parameter is optional. The name must be 1 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.
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 IP address pool belongs.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- 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.PublicIpAddressPools.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_public_ip_address_pool_ids |
ros_cdk_core.IResolvable |
Attribute PublicIpAddressPoolIds: The list of public ip address pool IDs. |
attr_public_ip_address_pools |
ros_cdk_core.IResolvable |
Attribute PublicIpAddressPools: The list of public ip address pools. |
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_public_ip_address_pool_ids
Required
attr_public_ip_address_pool_ids: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicIpAddressPoolIds: The list of public ip address pool IDs.
attr_public_ip_address_pools
Required
attr_public_ip_address_pools: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicIpAddressPools: The list of public ip address pools.