Class CfnPolicy

Creates or updates a Cedar policy and saves it in the specified policy store.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPolicy

Implements

IInspectable

IPolicyRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.VerifiedPermissions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPolicy : CfnResource, IInspectable, IPolicyRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnPolicy Inherits CfnResource Implements IInspectable, IPolicyRef, IConstruct, IDependable, IEnvironmentAware

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

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 cfnPolicy = new CfnPolicy(this, "MyCfnPolicy", new CfnPolicyProps {
                 Definition = new PolicyDefinitionProperty {
                     Static = new StaticPolicyDefinitionProperty {
                         Statement = "statement",

                         // the properties below are optional
                         Description = "description"
                     },
                     TemplateLinked = new TemplateLinkedPolicyDefinitionProperty {
                         PolicyTemplateId = "policyTemplateId",

                         // the properties below are optional
                         Principal = new EntityIdentifierProperty {
                             EntityId = "entityId",
                             EntityType = "entityType"
                         },
                         Resource = new EntityIdentifierProperty {
                             EntityId = "entityId",
                             EntityType = "entityType"
                         }
                     }
                 },
                 PolicyStoreId = "policyStoreId"
             });

Synopsis

Constructors

CfnPolicy(Construct, string, ICfnPolicyProps)

Create a new AWS::VerifiedPermissions::Policy.

Properties

AttrPolicyId	The unique ID of the new or updated policy.
AttrPolicyType	The type of the policy. This is one of the following values:.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates or updates a Cedar policy and saves it in the specified policy store.
Definition	Specifies the policy type and content to use for the new or updated policy.
PolicyRef	A reference to a Policy resource.
PolicyStoreId	Specifies the `PolicyStoreId` of the policy store you want to store the policy in.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnPolicy(object)	Checks whether the given object is a CfnPolicy.
RenderProperties(IDictionary<string, object>)	Creates or updates a Cedar policy and saves it in the specified policy store.

Constructors

CfnPolicy(Construct, string, ICfnPolicyProps)

Create a new AWS::VerifiedPermissions::Policy.

public CfnPolicy(Construct scope, string id, ICfnPolicyProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnPolicyProps: Resource properties.

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

Properties

AttrPolicyId

The unique ID of the new or updated policy.

public virtual string AttrPolicyId { get; }

Property Value

string

Remarks

CloudformationAttribute: PolicyId

AttrPolicyType

The type of the policy. This is one of the following values:.

public virtual string AttrPolicyType { get; }

Property Value

string

Remarks

CloudformationAttribute: PolicyType

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

CfnProperties

Creates or updates a Cedar policy and saves it in the specified policy store.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

Definition

Specifies the policy type and content to use for the new or updated policy.

public virtual object Definition { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPolicy.IPolicyDefinitionProperty

PolicyRef

A reference to a Policy resource.

public virtual IPolicyReference PolicyRef { get; }

Property Value

IPolicyReference

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

PolicyStoreId

Specifies the PolicyStoreId of the policy store you want to store the policy in.

public virtual string PolicyStoreId { get; set; }

Property Value

string

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

IsCfnPolicy(object)

Checks whether the given object is a CfnPolicy.

public static bool IsCfnPolicy(object x)

Parameters

x object

Returns

bool

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates or updates a Cedar policy and saves it in the specified policy store.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update its linked policy template instead.

<ul></ul>

You can't change these elements of a static policy:

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

CloudformationResource: AWS::VerifiedPermissions::Policy

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPolicyRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware