@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.798Z") public class CfnResourcePolicy extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnResourcePolicy.Builder
A fluent builder for
CfnResourcePolicy . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnResourcePolicy(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrPolicyHash()
ID of the current policy version.
|
java.lang.String |
getAttrPolicyId()
ID of the current policy version.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getPolicy()
A policy you want to associate with a resource.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setPolicy(java.lang.Object value)
A policy you want to associate with a resource.
|
void |
setResourceArn(java.lang.String value)
Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnResourcePolicy(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnResourcePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnResourcePolicy(Construct scope, java.lang.String id, CfnResourcePolicyProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrPolicyHash()
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.
public java.lang.String getAttrPolicyId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getPolicy()
public void setPolicy(java.lang.Object value)
public java.lang.String getResourceArn()
public void setResourceArn(java.lang.String value)