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 com.aliyun.ros.cdk.vpc.PublicIpAddressPool;
PublicIpAddressPool.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
// .bizType(java.lang.String)
// .bizType(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .isp(java.lang.String)
// .isp(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .securityProtectionTypes(IResolvable)
// .securityProtectionTypes(java.util.List<java.lang.String)
// .securityProtectionTypes(IResolvable>)
// .tags(java.util.List<TagsProperty>)
// .zones(IResolvable)
// .zones(java.util.List<java.lang.String)
// .zones(IResolvable>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
bizType | java.lang.String OR com.aliyun.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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the IP address pool. |
isp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property isp: The line type. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the IP address pool. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group that the IP address pool belongs to. |
securityProtectionTypes | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property securityProtectionTypes: Safety protection level. |
tags | java.util.List<TagsProperty> | Property tags: The list of container group tags in the form of key\/value pairs. |
zones | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property zones: The available areas of the IP address pool. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
bizTypeOptional
- Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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:\/\/.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group that the IP address pool belongs to.
securityProtectionTypesOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
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: java.util.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: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
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.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vpc.PublicIpAddressPool;
PublicIpAddressPool.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrPublicIpAddressPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicIpAddressPoolId: Example ID of the IP address pool. |
props | PublicIpAddressPoolProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrPublicIpAddressPoolIdRequired
public java.lang.Object getAttrPublicIpAddressPoolId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicIpAddressPoolId: Example ID of the IP address pool.
propsRequired
public PublicIpAddressPoolProps getProps();
- Type: PublicIpAddressPoolProps