Skip to content

VpcFirewallControlPolicy

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::VpcFirewallControlPolicy, which is used to add an access control policy to a policy group of a virtual private cloud (VPC) firewall.

Initializers 

import ros_cdk_cloudfw
ros_cdk_cloudfw.VpcFirewallControlPolicy(
  scope: Construct,
  id: str,
  acl_action: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable],
  destination: typing.Union[str, IResolvable],
  destination_type: typing.Union[str, IResolvable],
  new_order: typing.Union[str, IResolvable],
  proto: typing.Union[str, IResolvable],
  source: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  vpc_firewall_id: typing.Union[str, IResolvable],
  application_name: typing.Union[str, IResolvable] = None,
  application_name_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  dest_port: typing.Union[str, IResolvable] = None,
  dest_port_group: typing.Union[str, IResolvable] = None,
  dest_port_type: typing.Union[str, IResolvable] = None,
  end_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  lang: typing.Union[str, IResolvable] = None,
  member_uid: typing.Union[str, IResolvable] = None,
  region_id: typing.Union[str, IResolvable] = None,
  release: typing.Union[bool, IResolvable] = None,
  repeat_days: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]] = None,
  repeat_end_time: typing.Union[str, IResolvable] = None,
  repeat_start_time: typing.Union[str, IResolvable] = None,
  repeat_type: typing.Union[str, IResolvable] = None,
  start_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
acl_action typing.Union[str, ros_cdk_core.IResolvable] Property aclAction: The action that Cloud Firewall performs on the traffic.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the access control policy.
destination typing.Union[str, ros_cdk_core.IResolvable] Property destination: The destination address in the access control policy.
destination_type typing.Union[str, ros_cdk_core.IResolvable] Property destinationType: The type of the destination address in the access control policy.
new_order typing.Union[str, ros_cdk_core.IResolvable] Property newOrder: The priority of the access control policy.
proto typing.Union[str, ros_cdk_core.IResolvable] Property proto: The type of the security protocol in the access control policy.
source typing.Union[str, ros_cdk_core.IResolvable] Property source: The source address in the access control policy.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: The type of the source address in the access control policy.
vpc_firewall_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcFirewallId: The ID of the policy group to which you want to add the access control policy.
application_name typing.Union[str, ros_cdk_core.IResolvable] Property applicationName: The application type that the access control policy supports.
application_name_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property applicationNameList: List of application types supported by the access control policy.
dest_port typing.Union[str, ros_cdk_core.IResolvable] Property destPort: The destination port in the access control policy.
dest_port_group typing.Union[str, ros_cdk_core.IResolvable] Property destPortGroup: The address book of destination ports in the access control policy.
dest_port_type typing.Union[str, ros_cdk_core.IResolvable] Property destPortType: The type of the destination port in the access control policy.
end_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property endTime: The end time of the policy validity period for an access control policy.
lang typing.Union[str, ros_cdk_core.IResolvable] Property lang: The natural language of the request and response.
member_uid typing.Union[str, ros_cdk_core.IResolvable] Property memberUid: Member account UID of current Alibaba Cloud account.
region_id typing.Union[str, ros_cdk_core.IResolvable] Property regionId: Region ID.
release typing.Union[bool, ros_cdk_core.IResolvable] Property release: The enabled state of the access control policy.
repeat_days typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]] Property repeatDays: A collection of repeated dates of policy validity for an access control policy.
repeat_end_time typing.Union[str, ros_cdk_core.IResolvable] Property repeatEndTime: The repeated end time of the policy validity period for an access control policy.
repeat_start_time typing.Union[str, ros_cdk_core.IResolvable] Property repeatStartTime: The repeated start time of the policy validity period for an access control policy.
repeat_type typing.Union[str, ros_cdk_core.IResolvable] Property repeatType: The repetition type of the policy validity period for an access control policy.
start_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property startTime: The start time of the policy validity period for an access control policy.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

acl_actionRequired

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

Property aclAction: The action that Cloud Firewall performs on the traffic.

Valid values: accept: allows the traffic. drop: denies the traffic. log: monitors the traffic.

descriptionRequired

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

Property description: The description of the access control policy.

destinationRequired

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

Property destination: The destination address in the access control policy.

Set this parameter in the following way: If the DestinationType parameter is set to net, set the value to a Classless Inter-Domain Routing (CIDR) block. Example: 10.2.3.0/24. If the DestinationType parameter is set to group, set the value to the name of an address book. Example: db_group. If the DestinationType parameter is set to domain, set the value to a domain name. Example: *.aliyuncs.com.

destination_typeRequired

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

Property destinationType: The type of the destination address in the access control policy.

Valid values: net: CIDR block group: address book domain: domain name

new_orderRequired

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

Property newOrder: The priority of the access control policy.

