Package software.amazon.awscdk.services.xray

Interface CfnResourcePolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourcePolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:52.452Z")
@Stability(Stable)
public interface CfnResourcePolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourcePolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.xray.*;
 CfnResourcePolicyProps cfnResourcePolicyProps = CfnResourcePolicyProps.builder()
         .policyDocument("policyDocument")
         .policyName("policyName")
         // the properties below are optional
         .bypassPolicyLockoutCheck(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResourcePolicyProps.Builder	A builder for CfnResourcePolicyProps
static final class	CfnResourcePolicyProps.Jsii$Proxy	An implementation for CfnResourcePolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnResourcePolicyProps.Builder	builder()
default Object	getBypassPolicyLockoutCheck()	A flag to indicate whether to bypass the resource-based policy lockout safety check.
String	getPolicyDocument()	The resource-based policy document, which can be up to 5kb in size.
String	getPolicyName()	The name of the resource-based policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
String getPolicyDocument()

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

See Also:

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

getPolicyName

@Stability(Stable)
@NotNull
String getPolicyName()

The name of the resource-based policy.

Must be unique within a specific AWS account.

See Also:

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

getBypassPolicyLockoutCheck

@Stability(Stable)
@Nullable
default Object getBypassPolicyLockoutCheck()

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

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnResourcePolicyProps.Builder builder()

Returns:

a CfnResourcePolicyProps.Builder of CfnResourcePolicyProps