Policy

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Policy.

Initializers

import ros_cdk_apig
ros_cdk_apig.Policy(
  scope: Construct,
  id: str,
  attach_resource_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  attach_resource_type: typing.Union[str, IResolvable],
  environment_id: typing.Union[str, IResolvable],
  gateway_id: typing.Union[str, IResolvable],
  policy_class_name: typing.Union[str, IResolvable],
  policy_config: typing.Union[str, IResolvable],
  policy_name: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
attach_resource_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property attachResourceIds: The Mount point id list.
attach_resource_type	typing.Union[str, ros_cdk_core.IResolvable]	Property attachResourceType: Policies support mount point types.
environment_id	typing.Union[str, ros_cdk_core.IResolvable]	Property environmentId: The id of the environment.
gateway_id	typing.Union[str, ros_cdk_core.IResolvable]	Property gatewayId: The ID of the Gateway.
policy_class_name	typing.Union[str, ros_cdk_core.IResolvable]	Property policyClassName: The name of the policy class.
policy_config	typing.Union[str, ros_cdk_core.IResolvable]	Property policyConfig: Policy Configuration.
policy_name	typing.Union[str, ros_cdk_core.IResolvable]	Property policyName: The name of the policy.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

attach_resource_ids^Required

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

Property attachResourceIds: The Mount point id list.

---

attach_resource_type^Required

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

Property attachResourceType: Policies support mount point types.

HttpApi:HttpApi. Operation: the Operation of the HttpApi. GatewayRoute: Gateway route. GatewayService: Gateway service. GatewayServicePort: The Gateway service port. Domain: The Gateway Domain name. Gateway: Gateway.

---

environment_id^Required

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

Property environmentId: The id of the environment.

---

gateway_id^Required

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

Property gatewayId: The ID of the Gateway.

---

policy_class_name^Required

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

Property policyClassName: The name of the policy class.

---

policy_config^Required

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

Property policyConfig: Policy Configuration.

---

policy_name^Optional

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

Property policyName: The name of the policy.

---

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_apig
ros_cdk_apig.Policy.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_policy_class_id	ros_cdk_core.IResolvable	Attribute PolicyClassId: The ID of policy class.
attr_policy_class_name	ros_cdk_core.IResolvable	Attribute PolicyClassName: The name of policy class.
attr_policy_config	ros_cdk_core.IResolvable	Attribute PolicyConfig: Policy Configuration.
attr_policy_id	ros_cdk_core.IResolvable	Attribute PolicyId: The ID of the policy.
attr_policy_name	ros_cdk_core.IResolvable	Attribute PolicyName: The name of the policy.

---

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_policy_class_id^Required

attr_policy_class_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PolicyClassId: The ID of policy class.

---

attr_policy_class_name^Required

attr_policy_class_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PolicyClassName: The name of policy class.

---

attr_policy_config^Required

attr_policy_config: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PolicyConfig: Policy Configuration.

---

attr_policy_id^Required

attr_policy_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PolicyId: The ID of the policy.

---

attr_policy_name^Required

attr_policy_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PolicyName: The name of the policy.

---