PublicIpAddressPool
- Implements: @alicloud/ros-cdk-vpc.datasource.IPublicIpAddressPool
This class encapsulates and extends the ROS resource type DATASOURCE::VPC::PublicIpAddressPool, which is used to query the basic information about an available IP address pool.
Initializers
import { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.PublicIpAddressPool(scope: Construct, id: string, props: PublicIpAddressPoolProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | PublicIpAddressPoolProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: PublicIpAddressPoolProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.PublicIpAddressPool.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: Description. |
attrIpAddressRemaining | string | @alicloud/ros-cdk-core.IResolvable | Attribute IpAddressRemaining: Whether there is a free IP address. |
attrIsp | string | @alicloud/ros-cdk-core.IResolvable | Attribute Isp: Service providers. |
attrPublicIpAddressPoolId | string | @alicloud/ros-cdk-core.IResolvable | Attribute PublicIpAddressPoolId: The first ID of the resource. |
attrPublicIpAddressPoolName | string | @alicloud/ros-cdk-core.IResolvable | Attribute PublicIpAddressPoolName: The name of the resource. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags of PrefixList. |
attrTotalIpNum | string | @alicloud/ros-cdk-core.IResolvable | Attribute TotalIpNum: Total ip number of PublicIpAddressPool. |
attrUsedIpNum | string | @alicloud/ros-cdk-core.IResolvable | Attribute UsedIpNum: Used ip number of PublicIpAddressPool. |
props | PublicIpAddressPoolProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: Description.
attrIpAddressRemainingRequired
public readonly attrIpAddressRemaining: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IpAddressRemaining: Whether there is a free IP address.
attrIspRequired
public readonly attrIsp: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Isp: Service providers.
attrPublicIpAddressPoolIdRequired
public readonly attrPublicIpAddressPoolId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PublicIpAddressPoolId: The first ID of the resource.
attrPublicIpAddressPoolNameRequired
public readonly attrPublicIpAddressPoolName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PublicIpAddressPoolName: The name of the resource.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags of PrefixList.
attrTotalIpNumRequired
public readonly attrTotalIpNum: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute TotalIpNum: Total ip number of PublicIpAddressPool.
attrUsedIpNumRequired
public readonly attrUsedIpNum: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UsedIpNum: Used ip number of PublicIpAddressPool.
propsRequired
public readonly props: PublicIpAddressPoolProps;
- Type: PublicIpAddressPoolProps