AddressBook

This class encapsulates and extends the ROS resource type DATASOURCE::CLOUDFW::AddressBook.

Initializers

from ros_cdk_cloudfw import datasource
datasource.AddressBook(
  scope: Construct,
  id: str,
  group_uuid: typing.Union[str, IResolvable],
  refresh_options: 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.
group_uuid	typing.Union[str, ros_cdk_core.IResolvable]	Property groupUuid: The UUID of the address book.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

group_uuid^Required

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

Property groupUuid: The UUID of the address book.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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

from ros_cdk_cloudfw import datasource
datasource.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_address_list	ros_cdk_core.IResolvable	Attribute AddressList: The addresses in the address book.
attr_address_list_count	ros_cdk_core.IResolvable	Attribute AddressListCount: The number of addresses in the address book.
attr_auto_add_tag_ecs	ros_cdk_core.IResolvable	Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the address book.
attr_group_name	ros_cdk_core.IResolvable	Attribute GroupName: The name of the address book.
attr_group_type	ros_cdk_core.IResolvable	Attribute GroupType: The type of the address book.
attr_group_uuid	ros_cdk_core.IResolvable	Attribute GroupUuid: The UUID of the address book.
attr_reference_count	ros_cdk_core.IResolvable	Attribute ReferenceCount: The number of times that the address book is referenced.
attr_tag_relation	ros_cdk_core.IResolvable	Attribute TagRelation: The logical relationship among ECS tags.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The details about the ECS tags that can be automatically added to the address book.

---

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

attr_address_list: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AddressList: The addresses in the address book.

---

attr_address_list_count^Required

attr_address_list_count: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AddressListCount: The number of addresses in the address book.

---

attr_auto_add_tag_ecs^Required

attr_auto_add_tag_ecs: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the address book.

---

attr_group_name^Required

attr_group_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GroupName: The name of the address book.

---

attr_group_type^Required

attr_group_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GroupType: The type of the address book.

---

attr_group_uuid^Required

attr_group_uuid: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GroupUuid: The UUID of the address book.

---

attr_reference_count^Required

attr_reference_count: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReferenceCount: The number of times that the address book is referenced.

---

attr_tag_relation^Required

attr_tag_relation: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute TagRelation: The logical relationship among ECS tags.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The details about the ECS tags that can be automatically added to the address book.

---