Skip to content

IpamPoolAllocation

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

Initializers

import ros_cdk_vpc
ros_cdk_vpc.IpamPoolAllocation(
  scope: Construct,
  id: str,
  ipam_pool_id: typing.Union[str, IResolvable],
  cidr: typing.Union[str, IResolvable] = None,
  cidr_mask: typing.Union[typing.Union[int, float], IResolvable] = None,
  ipam_pool_allocation_description: typing.Union[str, IResolvable] = None,
  ipam_pool_allocation_name: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
ipam_pool_id typing.Union[str, ros_cdk_core.IResolvable] Property ipamPoolId: The ID of the IPAM Pool.
cidr typing.Union[str, ros_cdk_core.IResolvable] Property cidr: The allocated address segment.
cidr_mask typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cidrMask: Create a custom reserved network segment from The IPAM address pool by entering a mask.
ipam_pool_allocation_description typing.Union[str, ros_cdk_core.IResolvable] Property ipamPoolAllocationDescription: The description of the ipam pool alloctaion.
ipam_pool_allocation_name typing.Union[str, ros_cdk_core.IResolvable] Property ipamPoolAllocationName: The name of the ipam pool allocation.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ipam_pool_idRequired

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

Property ipamPoolId: The ID of the IPAM Pool.


cidrOptional

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

Property cidr: The allocated address segment.


cidr_maskOptional

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

Property cidrMask: Create a custom reserved network segment from The IPAM address pool by entering a mask.

Enter at least one of Cidr or **CidrMask.


ipam_pool_allocation_descriptionOptional

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

Property ipamPoolAllocationDescription: The description of the ipam pool alloctaion.

It must be 1 to 256 characters in length and must start with an English letter or Chinese character, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.


ipam_pool_allocation_nameOptional

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

Property ipamPoolAllocationName: The name of the ipam pool allocation.

It must be 1 to 128 characters in length and cannot start with 'http:// 'or 'https.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

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

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • 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

nameRequired

  • Type: str

set_metadata

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute Cidr: The allocated address segment.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: Instance creation time.
attr_ipam_pool_allocation_description typing.Union[str, ros_cdk_core.IResolvable] Attribute IpamPoolAllocationDescription: The description of the ipam pool alloctaion.
attr_ipam_pool_allocation_id typing.Union[str, ros_cdk_core.IResolvable] Attribute IpamPoolAllocationId: The instance ID of the ipam pool allocation.
attr_ipam_pool_allocation_name typing.Union[str, ros_cdk_core.IResolvable] Attribute IpamPoolAllocationName: The name of the ipam pool allocation.
attr_ipam_pool_id typing.Union[str, ros_cdk_core.IResolvable] Attribute IpamPoolId: The ID of the IPAM Pool.
attr_resource_owner_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceOwnerId: The ID of the Alibaba Cloud account (primary account) to which the resource belongs.
attr_resource_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceType: The type of resource.
attr_source_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute SourceCidr: The source address segment.
props IpamPoolAllocationProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cidrRequired

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

Attribute Cidr: The allocated address segment.


attr_create_timeRequired

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

Attribute CreateTime: Instance creation time.


attr_ipam_pool_allocation_descriptionRequired

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

Attribute IpamPoolAllocationDescription: The description of the ipam pool alloctaion.


attr_ipam_pool_allocation_idRequired

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

Attribute IpamPoolAllocationId: The instance ID of the ipam pool allocation.


attr_ipam_pool_allocation_nameRequired

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

Attribute IpamPoolAllocationName: The name of the ipam pool allocation.


attr_ipam_pool_idRequired

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

Attribute IpamPoolId: The ID of the IPAM Pool.


attr_resource_owner_idRequired

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

Attribute ResourceOwnerId: The ID of the Alibaba Cloud account (primary account) to which the resource belongs.


attr_resource_typeRequired

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

Attribute ResourceType: The type of resource.


attr_source_cidrRequired

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

Attribute SourceCidr: The source address segment.


propsRequired

props: IpamPoolAllocationProps