Skip to content
v2.275.0

CfnPolicyStoreProps Struct ​

Properties for defining a CfnPolicyStore.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_verifiedpermissions as verifiedpermissions } from 'aws-cdk-lib';

declare const default_: any;
const cfnPolicyStoreProps: verifiedpermissions.CfnPolicyStoreProps = {
  validationSettings: {
    mode: 'mode',
  },

  // the properties below are optional
  deletionProtection: {
    mode: 'mode',
  },
  description: 'description',
  encryptionSettings: {
    default: default_,
    kmsEncryptionSettings: {
      key: 'key',

      // the properties below are optional
      encryptionContext: {
        encryptionContextKey: 'encryptionContext',
      },
    },
  },
  schema: {
    cedarJson: 'cedarJson',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

deletionProtectionoptionalIResolvable | CfnPolicyStore.DeletionProtectionPropertydeletion_protectionoptionaltyping.Union[IResolvable, DeletionProtectionProperty]deletionProtectionoptionalIResolvableDeletionProtectionoptionalIResolvableDeletionProtectionoptionalinterface{}#
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

The default state is DISABLED .

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Descriptive text that you can provide to help with identification of the current policy store.
encryptionSettingsoptionalIResolvable | CfnPolicyStore.EncryptionSettingsPropertyencryption_settingsoptionaltyping.Union[IResolvable, EncryptionSettingsProperty]encryptionSettingsoptionalIResolvableEncryptionSettingsoptionalIResolvableEncryptionSettingsoptionalinterface{}#
schemaoptionalIResolvable | CfnPolicyStore.SchemaDefinitionPropertyschemaoptionaltyping.Union[IResolvable, SchemaDefinitionProperty]schemaoptionalIResolvableSchemaoptionalIResolvableSchemaoptionalinterface{}#
Creates or updates the policy schema in a policy store.
notes

Cedar can use the schema to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The list of key-value pairs to associate with the policy store.
validationSettingsIResolvable | CfnPolicyStore.ValidationSettingsPropertyvalidation_settingstyping.Union[IResolvable, ValidationSettingsProperty]validationSettingsIResolvableValidationSettingsIResolvableValidationSettingsinterface{}required#
Specifies the validation setting for this policy store.
notes

Currently, the only valid and required value is Mode .

We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore . Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.