Package software.amazon.awscdk.services.verifiedpermissions

Class CfnPolicyStore

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.verifiedpermissions.CfnPolicyStore
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPolicyStoreRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:31.295Z") @Stability(Stable) public class CfnPolicyStore extends CfnResource implements IInspectable, IPolicyStoreRef, ITaggableV2
Creates a policy store.

A policy store is a container for policy resources. You can create a separate policy store for each of your applications.

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.verifiedpermissions.*;
 CfnPolicyStore cfnPolicyStore = CfnPolicyStore.Builder.create(this, "MyCfnPolicyStore")
         .validationSettings(ValidationSettingsProperty.builder()
                 .mode("mode")
                 .build())
         // the properties below are optional
         .deletionProtection(DeletionProtectionProperty.builder()
                 .mode("mode")
                 .build())
         .description("description")
         .schema(SchemaDefinitionProperty.builder()
                 .cedarFormat("cedarFormat")
                 .cedarJson("cedarJson")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnPolicyStore

      protected CfnPolicyStore(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPolicyStore

      protected CfnPolicyStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPolicyStore

      @Stability(Stable) public CfnPolicyStore(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPolicyStoreProps props)
      Create a new AWS::VerifiedPermissions::PolicyStore.

      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

    • arnForPolicyStore

      @Stability(Stable) @NotNull public static String arnForPolicyStore(@NotNull IPolicyStoreRef resource)
      Parameters:
      resource - This parameter is required.

    • fromPolicyStoreArn

      @Stability(Stable) @NotNull public static IPolicyStoreRef fromPolicyStoreArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IPolicyStoreRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromPolicyStoreId

      @Stability(Stable) @NotNull public static IPolicyStoreRef fromPolicyStoreId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String policyStoreId)
      Creates a new IPolicyStoreRef from a policyStoreId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      policyStoreId - This parameter is required.

    • isCfnPolicyStore

      @Stability(Stable) @NotNull public static Boolean isCfnPolicyStore(@NotNull Object x)
      Checks whether the given object is a CfnPolicyStore.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the new or updated policy store.

    • getAttrPolicyStoreId

      @Stability(Stable) @NotNull public String getAttrPolicyStoreId()
      The unique ID of the new or updated policy store.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPolicyStoreRef

      @Stability(Stable) @NotNull public PolicyStoreReference getPolicyStoreRef()
      A reference to a PolicyStore resource.
      Specified by:
      getPolicyStoreRef in interface IPolicyStoreRef

    • getValidationSettings

      @Stability(Stable) @NotNull public Object getValidationSettings()
      Specifies the validation setting for this policy store.

      Returns union: either IResolvable or CfnPolicyStore.ValidationSettingsProperty

    • setValidationSettings

      @Stability(Stable) public void setValidationSettings(@NotNull IResolvable value)
      Specifies the validation setting for this policy store.

    • setValidationSettings

      @Stability(Stable) public void setValidationSettings(@NotNull CfnPolicyStore.ValidationSettingsProperty value)
      Specifies the validation setting for this policy store.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Specifies whether the policy store can be deleted.

      If enabled, the policy store can't be deleted.

      Returns union: either IResolvable or CfnPolicyStore.DeletionProtectionProperty

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Specifies whether the policy store can be deleted.

      If enabled, the policy store can't be deleted.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable CfnPolicyStore.DeletionProtectionProperty value)
      Specifies whether the policy store can be deleted.

      If enabled, the policy store can't be deleted.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Descriptive text that you can provide to help with identification of the current policy store.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Descriptive text that you can provide to help with identification of the current policy store.

    • getSchema

      @Stability(Stable) @Nullable public Object getSchema()
      Creates or updates the policy schema in a policy store.

      Returns union: either IResolvable or CfnPolicyStore.SchemaDefinitionProperty

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable IResolvable value)
      Creates or updates the policy schema in a policy store.

    • setSchema

      @Stability(Stable) public void setSchema(@Nullable CfnPolicyStore.SchemaDefinitionProperty value)
      Creates or updates the policy schema in a policy store.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The list of key-value pairs to associate with the policy store.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The list of key-value pairs to associate with the policy store.