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.ssm.CfnResourcePolicy
- All Implemented Interfaces:
IInspectable,IResourcePolicyRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-29T11:15:49.215Z")
@Stability(Stable)
public class CfnResourcePolicy
extends CfnResource
implements IInspectable, IResourcePolicyRef
Creates or updates a Systems Manager resource policy.
A resource policy helps you to define the IAM entity (for example, an AWS account ) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). OpsCenter is a tool in Systems Manager .
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.ssm.*;
Object policy;
CfnResourcePolicy cfnResourcePolicy = CfnResourcePolicy.Builder.create(this, "MyCfnResourcePolicy")
.policy(policy)
.resourceArn("resourceArn")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.IResourcePolicyRef
IResourcePolicyRef.Jsii$Default, IResourcePolicyRef.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef) CfnResourcePolicy(software.constructs.Construct scope, String id, CfnResourcePolicyProps props) -
Method Summary
Modifier and TypeMethodDescriptionID of the current policy version.ID of the current policy version.A policy you want to associate with a resource.The Amazon Resource Name (ARN) of the resource to which you want to attach a policy.A reference to a ResourcePolicy resource.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidA policy you want to associate with a resource.voidsetResourceArn(String value) The Amazon Resource Name (ARN) of the resource to which you want to attach a 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, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrPolicyHash
ID of the current policy version.The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash and the policy ID when updating or deleting a policy.
-
getAttrPolicyId
ID of the current policy version. -
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getResourcePolicyRef
A reference to a ResourcePolicy resource.- Specified by:
getResourcePolicyRefin interfaceIResourcePolicyRef
-
getPolicy
A policy you want to associate with a resource. -
setPolicy
A policy you want to associate with a resource. -
getResourceArn
The Amazon Resource Name (ARN) of the resource to which you want to attach a policy. -
setResourceArn
The Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
-