Skip to content

SecurityGroupIngress

This class encapsulates and extends the ROS resource type ALIYUN::ECS::SecurityGroupIngress, which is used to create an inbound rule for a security group.

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.SecurityGroupIngress(
  scope: Construct,
  id: str,
  ip_protocol: typing.Union[str, IResolvable],
  port_range: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  ipv6_source_cidr_ip: typing.Union[str, IResolvable] = None,
  nic_type: typing.Union[str, IResolvable] = None,
  policy: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  source_cidr_ip: typing.Union[str, IResolvable] = None,
  source_group_id: typing.Union[str, IResolvable] = None,
  source_group_owner_id: typing.Union[str, IResolvable] = None,
  source_port_range: typing.Union[str, IResolvable] = None,
  source_prefix_list_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.
ip_protocol typing.Union[str, ros_cdk_core.IResolvable] Property ipProtocol: Ip protocol for in rule.
port_range typing.Union[str, ros_cdk_core.IResolvable] Property portRange: Ip protocol relative port range.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the security group rule, [1, 512] characters.
ipv6_source_cidr_ip typing.Union[str, ros_cdk_core.IResolvable] Property ipv6SourceCidrIp: Source IPv6 CIDR address segment.
nic_type typing.Union[str, ros_cdk_core.IResolvable] Property nicType: Network type, could be 'internet' or 'intranet'.
policy typing.Union[str, ros_cdk_core.IResolvable] Property policy: Authorization policies, parameter values can be: accept (accepted access), drop (denied access).
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: Authorization policies priority range[1, 100].
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Id of the security group.
source_cidr_ip typing.Union[str, ros_cdk_core.IResolvable] Property sourceCidrIp: The source IPv4 CIDR block to which you want to control access.
source_group_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceGroupId: Source Group Id.
source_group_owner_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceGroupOwnerId: Source Group Owner Account ID.
source_port_range typing.Union[str, ros_cdk_core.IResolvable] Property sourcePortRange: The range of the ports enabled by the source security group for the transport layer protocol.
source_prefix_list_id typing.Union[str, ros_cdk_core.IResolvable] Property sourcePrefixListId: The ID of the source prefix list to which you want to control access.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ip_protocolRequired

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

Property ipProtocol: Ip protocol for in rule.

port_rangeRequired

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

Property portRange: Ip protocol relative port range.

For tcp and udp, the port rang is [1,65535], using format '1/200'For icmp|gre|all protocel, the port range should be '-1/-1'

descriptionOptional

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

Property description: Description of the security group rule, [1, 512] characters.

The default is empty.

ipv6_source_cidr_ipOptional

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

Property ipv6SourceCidrIp: Source IPv6 CIDR address segment.

Supports IP address ranges in CIDR format and IPv6 format. Note Only VPC type IP addresses are supported.

nic_typeOptional

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

Property nicType: Network type, could be 'internet' or 'intranet'.

Default value is internet.

policyOptional

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

Property policy: Authorization policies, parameter values can be: accept (accepted access), drop (denied access).

Default value is accept.

priorityOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property priority: Authorization policies priority range[1, 100].

security_group_idOptional

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

Property securityGroupId: Id of the security group.

source_cidr_ipOptional

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

Property sourceCidrIp: The source IPv4 CIDR block to which you want to control access.

CIDR blocks and IPv4 addresses are supported.

source_group_idOptional

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

Property sourceGroupId: Source Group Id.

source_group_owner_idOptional

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

Property sourceGroupOwnerId: Source Group Owner Account ID.

source_port_rangeOptional

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

Property sourcePortRange: The range of the ports enabled by the source security group for the transport layer protocol.

Valid values: TCP/UDP: Value range: 1 to 65535. The start port and the end port are separated by a slash (/). Correct example: 1/200. Incorrect example: 200/1.ICMP: -1/-1.GRE: -1/-1.ALL: -1/-1.

source_prefix_list_idOptional

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

Property sourcePrefixListId: The ID of the source prefix list to which you want to control access.

You can call the DescribePrefixLists operation to query the IDs of available prefix lists. Take note of the following items:

  • If a security group is in the classic network, you cannot configure prefix lists in the security group rules.
  • If you specify the SourceCidrIp, Ipv6SourceCidrIp, or SourceGroupId parameter, this parameter is ignored.

enable_resource_property_constraintOptional

  • 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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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.SecurityGroupIngress.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource