Ipam

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

Initializers

import ros_cdk_vpc
ros_cdk_vpc.Ipam(
  scope: Construct,
  id: str,
  operating_region_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  ipam_description: typing.Union[str, IResolvable] = None,
  ipam_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
operating_region_list	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property operatingRegionList: List of IPAM effective regions.
ipam_description	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamDescription: The description of IPAM.
ipam_name	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamName: The name of the IPAM.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group.
tags	typing.List[TagsProperty]	Property tags: Tags of ipam.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

operating_region_list^Required

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

Property operatingRegionList: List of IPAM effective regions.

---

ipam_description^Optional

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

Property ipamDescription: The description of IPAM.

It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http:// 'or 'https. If the description is not filled in, it is blank. The default value is blank.

---

ipam_name^Optional

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

Property ipamName: The name of the IPAM.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

---

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of ipam.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
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_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The creation time of the IPAM.
attr_default_resource_discovery_association_id	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.
attr_default_resource_discovery_id	ros_cdk_core.IResolvable	Attribute DefaultResourceDiscoveryId: After IPAM is created, the system creates resource discovery by default.
attr_ipam_description	ros_cdk_core.IResolvable	Attribute IpamDescription: The description of IPAM.
attr_ipam_id	ros_cdk_core.IResolvable	Attribute IpamId: The first ID of the resource.
attr_ipam_name	ros_cdk_core.IResolvable	Attribute IpamName: The name of the IPAM.
attr_operating_region_list	ros_cdk_core.IResolvable	Attribute OperatingRegionList: List of IPAM effective regions.
attr_private_default_scope_id	ros_cdk_core.IResolvable	Attribute PrivateDefaultScopeId: After an IPAM is created, the scope of the private network IPAM created by the system by default.
attr_public_default_scope_id	ros_cdk_core.IResolvable	Attribute PublicDefaultScopeId: After an IPAM is created, the public network IPAM is created by default.
attr_resource_discovery_association_count	ros_cdk_core.IResolvable	Attribute ResourceDiscoveryAssociationCount: The number of resource discovery objects associated with IPAM.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tag of the IPAM.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the IPAM.

---

attr_default_resource_discovery_association_id^Required

attr_default_resource_discovery_association_id: IResolvable

• Type: 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.

---

attr_default_resource_discovery_id^Required

attr_default_resource_discovery_id: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_ipam_description^Required

attr_ipam_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamDescription: The description of IPAM.

---

attr_ipam_id^Required

attr_ipam_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamId: The first ID of the resource.

---

attr_ipam_name^Required

attr_ipam_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamName: The name of the IPAM.

---

attr_operating_region_list^Required

attr_operating_region_list: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OperatingRegionList: List of IPAM effective regions.

---

attr_private_default_scope_id^Required

attr_private_default_scope_id: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_public_default_scope_id^Required

attr_public_default_scope_id: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_resource_discovery_association_count^Required

attr_resource_discovery_association_count: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tag of the IPAM.

---