ControlPolicy
This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::ControlPolicy
, which is used to create a custom control policy.
Initializers
import ros_cdk_resourcemanager
ros_cdk_resourcemanager.ControlPolicy(
scope: Construct,
id: str,
control_policy_name: typing.Union[str, IResolvable],
effect_scope: typing.Union[str, IResolvable],
policy_document: typing.Union[str, IResolvable],
description: 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. |
control_policy_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property controlPolicyName: PolicyName. |
effect_scope |
typing.Union[str, ros_cdk_core.IResolvable] |
Property effectScope: EffectScope. |
policy_document |
typing.Union[str, ros_cdk_core.IResolvable] |
Property policyDocument: PolicyDocument. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: Description. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
control_policy_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property controlPolicyName: PolicyName.
effect_scope
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property effectScope: EffectScope.
policy_document
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property policyDocument: PolicyDocument.
description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: Description.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_resourcemanager
ros_cdk_resourcemanager.ControlPolicy.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_attachment_count |
ros_cdk_core.IResolvable |
Attribute AttachmentCount: AttachmentCount. |
attr_control_policy_name |
ros_cdk_core.IResolvable |
Attribute ControlPolicyName: PolicyName. |
attr_description |
ros_cdk_core.IResolvable |
Attribute Description: Description. |
attr_effect_scope |
ros_cdk_core.IResolvable |
Attribute EffectScope: EffectScope. |
attr_policy_document |
ros_cdk_core.IResolvable |
Attribute PolicyDocument: PolicyDocument. |
attr_policy_id |
ros_cdk_core.IResolvable |
Attribute PolicyId: PolicyId. |
attr_policy_type |
ros_cdk_core.IResolvable |
Attribute PolicyType: PolicyType. |
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_attachment_count
Required
attr_attachment_count: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute AttachmentCount: AttachmentCount.
attr_control_policy_name
Required
attr_control_policy_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ControlPolicyName: PolicyName.
attr_description
Required
attr_description: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Description: Description.
attr_effect_scope
Required
attr_effect_scope: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute EffectScope: EffectScope.
attr_policy_document
Required
attr_policy_document: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PolicyDocument: PolicyDocument.
attr_policy_id
Required
attr_policy_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PolicyId: PolicyId.
attr_policy_type
Required
attr_policy_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PolicyType: PolicyType.