software.amazon.awscdk.services.ssm

Class CfnResourcePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.960Z")
 @Stability(value=Stable)
public class CfnResourcePolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::ResourcePolicy`.

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

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAttrPolicyHash() ID of the current policy version.
String	getAttrPolicyId() ID of the current policy version.
protected Map<String,Object>	getCfnProperties()
Object	getPolicy() A policy you want to associate with a resource.
String	getResourceArn() Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPolicy(Object value) A policy you want to associate with a resource.
void	setResourceArn(String value) Amazon Resource Name (ARN) of the resource to which you want to attach a 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 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnResourcePolicy(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnResourcePolicyProps props)

Create a new `AWS::SSM::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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrPolicyHash

@Stability(value=Stable)
 @NotNull
public String 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

@Stability(value=Stable)
 @NotNull
public String getAttrPolicyId()

ID of the current policy version.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPolicy

@Stability(value=Stable)
 @NotNull
public Object getPolicy()

A policy you want to associate with a resource.

setPolicy

@Stability(value=Stable)
public void setPolicy(@NotNull
                                               Object value)

A policy you want to associate with a resource.

getResourceArn

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

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

setResourceArn

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

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.