Rule

This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::Rule, which is used to add a forwarding rule.

Initializers

import com.aliyun.ros.cdk.pvtz.Rule;
Rule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .endpointId(java.lang.String)
    .endpointId(IResolvable)
    .forwardIp(IResolvable)
    .forwardIp(java.util.List<IResolvable)
    .forwardIp(ForwardIpProperty>)
    .ruleName(java.lang.String)
    .ruleName(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
    .zoneName(java.lang.String)
    .zoneName(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.
`endpointId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property endpointId: The ID of the endpoint.
`forwardIp`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.ListForwardIpProperty>`	Property forwardIp: The destination external server.
`ruleName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property ruleName: The name of the forwarding rule.
`type`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property type: The type of the forwarding rule.
`zoneName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property zoneName: The domain name that requires DNS traffic forwarding.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`endpointId`^Required

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

Property endpointId: The ID of the endpoint.

`forwardIp`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListForwardIpProperty>

Property forwardIp: The destination external server.

`ruleName`^Required

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

Property ruleName: The name of the forwarding rule.

`type`^Required

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

Property type: The type of the forwarding rule.

Valid value: OUTBOUND: forwards Domain Name System (DNS) traffic to one or more external IP addresses.

`zoneName`^Required

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

Property zoneName: The domain name that requires DNS traffic forwarding.

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.pvtz.Rule;
Rule.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.
`attrCreateTime`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CreateTime: The timestamp when the forwarding rule was created.
`attrEndpointId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointId: The ID of the endpoint.
`attrEndpointName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EndpointName: The name of the endpoint.
`attrForwardIp`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ForwardIp: The information about each destination external server.
`attrRuleName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RuleName: The name of the forwarding rule.
`attrType`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Type: The type of the forwarding rule.
`attrVpcs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Vpcs: The information about each virtual private cloud (VPC) that is associated with the forwarding rule.
`attrZoneName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ZoneName: The domain name that requires Domain Name System (DNS) traffic forwarding.

`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

`attrCreateTime`^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The timestamp when the forwarding rule was created.

`attrEndpointId`^Required

public IResolvable getAttrEndpointId();

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

Attribute EndpointId: The ID of the endpoint.

`attrEndpointName`^Required

public IResolvable getAttrEndpointName();

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

Attribute EndpointName: The name of the endpoint.

`attrForwardIp`^Required

public IResolvable getAttrForwardIp();

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

Attribute ForwardIp: The information about each destination external server.

`attrRuleName`^Required

public IResolvable getAttrRuleName();

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

Attribute RuleName: The name of the forwarding rule.

`attrType`^Required

public IResolvable getAttrType();

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

Attribute Type: The type of the forwarding rule.

`attrVpcs`^Required

public IResolvable getAttrVpcs();

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

Attribute Vpcs: The information about each virtual private cloud (VPC) that is associated with the forwarding rule.

`attrZoneName`^Required

public IResolvable getAttrZoneName();

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

Attribute ZoneName: The domain name that requires Domain Name System (DNS) traffic forwarding.

Rule

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

endpointIdRequired

forwardIpRequired

ruleNameRequired

typeRequired

zoneNameRequired

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata