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 com.aliyun.ros.cdk.cloudfw.NatFirewallControlPolicy;
NatFirewallControlPolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .aclAction(java.lang.String)
    .aclAction(IResolvable)
    .applicationNameList(IResolvable)
    .applicationNameList(java.util.List<java.lang.String)
    .applicationNameList(IResolvable>)
    .description(java.lang.String)
    .description(IResolvable)
    .destination(java.lang.String)
    .destination(IResolvable)
    .destinationType(java.lang.String)
    .destinationType(IResolvable)
    .direction(java.lang.String)
    .direction(IResolvable)
    .natGatewayId(java.lang.String)
    .natGatewayId(IResolvable)
    .newOrder(java.lang.Number)
    .newOrder(IResolvable)
    .proto(java.lang.String)
    .proto(IResolvable)
    .source(java.lang.String)
    .source(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
//  .destPort(java.lang.Number)
//  .destPort(IResolvable)
//  .destPortGroup(java.lang.String)
//  .destPortGroup(IResolvable)
//  .destPortType(java.lang.String)
//  .destPortType(IResolvable)
//  .domainResolveType(java.lang.Number)
//  .domainResolveType(IResolvable)
//  .endTime(java.lang.String)
//  .endTime(IResolvable)
//  .ipVersion(java.lang.Number)
//  .ipVersion(IResolvable)
//  .release(java.lang.Boolean)
//  .release(IResolvable)
//  .repeatDays(java.util.List<java.lang.Object>)
//  .repeatDays(IResolvable)
//  .repeatEndTime(java.lang.String)
//  .repeatEndTime(IResolvable)
//  .repeatStartTime(java.lang.String)
//  .repeatStartTime(IResolvable)
//  .repeatType(java.lang.String)
//  .repeatType(IResolvable)
//  .startTime(java.lang.String)
//  .startTime(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
aclAction java.lang.String OR com.aliyun.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.
applicationNameList com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property applicationNameList: The application types supported by the access control policy.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the access control policy.
destination java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destination: The destination address in the access control policy.
destinationType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destinationType: The type of the destination address in the access control policy.
direction java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property direction: The direction of the traffic to which the access control policy applies.
natGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property natGatewayId: The ID of the NAT gateway.
newOrder java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property newOrder: The priority of the access control policy.
proto java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.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.
sourceType java.lang.String OR com.aliyun.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.
destPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property destPort: The destination port in the access control policy.
destPortGroup java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destPortGroup: The name of the destination port address book in the access control policy.
destPortType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destPortType: The type of the destination port in the access control policy.
domainResolveType java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property domainResolveType: The domain name resolution method of the access control policy.
endTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endTime: The time when the access control policy stops taking effect.
ipVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ipVersion: The IP version supported by the access control policy.
release java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property release: Specifies whether to enable the access control policy.
repeatDays java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property repeatDays: The days of a week or of a month on which the access control policy takes effect.
repeatEndTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property repeatEndTime: The point in time when the recurrence ends.
repeatStartTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property repeatStartTime: The point in time when the recurrence starts.
repeatType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property repeatType: The recurrence type for the access control policy to take effect.
startTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property startTime: The time when the access control policy starts to take effect.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

aclActionRequired

  • Type: java.lang.String OR com.aliyun.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.

applicationNameListRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

descriptionRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the access control policy.

destinationRequired

  • Type: java.lang.String OR com.aliyun.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"]

destinationTypeRequired

  • Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: out: outbound traffic

natGatewayIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property natGatewayId: The ID of the NAT gateway.

newOrderRequired

  • Type: java.lang.Number OR com.aliyun.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: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

sourceTypeRequired

  • Type: java.lang.String OR com.aliyun.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.

destPortOptional

  • Type: java.lang.Number OR com.aliyun.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.

destPortGroupOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

destPortTypeOptional

  • Type: java.lang.String OR com.aliyun.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

domainResolveTypeOptional

  • Type: java.lang.Number OR com.aliyun.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

endTimeOptional

  • Type: java.lang.String OR com.aliyun.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.

ipVersionOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: 4: IPv4 (default)

releaseOptional

  • Type: java.lang.Boolean OR com.aliyun.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

repeatDaysOptional

  • Type: java.util.List OR com.aliyun.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].

repeatEndTimeOptional

  • Type: java.lang.String OR com.aliyun.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.

repeatStartTimeOptional

  • Type: java.lang.String OR com.aliyun.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.

repeatTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

startTimeOptional

  • Type: java.lang.String OR com.aliyun.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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.cloudfw.NatFirewallControlPolicy;
NatFirewallControlPolicy.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAclUuid com.aliyun.ros.cdk.core.IResolvable Attribute AclUuid: The unique ID of the access control policy.
attrDirection com.aliyun.ros.cdk.core.IResolvable Attribute Direction: The direction of the traffic to which the access control policy applies.
attrNatGatewayId com.aliyun.ros.cdk.core.IResolvable Attribute NatGatewayId: The ID of the NAT gateway.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAclUuidRequired 

public IResolvable getAttrAclUuid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDirectionRequired 

public IResolvable getAttrDirection();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrNatGatewayIdRequired 

public IResolvable getAttrNatGatewayId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute NatGatewayId: The ID of the NAT gateway.