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 com.aliyun.ros.cdk.cloudfw.VpcFirewallControlPolicy;
VpcFirewallControlPolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .aclAction(java.lang.String)
    .aclAction(IResolvable)
    .description(java.lang.String)
    .description(IResolvable)
    .destination(java.lang.String)
    .destination(IResolvable)
    .destinationType(java.lang.String)
    .destinationType(IResolvable)
    .newOrder(java.lang.String)
    .newOrder(IResolvable)
    .proto(java.lang.String)
    .proto(IResolvable)
    .source(java.lang.String)
    .source(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
    .vpcFirewallId(java.lang.String)
    .vpcFirewallId(IResolvable)
//  .applicationName(java.lang.String)
//  .applicationName(IResolvable)
//  .applicationNameList(IResolvable)
//  .applicationNameList(java.util.List<java.lang.String)
//  .applicationNameList(IResolvable>)
//  .destPort(java.lang.String)
//  .destPort(IResolvable)
//  .destPortGroup(java.lang.String)
//  .destPortGroup(IResolvable)
//  .destPortType(java.lang.String)
//  .destPortType(IResolvable)
//  .endTime(java.lang.Number)
//  .endTime(IResolvable)
//  .lang(java.lang.String)
//  .lang(IResolvable)
//  .memberUid(java.lang.String)
//  .memberUid(IResolvable)
//  .regionId(java.lang.String)
//  .regionId(IResolvable)
//  .release(java.lang.Boolean)
//  .release(IResolvable)
//  .repeatDays(IResolvable)
//  .repeatDays(java.util.List<java.lang.Number)
//  .repeatDays(IResolvable>)
//  .repeatEndTime(java.lang.String)
//  .repeatEndTime(IResolvable)
//  .repeatStartTime(java.lang.String)
//  .repeatStartTime(IResolvable)
//  .repeatType(java.lang.String)
//  .repeatType(IResolvable)
//  .startTime(java.lang.Number)
//  .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.
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.
newOrder	java.lang.String 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 type of the security protocol in the access control policy.
source	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property source: The source address in the access control policy.
sourceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property sourceType: The type of the source address in the access control policy.
vpcFirewallId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vpcFirewallId: The ID of the policy group to which you want to add the access control policy.
applicationName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property applicationName: The application type that the access control policy supports.
applicationNameList	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property applicationNameList: List of application types supported by the access control policy.
destPort	java.lang.String 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 address book of destination ports 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.
endTime	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property endTime: The end time of the policy validity period for an access control policy.
lang	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property lang: The natural language of the request and response.
memberUid	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property memberUid: Member account UID of current Alibaba Cloud account.
regionId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property regionId: Region ID.
release	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property release: The enabled state of the access control policy.
repeatDays	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property repeatDays: A collection of repeated dates of policy validity for an access control policy.
repeatEndTime	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property repeatEndTime: The repeated end time of the policy validity period for an access control policy.
repeatStartTime	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property repeatStartTime: The repeated start time of the policy validity period for an access control policy.
repeatType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property repeatType: The repetition type of the policy validity period for an access control policy.
startTime	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property startTime: The start time of the policy validity period for an access control policy.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

aclAction^Required

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

---

description^Required

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

Property description: The description of the access control policy.

---

destination^Required

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

---

destinationType^Required

• 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

---

newOrder^Required

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

---

proto^Required

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

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

---

source^Required

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

---

sourceType^Required

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

---

vpcFirewallId^Required

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

---

applicationName^Optional

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

---

applicationNameList^Optional

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

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

---

destPort^Optional

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

---

destPortGroup^Optional

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

---

destPortType^Optional

• 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: port: port group: address book

---

endTime^Optional

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

---

lang^Optional

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

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

Valid values: zh: Chinese en: English

---

memberUid^Optional

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

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

---

regionId^Optional

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

Property regionId: Region ID.

Default to cn-hangzhou.

---

release^Optional

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

---

repeatDays^Optional

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

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.

---

repeatEndTime^Optional

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

---

repeatStartTime^Optional

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

---

repeatType^Optional

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

---

startTime^Optional

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

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

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

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrAclUuid^Required

public IResolvable getAttrAclUuid();

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

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

---

Structs