software.amazon.awscdk.services.xray

Class CfnResourcePolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.xray.CfnResourcePolicy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.852Z")
public class CfnResourcePolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::XRay::ResourcePolicy`.

Sets the resource policy to grant one or more AWS services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific AWS account. Each AWS account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResourcePolicy.Builder A fluent builder for CfnResourcePolicy.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResourcePolicy(Construct scope, java.lang.String id, CfnResourcePolicyProps props) Create a new `AWS::XRay::ResourcePolicy`.
protected	CfnResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getBypassPolicyLockoutCheck() `AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getPolicyDocument() The resource policy document, which can be up to 5kb in size.
java.lang.String	getPolicyName() The name of the resource policy.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setBypassPolicyLockoutCheck(java.lang.Boolean value) `AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.
void	setBypassPolicyLockoutCheck(IResolvable value) `AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.
void	setPolicyDocument(java.lang.String value) The resource policy document, which can be up to 5kb in size.
void	setPolicyName(java.lang.String value) The name of the resource policy.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResourcePolicy

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

CfnResourcePolicy

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

CfnResourcePolicy

public CfnResourcePolicy(Construct scope,
                         java.lang.String id,
                         CfnResourcePolicyProps props)

Create a new `AWS::XRay::ResourcePolicy`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPolicyDocument

public java.lang.String getPolicyDocument()

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

setPolicyDocument

public void setPolicyDocument(java.lang.String value)

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

getPolicyName

public java.lang.String getPolicyName()

The name of the resource policy.

Must be unique within a specific AWS account.

setPolicyName

public void setPolicyName(java.lang.String value)

The name of the resource policy.

Must be unique within a specific AWS account.

getBypassPolicyLockoutCheck

public java.lang.Object getBypassPolicyLockoutCheck()

`AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.

setBypassPolicyLockoutCheck

public void setBypassPolicyLockoutCheck(java.lang.Boolean value)

`AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.

setBypassPolicyLockoutCheck

public void setBypassPolicyLockoutCheck(IResolvable value)

`AWS::XRay::ResourcePolicy.BypassPolicyLockoutCheck`.