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:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.149Z") @Stability(Stable) public class CfnPolicyStatement extends CfnResource implements IInspectable
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:
  • 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

    • 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

      @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
    • getArn

      @Stability(Stable) @NotNull public String getArn()
      The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
    • setArn

      @Stability(Stable) public void setArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.
    • getStatementId

      @Stability(Stable) @NotNull public String getStatementId()
      A statement identifier that differentiates the statement from others in the same policy.
    • setStatementId

      @Stability(Stable) public void setStatementId(@NotNull String value)
      A statement identifier that differentiates the statement from others in the same policy.
    • getAction

      @Stability(Stable) @Nullable public List<String> getAction()
      The action that the principal can use on the resource.
    • setAction

      @Stability(Stable) public void setAction(@Nullable List<String> value)
      The action that the principal can use on the resource.
    • getCondition

      @Stability(Stable) @Nullable public String getCondition()
      A set of condition keys that you can use in key policies.
    • setCondition

      @Stability(Stable) public void setCondition(@Nullable String value)
      A set of condition keys that you can use in key policies.
    • getEffect

      @Stability(Stable) @Nullable public String getEffect()
      Determines whether the permissions specified in the policy are to be allowed ( Allow ) or denied ( Deny ).
    • setEffect

      @Stability(Stable) public void setEffect(@Nullable String value)
      Determines whether the permissions specified in the policy are to be allowed ( Allow ) or denied ( Deny ).
    • getPrincipal

      @Stability(Stable) @Nullable public List<String> getPrincipal()
      The AWS service or AWS account that can access the resource defined as ARN.
    • setPrincipal

      @Stability(Stable) public void setPrincipal(@Nullable List<String> value)
      The AWS service or AWS account that can access the resource defined as ARN.