SecurityGroup

• Implements: ISecurityGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECS::SecurityGroup.

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

description^Optional

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

Property description: The description of the security group.

The description must be 2 to 256 characters in length. It cannot start with http:\/\/ or https:\/\/. By default, this parameter is left 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: The name of the security group.

The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:\/\/ or https:\/\/. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

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 Default value: normal.

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: The ID of the VPC in which you want to create the security group.

The VpcId parameter is required only if you want to create security groups of the VPC type.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_ecs
ros_cdk_ecs.SecurityGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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: typing.Union[str, IResolvable]

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

Attribute SecurityGroupId: generated security group id for security group.

attr_security_group_name^Required

attr_security_group_name: typing.Union[str, IResolvable]

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

Attribute SecurityGroupName: The name of security group.

props^Required

props: SecurityGroupProps

• Type: SecurityGroupProps