PublicIpAddressPool
- Implements: IPublicIpAddressPool
This class encapsulates and extends the ROS resource type ALIYUN::VPC::PublicIpAddressPool, which is used to create an IP address pool.
Initializers
import ros_cdk_vpc
ros_cdk_vpc.PublicIpAddressPool(
scope: Construct,
id: str,
biz_type: typing.Union[str, IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
isp: typing.Union[str, IResolvable] = None,
name: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
security_protection_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
tags: typing.List[TagsProperty] = None,
zones: typing.Union[IResolvable, typing.List[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. |
biz_type | typing.Union[str, ros_cdk_core.IResolvable] | Property bizType: The business type of IP address pool.Value: Cloudbox: Cloud Box.Cloud box users support to select this type. Default (default): default, indicating non -special types. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the IP address pool. |
isp | typing.Union[str, ros_cdk_core.IResolvable] | Property isp: The line type. |
name | typing.Union[str, ros_cdk_core.IResolvable] | Property name: The name of the IP address pool. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group that the IP address pool belongs to. |
security_protection_types | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property securityProtectionTypes: Safety protection level. |
tags | typing.List[TagsProperty] | Property tags: The list of container group tags in the form of key\/value pairs. |
zones | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property zones: The available areas of the IP address pool. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
biz_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property bizType: The business type of IP address pool.Value: Cloudbox: Cloud Box.Cloud box users support to select this type. Default (default): default, indicating non -special types.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the IP address pool.
The description must be 0 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.
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.
nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of the IP address pool.
The name must be 0 to 128 characters in length and cannot start with http:\/\/ or https:\/\/.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group that the IP address pool belongs to.
security_protection_typesOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property securityProtectionTypes: Safety protection level.
When configured as empty, the default is DDOS protection (basic version). When configured as Antiddos_enhanced, it means DDOS protection (enhanced version).
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: The list of container group tags in the form of key\/value pairs.
You can define a maximum of 20 tags for each container group.
zonesOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property zones: The available areas of the IP address pool.
The Biztype value is Cloudbox, that is, when the type of IP address pool is a cloud box, the parameter must be filled.
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
import ros_cdk_vpc
ros_cdk_vpc.PublicIpAddressPool.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_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PublicIpAddressPoolId: Example ID of the IP address pool. |
props | PublicIpAddressPoolProps | 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_idRequired
attr_public_ip_address_pool_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PublicIpAddressPoolId: Example ID of the IP address pool.
propsRequired
props: PublicIpAddressPoolProps
- Type: PublicIpAddressPoolProps