Package software.amazon.awscdk.services.xray

Class CfnResourcePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.xray.CfnResourcePolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:11.162Z")
@Stability(Stable)
public class CfnResourcePolicy
extends CfnResource
implements IInspectable

Use AWS::XRay::ResourcePolicy to specify an X-Ray resource-based policy, which grants one or more AWS services and accounts permissions to access X-Ray .

Each resource-based policy is associated with a specific AWS account.

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.*;
 CfnResourcePolicy cfnResourcePolicy = CfnResourcePolicy.Builder.create(this, "MyCfnResourcePolicy")
         .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	Class	Description
static final class	CfnResourcePolicy.Builder	A fluent builder for CfnResourcePolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnResourcePolicy(software.constructs.Construct scope, String id, CfnResourcePolicyProps props)

Method Summary

Modifier and Type	Method	Description
Object	getBypassPolicyLockoutCheck()	A flag to indicate whether to bypass the resource-based policy lockout safety check.
protected Map<String,Object>	getCfnProperties()
String	getPolicyDocument()	The resource-based policy document, which can be up to 5kb in size.
String	getPolicyName()	The name of the resource-based policy.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBypassPolicyLockoutCheck(Boolean value)	A flag to indicate whether to bypass the resource-based policy lockout safety check.
void	setBypassPolicyLockoutCheck(IResolvable value)	A flag to indicate whether to bypass the resource-based policy lockout safety check.
void	setPolicyDocument(String value)	The resource-based policy document, which can be up to 5kb in size.
void	setPolicyName(String value)	The name of the resource-based policy.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnResourcePolicy

protected CfnResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnResourcePolicy

protected CfnResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResourcePolicy

@Stability(Stable)
public CfnResourcePolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnResourcePolicyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPolicyDocument

@Stability(Stable)
@NotNull
public String getPolicyDocument()

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

setPolicyDocument

@Stability(Stable)
public void setPolicyDocument(@NotNull
 String value)

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

getPolicyName

@Stability(Stable)
@NotNull
public String getPolicyName()

The name of the resource-based policy.

setPolicyName

@Stability(Stable)
public void setPolicyName(@NotNull
 String value)

The name of the resource-based policy.

getBypassPolicyLockoutCheck

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

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

setBypassPolicyLockoutCheck

@Stability(Stable)
public void setBypassPolicyLockoutCheck(@Nullable
 Boolean value)

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

setBypassPolicyLockoutCheck

@Stability(Stable)
public void setBypassPolicyLockoutCheck(@Nullable
 IResolvable value)

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