PublicIpAddressPools
- Implements: ros_cdk_vpc.datasource.IPublicIpAddressPools
This class encapsulates and extends the ROS resource type DATASOURCE::VPC::PublicIpAddressPools.
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. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
ispOptional
- 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_nameOptional
- 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_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 IP address pool belongs.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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
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
- 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. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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 | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PublicIpAddressPoolIds: The list of public ip address pool IDs. |
attr_public_ip_address_pools | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PublicIpAddressPools: The list of public ip address pools. |
props | PublicIpAddressPoolsProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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_public_ip_address_pool_idsRequired
attr_public_ip_address_pool_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PublicIpAddressPoolIds: The list of public ip address pool IDs.
attr_public_ip_address_poolsRequired
attr_public_ip_address_pools: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PublicIpAddressPools: The list of public ip address pools.
propsRequired
props: PublicIpAddressPoolsProps