Skip to content

NatFirewallControlPolicy

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::NatFirewallControlPolicy, which is used to add an access control policy for a NAT firewall.

Initializers 

import ros_cdk_cloudfw
ros_cdk_cloudfw.NatFirewallControlPolicy(
  scope: Construct,
  id: str,
  acl_action: typing.Union[str, IResolvable],
  application_name_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  description: typing.Union[str, IResolvable],
  destination: typing.Union[str, IResolvable],
  destination_type: typing.Union[str, IResolvable],
  direction: typing.Union[str, IResolvable],
  nat_gateway_id: typing.Union[str, IResolvable],
  new_order: typing.Union[typing.Union[int, float], IResolvable],
  proto: typing.Union[str, IResolvable],
  source: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  dest_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  dest_port_group: typing.Union[str, IResolvable] = None,
  dest_port_type: typing.Union[str, IResolvable] = None,
  domain_resolve_type: typing.Union[typing.Union[int, float], IResolvable] = None,
  end_time: typing.Union[str, IResolvable] = None,
  ip_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  release: typing.Union[bool, IResolvable] = None,
  repeat_days: typing.Union[typing.List[typing.Any], 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[str, 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.Valid values: accept: allows the traffic. drop: denies the traffic. log: monitors the traffic.
application_name_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property applicationNameList: The application types supported by the access control policy.
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.
direction typing.Union[str, ros_cdk_core.IResolvable] Property direction: The direction of the traffic to which the access control policy applies.
nat_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property natGatewayId: The ID of the NAT gateway.
new_order typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property newOrder: The priority of the access control policy.
proto typing.Union[str, ros_cdk_core.IResolvable] Property proto: The protocol type in the access control policy.Valid values: ANY: all types of protocols TCP UDP ICMP.
source typing.Union[str, ros_cdk_core.IResolvable] Property source: The source address in the access control policy.Valid values: If SourceType is set to net, the value of Source is a CIDR block.Example: 10.2.4.0\/24 If SourceType is set to group, the value of this parameter must be an address book name.Example: db_group.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: The type of the source address in the access control policy.Valid values: net: source CIDR block group: source address book.
dest_port typing.Union[typing.Union[int, float], 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 name of the destination port address book 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.
domain_resolve_type typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property domainResolveType: The domain name resolution method of the access control policy.
end_time typing.Union[str, ros_cdk_core.IResolvable] Property endTime: The time when the access control policy stops taking effect.
ip_version typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ipVersion: The IP version supported by the access control policy.
release typing.Union[bool, ros_cdk_core.IResolvable] Property release: Specifies whether to enable the access control policy.
repeat_days typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] Property repeatDays: The days of a week or of a month on which the access control policy takes effect.
repeat_end_time typing.Union[str, ros_cdk_core.IResolvable] Property repeatEndTime: The point in time when the recurrence ends.
repeat_start_time typing.Union[str, ros_cdk_core.IResolvable] Property repeatStartTime: The point in time when the recurrence starts.
repeat_type typing.Union[str, ros_cdk_core.IResolvable] Property repeatType: The recurrence type for the access control policy to take effect.
start_time typing.Union[str, ros_cdk_core.IResolvable] Property startTime: The time when the access control policy starts to take effect.
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.

application_name_listRequired

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

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

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.

Valid values: If DestinationType is set to net, the value of this parameter is a CIDR block. Example: 1.2.XX.XX/24 If DestinationType is set to group, the value of this parameter is an address book. Example: db_group If DestinationType is set to domain, the value of this parameter is a domain name. Example: *.aliyuncs.com DestinationType is set to location, the value of this parameter is a location. Example: ["BJ11", "ZB"]

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

directionRequired

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

Property direction: The direction of the traffic to which the access control policy applies.

Valid values: out: outbound traffic

nat_gateway_idRequired

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

Property natGatewayId: The ID of the NAT gateway.

new_orderRequired

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

Property newOrder: The priority of the access control policy.

The priority value starts from 1. A small priority value indicates a high priority.

protoRequired

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

Property proto: The protocol type in the access control policy.Valid values: ANY: all types of protocols TCP UDP ICMP.

sourceRequired

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

Property source: The source address in the access control policy.Valid values: If SourceType is set to net, the value of Source is a CIDR block.Example: 10.2.4.0\/24 If SourceType is set to group, the value of this parameter must be an address book name.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: source CIDR block group: source address book.

dest_portOptional

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

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

Valid values: If Proto is set to ICMP, DestPort is automatically left empty. If Proto is set to TCP, UDP, or ANY and DestPortType is set to group, DestPort is empty. If Proto is set to TCP, UDP, or ANY and DestPortType is set to port, the value of DestPort is the destination port number.

dest_port_groupOptional

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

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

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: net: source CIDR block group: source address book

domain_resolve_typeOptional

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

Property domainResolveType: The domain name resolution method of the access control policy.

Valid values: 0: fully qualified domain name (FQDN)-based resolution 1: Domain Name System (DNS)-based dynamic resolution 2: FQDN and DNS-based dynamic resolution

end_timeOptional

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

Property endTime: The time when the access control policy stops taking effect.

The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.

ip_versionOptional

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

Property ipVersion: The IP version supported by the access control policy.

Valid values: 4: IPv4 (default)

releaseOptional

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

Property release: Specifies whether to enable the access control policy.

By default, an access control policy is enabled after it is created. Valid values: true false

repeat_daysOptional

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

Property repeatDays: The days of a week or of a month on which the access control policy takes effect.

If RepeatType is set to Permanent, None, or Daily, RepeatDays is left empty. Example: []. If RepeatType is set to Weekly, RepeatDays must be specified. Example: [0, 6]. If RepeatType is set to Monthly, RepeatDays must be specified. Example: [1, 31].

repeat_end_timeOptional

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

Property repeatEndTime: The point in time when the recurrence ends.

Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.

repeat_start_timeOptional

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

Property repeatStartTime: The point in time when the recurrence starts.

Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.

repeat_typeOptional

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

Property repeatType: The recurrence type for the access control policy to take effect.

Valid values: Permanent (default): The policy always takes effect. None: The policy takes effect for only once. Daily: The policy takes effect on a daily basis. Weekly: The policy takes effect on a weekly basis. Monthly: The policy takes effect on a monthly basis.

start_timeOptional

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

Property startTime: The time when the access control policy starts to take effect.

The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.

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.NatFirewallControlPolicy.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.
attr_direction ros_cdk_core.IResolvable Attribute Direction: The direction of the traffic to which the access control policy applies.
attr_nat_gateway_id ros_cdk_core.IResolvable Attribute NatGatewayId: The ID of the NAT gateway.

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.

attr_directionRequired 

attr_direction: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Direction: The direction of the traffic to which the access control policy applies.

attr_nat_gateway_idRequired 

attr_nat_gateway_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NatGatewayId: The ID of the NAT gateway.