Class CfnPolicyGrant

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPolicyGrant

Implements

IInspectable

IPolicyGrantRef

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.CfnPropertyName(string)

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.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataZone

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPolicyGrant : CfnResource, IInspectable, IPolicyGrantRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnPolicyGrant Inherits CfnResource Implements IInspectable, IPolicyGrantRef, IConstruct, IDependable, IEnvironmentAware

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

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.DataZone;

             var allDomainUnitsGrantFilter;
             var allUsersGrantFilter;
             var createEnvironment;
             var createEnvironmentFromBlueprint;
             var delegateCreateEnvironmentProfile;

             var cfnPolicyGrant = new CfnPolicyGrant(this, "MyCfnPolicyGrant", new CfnPolicyGrantProps {
                 DomainIdentifier = "domainIdentifier",
                 EntityIdentifier = "entityIdentifier",
                 EntityType = "entityType",
                 PolicyType = "policyType",

                 // the properties below are optional
                 Detail = new PolicyGrantDetailProperty {
                     AddToProjectMemberPool = new AddToProjectMemberPoolPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateAssetType = new CreateAssetTypePolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateDomainUnit = new CreateDomainUnitPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateEnvironment = createEnvironment,
                     CreateEnvironmentFromBlueprint = createEnvironmentFromBlueprint,
                     CreateEnvironmentProfile = new CreateEnvironmentProfilePolicyGrantDetailProperty {
                         DomainUnitId = "domainUnitId"
                     },
                     CreateFormType = new CreateFormTypePolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateGlossary = new CreateGlossaryPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateProject = new CreateProjectPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     CreateProjectFromProjectProfile = new CreateProjectFromProjectProfilePolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false,
                         ProjectProfiles = new [] { "projectProfiles" }
                     },
                     DelegateCreateEnvironmentProfile = delegateCreateEnvironmentProfile,
                     OverrideDomainUnitOwners = new OverrideDomainUnitOwnersPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     },
                     OverrideProjectOwners = new OverrideProjectOwnersPolicyGrantDetailProperty {
                         IncludeChildDomainUnits = false
                     }
                 },
                 Principal = new PolicyGrantPrincipalProperty {
                     DomainUnit = new DomainUnitPolicyGrantPrincipalProperty {
                         DomainUnitDesignation = "domainUnitDesignation",
                         DomainUnitGrantFilter = new DomainUnitGrantFilterProperty {
                             AllDomainUnitsGrantFilter = allDomainUnitsGrantFilter
                         },
                         DomainUnitIdentifier = "domainUnitIdentifier"
                     },
                     Group = new GroupPolicyGrantPrincipalProperty {
                         GroupIdentifier = "groupIdentifier"
                     },
                     Project = new ProjectPolicyGrantPrincipalProperty {
                         ProjectDesignation = "projectDesignation",
                         ProjectGrantFilter = new ProjectGrantFilterProperty {
                             DomainUnitFilter = new DomainUnitFilterForProjectProperty {
                                 DomainUnit = "domainUnit",

                                 // the properties below are optional
                                 IncludeChildDomainUnits = false
                             }
                         },
                         ProjectIdentifier = "projectIdentifier"
                     },
                     User = new UserPolicyGrantPrincipalProperty {
                         AllUsersGrantFilter = allUsersGrantFilter,
                         UserIdentifier = "userIdentifier"
                     }
                 }
             });

Synopsis

Constructors

CfnPolicyGrant(Construct, string, ICfnPolicyGrantProps)

Create a new AWS::DataZone::PolicyGrant.

Properties

AttrCreatedAt	Specifies the timestamp at which policy grant member was created.
AttrCreatedBy	Specifies the user who created the policy grant member.
AttrGrantId	The unique identifier of the policy grant returned by the AddPolicyGrant API.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
CfnPropertyNames	Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
Detail	The details of the policy grant member.
DomainIdentifier	The ID of the domain where you want to add a policy grant.
EntityIdentifier	The ID of the entity (resource) to which you want to add a policy grant.
EntityType	The type of entity (resource) to which the grant is added.
PolicyGrantRef	A reference to a PolicyGrant resource.
PolicyType	The type of policy that you want to grant.
Principal	The principal of the policy grant member.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnPolicyGrant(object)	Checks whether the given object is a CfnPolicyGrant.
RenderProperties(IDictionary<string, object>)	Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

Constructors

CfnPolicyGrant(Construct, string, ICfnPolicyGrantProps)

Create a new AWS::DataZone::PolicyGrant.

public CfnPolicyGrant(Construct scope, string id, ICfnPolicyGrantProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnPolicyGrantProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

Specifies the timestamp at which policy grant member was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrCreatedBy

Specifies the user who created the policy grant member.

public virtual string AttrCreatedBy { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedBy

AttrGrantId

The unique identifier of the policy grant returned by the AddPolicyGrant API.

public virtual string AttrGrantId { get; }

Property Value

string

Remarks

CloudformationAttribute: GrantId

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

CfnProperties

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

CfnPropertyNames

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

Detail

The details of the policy grant member.

public virtual object? Detail { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPolicyGrant.IPolicyGrantDetailProperty

DomainIdentifier

The ID of the domain where you want to add a policy grant.

public virtual string DomainIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

EntityIdentifier

The ID of the entity (resource) to which you want to add a policy grant.

public virtual string EntityIdentifier { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

EntityType

The type of entity (resource) to which the grant is added.

public virtual string EntityType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

PolicyGrantRef

A reference to a PolicyGrant resource.

public virtual IPolicyGrantReference PolicyGrantRef { get; }

Property Value

IPolicyGrantReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

PolicyType

The type of policy that you want to grant.

public virtual string PolicyType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

Principal

The principal of the policy grant member.

public virtual object? Principal { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPolicyGrant.IPolicyGrantPrincipalProperty

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

IsCfnPolicyGrant(object)

Checks whether the given object is a CfnPolicyGrant.

public static bool IsCfnPolicyGrant(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html

CloudformationResource: AWS::DataZone::PolicyGrant

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPolicyGrantRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware