Package software.amazon.awscdk.services.smsvoice

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.smsvoice.CfnResourcePolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-25T11:29:17.655Z")
@Stability(Stable)
public class CfnResourcePolicy
extends CfnResource
implements IInspectable, IResourcePolicyRef

Attaches a resource-based policy to a End User Messaging resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource.

A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the End User Messaging User Guide .

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.smsvoice.*;
 Object policyDocument;
 CfnResourcePolicy cfnResourcePolicy = CfnResourcePolicy.Builder.create(this, "MyCfnResourcePolicy")
         .policyDocument(policyDocument)
         .resourceArn("resourceArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.smsvoice.IResourcePolicyRef

IResourcePolicyRef.Jsii$Default, IResourcePolicyRef.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
protected Map<String,Object>	getCfnProperties()
Object	getPolicyDocument()	The JSON formatted resource-based policy to attach.
String	getResourceArn()	The Amazon Resource Name (ARN) of the End User Messaging resource attached to the resource-based policy.
ResourcePolicyReference	getResourcePolicyRef()	A reference to a ResourcePolicy resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicyDocument(Object value)	The JSON formatted resource-based policy to attach.
void	setResourceArn(String value)	The Amazon Resource Name (ARN) of the End User Messaging resource attached to 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.constructs.IConstruct

getNode

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

getResourcePolicyRef

@Stability(Stable)
@NotNull
public ResourcePolicyReference getResourcePolicyRef()

A reference to a ResourcePolicy resource.

Specified by:

getResourcePolicyRef in interface IResourcePolicyRef

getPolicyDocument

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

The JSON formatted resource-based policy to attach.

setPolicyDocument

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

The JSON formatted resource-based policy to attach.

getResourceArn

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

The Amazon Resource Name (ARN) of the End User Messaging resource attached to the resource-based policy.

setResourceArn

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

The Amazon Resource Name (ARN) of the End User Messaging resource attached to the resource-based policy.