The priority value starts from 1. A smaller priority value indicates a higher priority. Note The value of -1 indicates the lowest priority.

protoRequired

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

Property proto: The type of the security protocol in the access control policy.

sourceRequired

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

Property source: The source address in the access control policy.

If the SourceType parameter is set to net, set the value to a CIDR block. Example: 10.2.3.0/24. If the SourceType parameter is set to group, set the value to the name of an address book. Example: db_group.

source_typeRequired

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

Property sourceType: The type of the source address in the access control policy.

Valid values: net: CIDR block group: address book

vpc_firewall_idRequired

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

Property vpcFirewallId: The ID of the policy group to which you want to add the access control policy.

If the VPC firewall is used to protect CEN, set the value to the ID of the CEN instance that the VPC firewall protects. Example: cen-ervw5jbw1234*. If the VPC firewall is used to protect Express Connect, set the value to the ID of the VPC firewall instance. Example: vfw-a42bbb748c91234***. Note You can call the DescribeVpcFirewallAclGroupList operation to query the ID of the policy group.

application_nameOptional

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

Property applicationName: The application type that the access control policy supports.

Valid values: ANY (indicates that all application types are supported) FTP HTTP HTTPS MySQL SMTP SMTPS RDP VNC SSH Redis MQTT MongoDB Memcache SSL

application_name_listOptional

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

Property applicationNameList: List of application types supported by the access control policy.

dest_portOptional

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

Property destPort: The destination port in the access control policy.

Note This parameter must be specified if the DestPortType parameter is set to port.

dest_port_groupOptional

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

Property destPortGroup: The address book of destination ports in the access control policy.

Note This parameter must be specified if the DestPortType parameter is set to group.

dest_port_typeOptional

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

Property destPortType: The type of the destination port in the access control policy.

Valid values: port: port group: address book

end_timeOptional

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

Property endTime: The end time of the policy validity period for an access control policy.

It is represented in a second-level timestamp format. It must be the whole hour or half hour, and at least half an hour greater than the start time. Notes: When RepeatType is Permanent, EndTime is empty. When RepeatType is None, Daily, Weekly, Monthly, EndTime must havea value, and you need to set the end time.

langOptional

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

Property lang: The natural language of the request and response.

Valid values: zh: Chinese en: English

member_uidOptional

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

Property memberUid: Member account UID of current Alibaba Cloud account.

region_idOptional

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

Property regionId: Region ID.

Default to cn-hangzhou.

releaseOptional

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

Property release: The enabled state of the access control policy.

This policy is enabled by default when it is created. Value:

  • true: Access control policy is enabled
  • false: Access control policy is not enabled

repeat_daysOptional

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

Property repeatDays: A collection of repeated dates of policy validity for an access control policy.

When RepeatType is Permanent, None, and Daily, RepeatDays is an empty set. For example: [] When RepeatType is Weekly, RepeatDays cannot be empty. Example: [0, 6] Notes: When RepeatType is set to Weekly, RepeatDays is not allowed. When RepeatType is Monthly, RepeatDays cannot be empty. Examples: [1, 31] Notes: When RepeatType is set to Monthly, RepeatDays is not allowed to repeat.

repeat_end_timeOptional

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

Property repeatEndTime: The repeated end time of the policy validity period for an access control policy.

For example: 08:00, must be the hour or half time, and less than the repeat start time at least half an hour. Notes: When RepeatType is Permanent and None, RepeatEndTime is empty. When RepeatType is Daily, Weekly, or Monthly, RepeatEndTime musthave a value, and you need to set the repeat end time.

repeat_start_timeOptional

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

Property repeatStartTime: The repeated start time of the policy validity period for an access control policy.

For example: 08:00, must be the hour or half time, and less than the repeat end time at least half an hour. Notes: When RepeatType is Permanent and None, RepeatStartTime is empty. When RepeatType is Daily, Weekly, or Monthly, RepeatStartTime must have a value, and you need to set the repeat start time.

repeat_typeOptional

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

Property repeatType: The repetition type of the policy validity period for an access control policy.

Valid values:

  • Permanent (default)
  • None
  • Daily
  • Weekly
  • Monthly.

start_timeOptional

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

Property startTime: The start time of the policy validity period for an access control policy.

It is represented in a second-level timestamp format. It must be the whole hour or half hour, and at least half an hour less than the end time. Notes: When RepeatType is Permanent, StartTime is empty. When RepeatType is None, Daily, Weekly, Monthly, StartTime must have a value, and you need to set the start time.

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_cloudfw
ros_cdk_cloudfw.VpcFirewallControlPolicy.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.
attr_acl_uuid ros_cdk_core.IResolvable Attribute AclUuid: The unique ID of the access control policy.

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

attr_acl_uuidRequired 

attr_acl_uuid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclUuid: The unique ID of the access control policy.

Structs