CfnResourcePolicyProps

class aws_cdk.aws_xray.CfnResourcePolicyProps(*, policy_document, policy_name, bypass_policy_lockout_check=None)

Bases: object

Properties for defining a CfnResourcePolicy.

Parameters:

• policy_document (str) – The resource-based policy document, which can be up to 5kb in size.

• policy_name (str) – The name of the resource-based policy. Must be unique within a specific AWS account.

• bypass_policy_lockout_check (Union[bool, IResolvable, None]) – A flag to indicate whether to bypass the resource-based policy lockout safety check.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_xray as xray

cfn_resource_policy_props = xray.CfnResourcePolicyProps(
    policy_document="policyDocument",
    policy_name="policyName",

    # the properties below are optional
    bypass_policy_lockout_check=False
)

Attributes

bypass_policy_lockout_check

A flag to indicate whether to bypass the resource-based policy lockout safety check.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-bypasspolicylockoutcheck

policy_document

The resource-based policy document, which can be up to 5kb in size.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policydocument

policy_name

The name of the resource-based policy.

Must be unique within a specific AWS account.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-resourcepolicy.html#cfn-xray-resourcepolicy-policyname