Skip to content

Ipam

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)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props IpamProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired


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.
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.

sessionRequired

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

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount

public addCount(count: number | IResolvable): void

countRequired

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

addDependency

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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 @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the IPAM.
attrDefaultResourceDiscoveryAssociationId @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 @alicloud/ros-cdk-core.IResolvable Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.
attrIpamDescription @alicloud/ros-cdk-core.IResolvable Attribute IpamDescription: The description of IPAM.
attrIpamId @alicloud/ros-cdk-core.IResolvable Attribute IpamId: The first ID of the resource.
attrIpamName @alicloud/ros-cdk-core.IResolvable Attribute IpamName: The name of the IPAM.
attrOperatingRegionList @alicloud/ros-cdk-core.IResolvable Attribute OperatingRegionList: List of IPAM effective regions.
attrPrivateDefaultScopeId @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 @alicloud/ros-cdk-core.IResolvable Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.
attrResourceDiscoveryAssociationCount @alicloud/ros-cdk-core.IResolvable Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tag of the IPAM.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the IPAM.


attrDefaultResourceDiscoveryAssociationIdRequired

public readonly attrDefaultResourceDiscoveryAssociationId: IResolvable;
  • Type: @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.


attrDefaultResourceDiscoveryIdRequired

public readonly attrDefaultResourceDiscoveryId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrIpamDescriptionRequired

public readonly attrIpamDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpamDescription: The description of IPAM.


attrIpamIdRequired

public readonly attrIpamId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpamId: The first ID of the resource.


attrIpamNameRequired

public readonly attrIpamName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpamName: The name of the IPAM.


attrOperatingRegionListRequired

public readonly attrOperatingRegionList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OperatingRegionList: List of IPAM effective regions.


attrPrivateDefaultScopeIdRequired

public readonly attrPrivateDefaultScopeId: IResolvable;
  • Type: @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.


attrPublicDefaultScopeIdRequired

public readonly attrPublicDefaultScopeId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrResourceDiscoveryAssociationCountRequired

public readonly attrResourceDiscoveryAssociationCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrResourceGroupIdRequired

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrTagsRequired

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tag of the IPAM.