Rule

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

Initializers

import ros_cdk_pvtz
ros_cdk_pvtz.Rule(
  scope: Construct,
  id: str,
  endpoint_id: typing.Union[str, IResolvable],
  forward_ip: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ForwardIpProperty]]],
  rule_name: typing.Union[str, IResolvable],
  type: typing.Union[str, IResolvable],
  zone_name: typing.Union[str, IResolvable],
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
endpoint_id	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointId: The ID of the endpoint.
forward_ip	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ForwardIpProperty]]]	Property forwardIp: The destination external server.
rule_name	typing.Union[str, ros_cdk_core.IResolvable]	Property ruleName: The name of the forwarding rule.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: The type of the forwarding rule.
zone_name	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneName: The domain name that requires DNS traffic forwarding.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

endpoint_id^Required

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

Property endpointId: The ID of the endpoint.

---

forward_ip^Required

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

Property forwardIp: The destination external server.

---

rule_name^Required

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

Property ruleName: The name of the forwarding rule.

---

type^Required

• Type: typing.Union[str, 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.

---

zone_name^Required

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

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

---

enable_resource_property_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_pvtz
ros_cdk_pvtz.Rule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The timestamp when the forwarding rule was created.
attr_endpoint_id	ros_cdk_core.IResolvable	Attribute EndpointId: The ID of the endpoint.
attr_endpoint_name	ros_cdk_core.IResolvable	Attribute EndpointName: The name of the endpoint.
attr_forward_ip	ros_cdk_core.IResolvable	Attribute ForwardIp: The information about each destination external server.
attr_rule_name	ros_cdk_core.IResolvable	Attribute RuleName: The name of the forwarding rule.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of the forwarding rule.
attr_vpcs	ros_cdk_core.IResolvable	Attribute Vpcs: The information about each virtual private cloud (VPC) that is associated with the forwarding rule.
attr_zone_name	ros_cdk_core.IResolvable	Attribute ZoneName: The domain name that requires Domain Name System (DNS) traffic forwarding.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_endpoint_id^Required

attr_endpoint_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EndpointId: The ID of the endpoint.

---

attr_endpoint_name^Required

attr_endpoint_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EndpointName: The name of the endpoint.

---

attr_forward_ip^Required

attr_forward_ip: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ForwardIp: The information about each destination external server.

---

attr_rule_name^Required

attr_rule_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RuleName: The name of the forwarding rule.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of the forwarding rule.

---

attr_vpcs^Required

attr_vpcs: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_zone_name^Required

attr_zone_name: IResolvable

• Type: ros_cdk_core.IResolvable

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

---