SecurityGroup
This class encapsulates and extends the ROS resource type ALIYUN::ECS::SecurityGroup
, which is used to create a security group.
Initializers
import ros_cdk_ecs
ros_cdk_ecs.SecurityGroup(
scope: Construct,
id: str,
description: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
security_group_egress: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SecurityGroupEgressProperty]]] = None,
security_group_ingress: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SecurityGroupIngressProperty]]] = 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. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: Description of the security group, [2, 256] characters. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: Resource group id. |
security_group_egress |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SecurityGroupEgressProperty]]] |
Property securityGroupEgress: egress rules for the security group. |
security_group_ingress |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SecurityGroupIngressProperty]]] |
Property securityGroupIngress: Ingress rules for the security group. |
security_group_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property securityGroupName: Display name of the security group, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'. |
security_group_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property securityGroupType: The type of the security group. |
tags |
typing.List[TagsProperty] |
Property tags: Tags to attach to security group. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: Physical ID of the VPC. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: Description of the security group, [2, 256] characters.
Do not fill or empty, the default is empty.
resource_group_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Resource group id.
security_group_egress
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SecurityGroupEgressProperty]]]
Property securityGroupEgress: egress rules for the security group.
security_group_ingress
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SecurityGroupIngressProperty]]]
Property securityGroupIngress: Ingress rules for the security group.
security_group_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property securityGroupName: Display name of the security group, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
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
tags
Optional
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to security group.
Max support 20 tags to add during create security group. Each tag with two properties Key and Value, and Key is required.
vpc_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: Physical ID of the VPC.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_ecs
ros_cdk_ecs.SecurityGroup.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_id |
ros_cdk_core.IResolvable |
Attribute SecurityGroupId: generated security group id for security group. |
attr_security_group_name |
ros_cdk_core.IResolvable |
Attribute SecurityGroupName: The name of security 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_security_group_id
Required
attr_security_group_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute SecurityGroupId: generated security group id for security group.
attr_security_group_name
Required
attr_security_group_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute SecurityGroupName: The name of security group.