Class CfnPolicyStoreProps

Properties for defining a CfnPolicyStore.

Inheritance

object

CfnPolicyStoreProps

Implements

ICfnPolicyStoreProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.VerifiedPermissions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPolicyStoreProps : ICfnPolicyStoreProps

Syntax (vb)

Public Class CfnPolicyStoreProps Implements ICfnPolicyStoreProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.VerifiedPermissions;

             var default_;

             var cfnPolicyStoreProps = new CfnPolicyStoreProps {
                 ValidationSettings = new ValidationSettingsProperty {
                     Mode = "mode"
                 },

                 // the properties below are optional
                 DeletionProtection = new DeletionProtectionProperty {
                     Mode = "mode"
                 },
                 Description = "description",
                 EncryptionSettings = new EncryptionSettingsProperty {
                     Default = default_,
                     KmsEncryptionSettings = new KmsEncryptionSettingsProperty {
                         Key = "key",

                         // the properties below are optional
                         EncryptionContext = new Dictionary<string, string> {
                             { "encryptionContextKey", "encryptionContext" }
                         }
                     }
                 },
                 Schema = new SchemaDefinitionProperty {
                     CedarJson = "cedarJson"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnPolicyStoreProps()

Properties for defining a CfnPolicyStore.

Properties

DeletionProtection	Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
Description	Descriptive text that you can provide to help with identification of the current policy store.
EncryptionSettings	Properties for defining a CfnPolicyStore.
Schema	Creates or updates the policy schema in a policy store.
Tags	The list of key-value pairs to associate with the policy store.
ValidationSettings	Specifies the validation setting for this policy store.

Constructors

CfnPolicyStoreProps()

Properties for defining a CfnPolicyStore.

public CfnPolicyStoreProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.VerifiedPermissions;

             var default_;

             var cfnPolicyStoreProps = new CfnPolicyStoreProps {
                 ValidationSettings = new ValidationSettingsProperty {
                     Mode = "mode"
                 },

                 // the properties below are optional
                 DeletionProtection = new DeletionProtectionProperty {
                     Mode = "mode"
                 },
                 Description = "description",
                 EncryptionSettings = new EncryptionSettingsProperty {
                     Default = default_,
                     KmsEncryptionSettings = new KmsEncryptionSettingsProperty {
                         Key = "key",

                         // the properties below are optional
                         EncryptionContext = new Dictionary<string, string> {
                             { "encryptionContextKey", "encryptionContext" }
                         }
                     }
                 },
                 Schema = new SchemaDefinitionProperty {
                     CedarJson = "cedarJson"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DeletionProtection

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

public object? DeletionProtection { get; set; }

Property Value

object

Remarks

The default state is DISABLED .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-deletionprotection

Type union: either IResolvable or CfnPolicyStore.IDeletionProtectionProperty

Description

Descriptive text that you can provide to help with identification of the current policy store.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-description

EncryptionSettings

Properties for defining a CfnPolicyStore.

public object? EncryptionSettings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-encryptionsettings

Type union: either IResolvable or CfnPolicyStore.IEncryptionSettingsProperty

Schema

Creates or updates the policy schema in a policy store.

public object? Schema { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-schema

Type union: either IResolvable or CfnPolicyStore.ISchemaDefinitionProperty

Tags

The list of key-value pairs to associate with the policy store.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-tags

ValidationSettings

Specifies the validation setting for this policy store.

public object ValidationSettings { get; set; }

Property Value

object

Remarks

Currently, the only valid and required value is Mode .

We recommend that you turn on <code>STRICT</code> mode only after you define a schema. If a schema doesn't exist, then <code>STRICT</code> mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> . Then, when you have a schema defined, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> again to turn validation back on.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html#cfn-verifiedpermissions-policystore-validationsettings

Type union: either IResolvable or CfnPolicyStore.IValidationSettingsProperty

Implements

ICfnPolicyStoreProps