IpamPool

• Implements: IIpamPool

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

Initializers

import ros_cdk_vpc
ros_cdk_vpc.IpamPool(
  scope: Construct,
  id: str,
  ipam_scope_id: typing.Union[str, IResolvable],
  allocation_default_cidr_mask: typing.Union[typing.Union[int, float], IResolvable] = None,
  allocation_max_cidr_mask: typing.Union[typing.Union[int, float], IResolvable] = None,
  allocation_min_cidr_mask: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_import: typing.Union[bool, IResolvable] = None,
  ipam_pool_description: typing.Union[str, IResolvable] = None,
  ipam_pool_name: typing.Union[str, IResolvable] = None,
  ipv6_isp: typing.Union[str, IResolvable] = None,
  ip_version: typing.Union[str, IResolvable] = None,
  pool_region_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  source_ipam_pool_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

ipam_scope_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipamScopeId: The ID of the IPAM scope.

This parameter is required.

allocation_default_cidr_mask^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property allocationDefaultCidrMask: The default CIDR mask for allocation.

allocation_max_cidr_mask^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property allocationMaxCidrMask: The maximum CIDR mask for allocation.

allocation_min_cidr_mask^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property allocationMinCidrMask: The minimum CIDR mask for allocation.

auto_import^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoImport: Whether to automatically import the IPAM pool.

ipam_pool_description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipamPoolDescription: The description of the IPAM pool.

ipam_pool_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipamPoolName: The name of the IPAM pool.

ipv6_isp^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipv6Isp: The IPv6 ISP for the IPAM pool.

ip_version^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipVersion: The IP version of the IPAM pool.

Valid values: IPv4, IPv6.

pool_region_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property poolRegionId: The ID of the region where the IPAM pool is located.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group to which the IPAM pool belongs.

source_ipam_pool_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sourceIpamPoolId: The ID of the source IPAM pool.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: The tags of the IPAM pool.

The maximum length is 21.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vpc
ros_cdk_vpc.IpamPool.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_ipam_pool_id^Required

attr_ipam_pool_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IpamPoolId: The ID of the IPAM pool.

props^Required

props: IpamPoolProps

• Type: IpamPoolProps