Class CfnPolicyStatement
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.entityresolution.CfnPolicyStatement
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,IPolicyStatementRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-10T13:40:06.211Z")
@Stability(Stable)
public class CfnPolicyStatement
extends CfnResource
implements IInspectable, IPolicyStatementRef
Adds a policy statement object.
To retrieve a list of existing policy statements, use the GetPolicy API.
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.entityresolution.*;
CfnPolicyStatement cfnPolicyStatement = CfnPolicyStatement.Builder.create(this, "MyCfnPolicyStatement")
.arn("arn")
.statementId("statementId")
// the properties below are optional
.action(List.of("action"))
.condition("condition")
.effect("effect")
.principal(List.of("principal"))
.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.entityresolution.IPolicyStatementRef
IPolicyStatementRef.Jsii$Default, IPolicyStatementRef.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnPolicyStatement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnPolicyStatement(software.amazon.jsii.JsiiObjectRef objRef) CfnPolicyStatement(software.constructs.Construct scope, String id, CfnPolicyStatementProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe action that the principal can use on the resource.getArn()The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.A set of condition keys that you can use in key policies.Determines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny).A reference to a PolicyStatement resource.The AWS service or AWS account that can access the resource defined as ARN.A statement identifier that differentiates the statement from others in the same policy.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidThe action that the principal can use on the resource.voidThe Amazon Resource Name (ARN) of the resource that will be accessed by the principal.voidsetCondition(String value) A set of condition keys that you can use in key policies.voidDetermines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny).voidsetPrincipal(List<String> value) The AWS service or AWS account that can access the resource defined as ARN.voidsetStatementId(String value) A statement identifier that differentiates the statement from others in the same policy.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.awscdk.IEnvironmentAware
getEnvMethods 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
-
CfnPolicyStatement
protected CfnPolicyStatement(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPolicyStatement
protected CfnPolicyStatement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPolicyStatement
@Stability(Stable) public CfnPolicyStatement(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPolicyStatementProps 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.
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getPolicyStatementRef
A reference to a PolicyStatement resource.- Specified by:
getPolicyStatementRefin interfaceIPolicyStatementRef
-
getArn
The Amazon Resource Name (ARN) of the resource that will be accessed by the principal. -
setArn
The Amazon Resource Name (ARN) of the resource that will be accessed by the principal. -
getStatementId
A statement identifier that differentiates the statement from others in the same policy. -
setStatementId
A statement identifier that differentiates the statement from others in the same policy. -
getAction
The action that the principal can use on the resource. -
setAction
The action that the principal can use on the resource. -
getCondition
A set of condition keys that you can use in key policies. -
setCondition
A set of condition keys that you can use in key policies. -
getEffect
Determines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny). -
setEffect
Determines whether the permissions specified in the policy are to be allowed (Allow) or denied (Deny). -
getPrincipal
The AWS service or AWS account that can access the resource defined as ARN. -
setPrincipal
The AWS service or AWS account that can access the resource defined as ARN.
-