SecurityGroups

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::SecurityGroups, which is used to query the basic information about security groups.

Initializers

from ros_cdk_ecs import datasource
datasource.SecurityGroups(
  scope: Construct,
  id: str,
  network_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  security_group_name: typing.Union[str, IResolvable] = None,
  security_group_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: 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.
network_type	typing.Union[str, ros_cdk_core.IResolvable]	Property networkType: The network type of the security group.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group to which the instance belongs.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property securityGroupId: The ID of the security group.
security_group_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property securityGroupIds: The IDs of security groups.
security_group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property securityGroupName: The name of the security group.
security_group_type	typing.Union[str, ros_cdk_core.IResolvable]	Property securityGroupType: The type of the security group.
tags	typing.List[ros_cdk_ecs.datasource.RosSecurityGroups.TagsProperty]	Property tags: Tags of securitygroup.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vpcId: The ID of the virtual private cloud (VPC) to which the security group belongs.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

network_type^Optional

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

Property networkType: The network type of the security group.

Valid values: vpc classic

---

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.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which the instance belongs.

If this parameter is specified to query resources,up to 1,000 resources that belong to the specified resource group can be displayed in the response.

---

security_group_id^Optional

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

Property securityGroupId: The ID of the security group.

---

security_group_ids^Optional

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

Property securityGroupIds: The IDs of security groups.

The value is a JSON array that consists of up to 100 security group IDs. Separate multiple security group IDs with commas (,).

---

security_group_name^Optional

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

Property securityGroupName: The name of the security group.

---

security_group_type^Optional

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

Property securityGroupType: The type of the security group.

Valid values: normal: basic security group enterprise: advanced security group Note If you do not specify this parameter, both basic and advanced security groups are queried.

---

tags^Optional

• Type: typing.List[ros_cdk_ecs.datasource.RosSecurityGroups.TagsProperty]

Property tags: Tags of securitygroup.

---

vpc_id^Optional

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

Property vpcId: The ID of the virtual private cloud (VPC) to which the security group belongs.

---

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_ecs import datasource
datasource.SecurityGroups.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_security_group_ids	ros_cdk_core.IResolvable	Attribute SecurityGroupIds: The list of security group ids.
attr_security_groups	ros_cdk_core.IResolvable	Attribute SecurityGroups: The list of security groups.

---

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

attr_security_group_ids: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecurityGroupIds: The list of security group ids.

---

attr_security_groups^Required

attr_security_groups: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SecurityGroups: The list of security groups.

---