Ipam

• Implements: IIpam

This class encapsulates and extends the ROS resource type ALIYUN::VPC::Ipam.

Initializers

import { Ipam } from '@alicloud/ros-cdk-vpc'
new Ipam(scope: Construct, id: string, props: IpamProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: IpamProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

• Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { Ipam } from '@alicloud/ros-cdk-vpc'
Ipam.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the IPAM.

attrDefaultResourceDiscoveryAssociationId^Required

public readonly attrDefaultResourceDiscoveryAssociationId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DefaultResourceDiscoveryAssociationId: After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.

attrDefaultResourceDiscoveryId^Required

public readonly attrDefaultResourceDiscoveryId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.

attrIpamDescription^Required

public readonly attrIpamDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IpamDescription: The description of IPAM.

attrIpamId^Required

public readonly attrIpamId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IpamId: The first ID of the resource.

attrIpamName^Required

public readonly attrIpamName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IpamName: The name of the IPAM.

attrOperatingRegionList^Required

public readonly attrOperatingRegionList: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OperatingRegionList: List of IPAM effective regions.

attrPrivateDefaultScopeId^Required

public readonly attrPrivateDefaultScopeId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default.

attrPublicDefaultScopeId^Required

public readonly attrPublicDefaultScopeId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.

attrResourceDiscoveryAssociationCount^Required

public readonly attrResourceDiscoveryAssociationCount: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrTags^Required

public readonly attrTags: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tag of the IPAM.

props^Required

public readonly props: IpamProps;

• Type: IpamProps