ACLRule

• Implements: IACLRule

This class encapsulates and extends the ROS resource type ALIYUN::SAG::ACLRule.

Initializers

import ros_cdk_sag
ros_cdk_sag.ACLRule(
  scope: Construct,
  id: str,
  acl_id: typing.Union[str, IResolvable],
  dest_cidr: typing.Union[str, IResolvable],
  dest_port_range: typing.Union[str, IResolvable],
  direction: typing.Union[str, IResolvable],
  ip_protocol: typing.Union[str, IResolvable],
  policy: typing.Union[str, IResolvable],
  source_cidr: typing.Union[str, IResolvable],
  source_port_range: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  dpi_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  dpi_signature_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  name: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

acl_id^Required

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

Property aclId: Access control ID.

dest_cidr^Required

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

Property destCidr: Destination address, CIDR format and IP address range in IPv4 format.

dest_port_range^Required

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

Property destPortRange: The destination port range.

Valid values: -1 and 1 to 65535. Use the format 1/200 or 80/80. A value of -1/-1 means all ports.

direction^Required

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

Property direction: The direction of traffic to which the ACL rule applies.

Valid values:

• in: inbound. Traffic from an external network to the local branch where the SAG instance is deployed.
• out: outbound. Traffic from the local branch where the SAG instance is deployed to an external network.

ip_protocol^Required

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

Property ipProtocol: Protocol, not case sensitive.

policy^Required

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

Property policy: Access: accept|drop.

source_cidr^Required

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

Property sourceCidr: Source address, CIDR format and IP address range in IPv4 format.

source_port_range^Required

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

Property sourcePortRange: The source port range.

Valid values: -1 and 1 to 65535. Use the format 1/200 or 80/80. A value of -1/-1 means all ports.

description^Optional

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

Property description: Rule description information, ranging from 1 to 512 characters.

dpi_group_ids^Optional

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

Property dpiGroupIds: The ID of the application group.

You can enter at most 100 application group IDs at a time. You can call the ListDpiGroups operation to query application group IDs and information about the applications.

dpi_signature_ids^Optional

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

Property dpiSignatureIds: The ID of the application.

You can enter at most 100 application IDs at a time. You can call the ListDpiSignatures operation to query application IDs and information about the applications.

name^Optional

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

Property name: The name of the ACL rule.

The name must be 2 to 100 characters in length, start with a letter, and can contain digits, periods (.), underscores (_), and hyphens (-).

priority^Optional

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

Property priority: The priority of the ACL rule.

A smaller value indicates a higher priority. If multiple rules have the same priority, the rule that is first delivered to the Smart Access Gateway device takes precedence. Valid values: 1 to 100. Default value: 1.

type^Optional

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

Property type: The type of the ACL rule: Valid values: LAN: The ACL rule controls traffic of private IP addresses.

This is the default value. WAN: The ACL rule controls traffic of public IP addresses.

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_sag
ros_cdk_sag.ACLRule.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_acr_id^Required

attr_acr_id: typing.Union[str, IResolvable]

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

Attribute AcrId: Access control rule ID.

props^Required

props: ACLRuleProps

• Type: ACLRuleProps