IpamScope

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

Initializers

import ros_cdk_vpc
ros_cdk_vpc.IpamScope(
  scope: Construct,
  id: str,
  ipam_id: typing.Union[str, IResolvable],
  ipam_scope_description: typing.Union[str, IResolvable] = None,
  ipam_scope_name: typing.Union[str, IResolvable] = None,
  ipam_scope_type: 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.
ipam_id	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamId: The id of the Ipam instance.
ipam_scope_description	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamScopeDescription: The description of the IPAM's scope of action.
ipam_scope_name	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamScopeName: The name of the IPAM scope.
ipam_scope_type	typing.Union[str, ros_cdk_core.IResolvable]	Property ipamScopeType: IPAM scope of action type: private.
tags	typing.List[TagsProperty]	Property tags: Tags of ipam scope.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

ipam_id^Required

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

Property ipamId: The id of the Ipam instance.

---

ipam_scope_description^Optional

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

Property ipamScopeDescription: The description of the IPAM's scope of action.

It must be 2 to 256 characters in length and must start with a lowercase letter, but cannot start with 'http:// 'or 'https. If it is not filled in, it is empty. The default value is empty.

---

ipam_scope_name^Optional

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

Property ipamScopeName: The name of the IPAM scope.

---

ipam_scope_type^Optional

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

Property ipamScopeType: IPAM scope of action type: private.

Currently, only the role scope of the private network is supported.

---

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of ipam scope.

---

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.IpamScope.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 scope.
attr_ipam_id	ros_cdk_core.IResolvable	Attribute IpamId: The id of the Ipam instance.
attr_ipam_scope_description	ros_cdk_core.IResolvable	Attribute IpamScopeDescription: The description of the IPAM's scope of action.
attr_ipam_scope_id	ros_cdk_core.IResolvable	Attribute IpamScopeId: The ID of the IPAM scope.
attr_ipam_scope_name	ros_cdk_core.IResolvable	Attribute IpamScopeName: The name of the IPAM scope.
attr_ipam_scope_type	ros_cdk_core.IResolvable	Attribute IpamScopeType: IPAM scope of action type.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tag of the IPAM scope.

---

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

---

attr_ipam_id^Required

attr_ipam_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamId: The id of the Ipam instance.

---

attr_ipam_scope_description^Required

attr_ipam_scope_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamScopeDescription: The description of the IPAM's scope of action.

---

attr_ipam_scope_id^Required

attr_ipam_scope_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamScopeId: The ID of the IPAM scope.

---

attr_ipam_scope_name^Required

attr_ipam_scope_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamScopeName: The name of the IPAM scope.

---

attr_ipam_scope_type^Required

attr_ipam_scope_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IpamScopeType: IPAM scope of action type.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tag of the IPAM scope.

---