Group

This class encapsulates and extends the ROS resource type ALIYUN::RAM::Group, which is used to create a Resource Access Management (RAM) user group.

Initializers

import ros_cdk_ram
ros_cdk_ram.Group(
  scope: Construct,
  id: str,
  group_name: typing.Union[str, IResolvable],
  comments: typing.Union[str, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  ignore_existing: typing.Union[bool, IResolvable] = None,
  policies: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PoliciesProperty]]] = None,
  policy_attachments: typing.Union[IResolvable, PolicyAttachmentsProperty] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property groupName: Specifies the group name, containing up to 64 characters.
comments	typing.Union[str, ros_cdk_core.IResolvable]	Property comments: Remark information, up to 128 characters or Chinese characters.
deletion_force	typing.Union[bool, ros_cdk_core.IResolvable]	Property deletionForce: Whether force detach the policies attached to the group.
ignore_existing	typing.Union[bool, ros_cdk_core.IResolvable]	Property ignoreExisting: Whether to ignore existing group False: ROS will perform a uniqueness check.If a group with the same name exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If there is a group with the same name, the group creation process will be ignored. If the group is not created by ROS, it will be ignored during update and delete stage.
policies	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PoliciesProperty]]]	Property policies: Describes what actions are allowed on what resources.
policy_attachments	typing.Union[ros_cdk_core.IResolvable, PolicyAttachmentsProperty]	Property policyAttachments: System and custom policy names to attach.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

group_name^Required

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

Property groupName: Specifies the group name, containing up to 64 characters.

---

comments^Optional

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

Property comments: Remark information, up to 128 characters or Chinese characters.

---

deletion_force^Optional

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

Property deletionForce: Whether force detach the policies attached to the group.

Default value is false.

---

ignore_existing^Optional

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

Property ignoreExisting: Whether to ignore existing group False: ROS will perform a uniqueness check.If a group with the same name exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If there is a group with the same name, the group creation process will be ignored. If the group is not created by ROS, it will be ignored during update and delete stage.

---

policies^Optional

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

Property policies: Describes what actions are allowed on what resources.

---

policy_attachments^Optional

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

Property policyAttachments: System and custom policy names to attach.

---

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_ram
ros_cdk_ram.Group.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_name	ros_cdk_core.IResolvable	Attribute GroupName: Id of ram group.

---

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

attr_group_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GroupName: Id of ram group.

---