Show / Hide Table of Contents

Class CfnPolicy.PolicyDefinitionProperty

A structure that defines a Cedar policy.

Inheritance
object
CfnPolicy.PolicyDefinitionProperty
Implements
CfnPolicy.IPolicyDefinitionProperty
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 CfnPolicy.PolicyDefinitionProperty : CfnPolicy.IPolicyDefinitionProperty
Syntax (vb)
Public Class CfnPolicy.PolicyDefinitionProperty Implements CfnPolicy.IPolicyDefinitionProperty
Remarks

It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an Static or a TemplateLinked element.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.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 policyDefinitionProperty = 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"
                     }
                 }
             };

Synopsis

Constructors

PolicyDefinitionProperty()

A structure that defines a Cedar policy.

Properties

Static

A structure that describes a static policy.

TemplateLinked

A structure that describes a policy that was instantiated from a template.

Constructors

PolicyDefinitionProperty()

A structure that defines a Cedar policy.

public PolicyDefinitionProperty()
Remarks

It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an Static or a TemplateLinked element.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.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 policyDefinitionProperty = 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"
                     }
                 }
             };

Properties

Static

A structure that describes a static policy.

public object? Static { get; set; }
Property Value

object

Remarks

An static policy doesn't use a template or allow placeholders for entities.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-static

Type union: either IResolvable or CfnPolicy.IStaticPolicyDefinitionProperty

TemplateLinked

A structure that describes a policy that was instantiated from a template.

public object? TemplateLinked { get; set; }
Property Value

object

Remarks

The template can specify placeholders for principal and resource . When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-templatelinked

Type union: either IResolvable or CfnPolicy.ITemplateLinkedPolicyDefinitionProperty

Implements

CfnPolicy.IPolicyDefinitionProperty
Back to top Generated by DocFX