ControlPolicy

• Implements: IControlPolicy

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::ControlPolicy.

Initializers

import com.aliyun.ros.cdk.cloudfw.ControlPolicy;
ControlPolicy.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)
    .direction(java.lang.String)
    .direction(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)
//  .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)
//  .domainResolveType(java.lang.String)
//  .domainResolveType(IResolvable)
//  .endTime(java.lang.Number)
//  .endTime(IResolvable)
//  .ipVersion(java.lang.String)
//  .ipVersion(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();

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: Traffic access control policy set by the cloud of a firewall.

accept: Release drop: rejected log: Observation

description^Required

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

Property description: Security access control policy description information.

destination^Required

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

Property destination: Security Access Control destination address policy.

When DestinationType is net, Destination purpose CIDR. For example: 1.2.3.4/24 When DestinationType as a group, Destination for the purpose of the address book name. For example: db_group When DestinationType for the domain, Destination for the purpose of a domain name. For example:. * Aliyuncs.com When DestinationType as location, Destination area for the purpose (see below position encoding specific regions). For example: [ "BJ11", "ZB"]

destinationType^Required

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

Property destinationType: Security Access Control destination address type of policy.

net: Destination network segment (CIDR) group: destination address book domain: The purpose domain location: The purpose area

direction^Required

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

Property direction: Security access control traffic direction policies.

in: internal and external traffic access control out: within the flow of external access control

newOrder^Required

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

Property newOrder: Security access control priority policy in force.

Priority number increments sequentially from 1, lower the priority number, the higher the priority. Description -1 indicates the lowest priority.

proto^Required

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

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

Valid values:

• ANY (any protocol)
• TCP
• UDP
• ICMP

If the traffic direction is out and the destination is a domain-based threat intelligence or cloud service address book, you can set the protocol only to TCP. The supported applications are HTTP, HTTPS, SMTP, SMTPS, and SSL.

source^Required

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

Property source: Security access control source address policy.

When SourceType for the net, Source is the source CIDR. For example: 1.2.3.0/24 When SourceType as a group, Source name for the source address book. For example: db_group When SourceType as location, Source source region (specific region position encoder see below). For example, [ "BJ11", "ZB"]

sourceType^Required

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

Property sourceType: Security access control source address type of policy.

net: Source segment (CIDR) group: source address book location: the source area

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:

• FTP
• HTTP
• HTTPS
• Memcache
• MongoDB
• MQTT
• MySQL
• RDP
• Redis
• SMTP
• SMTPS
• SSH
• SSL_No_Cert
• SSL
• VNC
• ANY (all application types)

The available application types depend on the protocol type (Proto). If you set Proto to TCP, you can set ApplicationName to any of the listed application types. If you set Proto to UDP, ICMP, or ANY, you can set ApplicationName only to ANY. Specify either ApplicationNameList or ApplicationName.

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.

Valid values:

• If Proto is ICMP, leave this parameter empty.

If the protocol type is ICMP, you cannot control access based on the destination port.

• If Proto is TCP, UDP, or ANY, and DestPortType is group, leave this parameter empty.

If you set DestPortType to group (port address book), you do not need to specify a destination port number. The port address book contains all the destination ports that the policy manages.

• If Proto is TCP, UDP, or ANY, and DestPortType is port, set this parameter to the destination port number.

destPortGroup^Optional

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

Property destPortGroup: Security access control policy access traffic destination port address book name.

Description DestPortType is group, set the item.

destPortType^Optional

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

Property destPortType: Security access control policy access destination port traffic type.

port: Port group: port address book

domainResolveType^Optional

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

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

Value:

• FQDN: Based on FQDN
• DNS: Based on DNS dynamic resolution
• FQDN_AND_DNS: Based on FQDN and DNS dynamic resolution

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.

ipVersion^Optional

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

Property ipVersion: IP version.

Valid values:

• 4: IPv4
• 6: IPv6

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. Valid values:

• 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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

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 java.lang.Object getAttrAclUuid();

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

Attribute AclUuid: Security access control ID that uniquely identifies the policy.

props^Required

public ControlPolicyProps getProps();

• Type: ControlPolicyProps