AddressBook

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::AddressBook, which is used to create an address book that is used for access control.

Address books include IP address books, Elastic Compute Service (ECS) tag-based address books, port address books, and domain address books.

Initializers

import ros_cdk_cloudfw
ros_cdk_cloudfw.AddressBook(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable],
  group_name: typing.Union[str, IResolvable],
  group_type: typing.Union[str, IResolvable],
  address_list: typing.Union[str, IResolvable] = None,
  auto_add_tag_ecs: typing.Union[bool, IResolvable] = None,
  region_id: typing.Union[str, IResolvable] = None,
  tag_list: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TagListProperty]]] = None,
  tag_relation: 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.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: Address book description.
group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property groupName: Name Address book.
group_type	typing.Union[str, ros_cdk_core.IResolvable]	Property groupType: Type the address book, the optional values ​​are: ip: IP Address Book domain: domain name address book port: Port Address Book tag: ECS label address book.
address_list	typing.Union[str, ros_cdk_core.IResolvable]	Property addressList: Address list of the address book, between multiple addresses separated by commas.
auto_add_tag_ecs	typing.Union[bool, ros_cdk_core.IResolvable]	Property autoAddTagEcs: Whether to automatically add new ECS public network IP matching tags to the address book.
region_id	typing.Union[str, ros_cdk_core.IResolvable]	Property regionId: Region ID.
tag_list	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]]	Property tagList:.
tag_relation	typing.Union[str, ros_cdk_core.IResolvable]	Property tagRelation: The relationship between the labels to be matched more ECS.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

description^Required

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

Property description: Address book description.

---

group_name^Required

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

Property groupName: Name Address book.

---

group_type^Required

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

Property groupType: Type the address book, the optional values ​​are: ip: IP Address Book domain: domain name address book port: Port Address Book tag: ECS label address book.

---

address_list^Optional

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

Property addressList: Address list of the address book, between multiple addresses separated by commas.

Note: When GroupType ip, it must be set to port or domain. When GroupType as ip, address list, fill in the IP address. For example: 1.2.3.4/32, 1.2.3.0/24 When GroupType for the port, the address list to fill in ports or port ranges. For example: 80, 100/200 When GroupType for the domain, the domain name to fill in the address list. For example: demo1.aliyun.com, demo2.aliyun.com

---

auto_add_tag_ecs^Optional

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

Property autoAddTagEcs: Whether to automatically add new ECS public network IP matching tags to the address book.

Default to false.

---

region_id^Optional

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

Property regionId: Region ID.

Default to cn-hangzhou.

---

tag_list^Optional

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

Property tagList:.

---

tag_relation^Optional

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

Property tagRelation: The relationship between the labels to be matched more ECS.

and: the relationship between multiple labels "and" that matches both ECS IP public network more tags will be added to the address book. or: a plurality of inter-labeled "or" relationship, i.e., as long as a matching tag ECS ​​public IP address book will be added.

---

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_cloudfw
ros_cdk_cloudfw.AddressBook.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_group_uuid	ros_cdk_core.IResolvable	Attribute GroupUuid: After a successful return to the address book to add unique identification ID.

---

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

attr_group_uuid: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GroupUuid: After a successful return to the address book to add unique identification ID.

---