Skip to content
v2.275.0

CfnPolicyGrantProps Struct ​

Properties for defining a CfnPolicyGrant.

Example ​

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

declare const allDomainUnitsGrantFilter: any;
declare const allUsersGrantFilter: any;
declare const createEnvironment: any;
declare const createEnvironmentFromBlueprint: any;
declare const delegateCreateEnvironmentProfile: any;
const cfnPolicyGrantProps: datazone.CfnPolicyGrantProps = {
  detail: {
    addToProjectMemberPool: {
      includeChildDomainUnits: false,
    },
    createAssetType: {
      includeChildDomainUnits: false,
    },
    createDomainUnit: {
      includeChildDomainUnits: false,
    },
    createEnvironment: createEnvironment,
    createEnvironmentFromBlueprint: createEnvironmentFromBlueprint,
    createEnvironmentProfile: {
      domainUnitId: 'domainUnitId',
    },
    createFormType: {
      includeChildDomainUnits: false,
    },
    createGlossary: {
      includeChildDomainUnits: false,
    },
    createProject: {
      includeChildDomainUnits: false,
    },
    createProjectFromProjectProfile: {
      includeChildDomainUnits: false,
      projectProfiles: ['projectProfiles'],
    },
    delegateCreateEnvironmentProfile: delegateCreateEnvironmentProfile,
    overrideDomainUnitOwners: {
      includeChildDomainUnits: false,
    },
    overrideProjectOwners: {
      includeChildDomainUnits: false,
    },
  },
  domainIdentifier: 'domainIdentifier',
  entityIdentifier: 'entityIdentifier',
  entityType: 'entityType',
  policyType: 'policyType',
  principal: {
    domainUnit: {
      domainUnitDesignation: 'domainUnitDesignation',
      domainUnitGrantFilter: {
        allDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
      },
      domainUnitIdentifier: 'domainUnitIdentifier',
    },
    group: {
      groupIdentifier: 'groupIdentifier',
    },
    project: {
      projectDesignation: 'projectDesignation',
      projectGrantFilter: {
        domainUnitFilter: {
          domainUnit: 'domainUnit',

          // the properties below are optional
          includeChildDomainUnits: false,
        },
      },
      projectIdentifier: 'projectIdentifier',
    },
    user: {
      allUsersGrantFilter: allUsersGrantFilter,
      userIdentifier: 'userIdentifier',
    },
  },
};

Properties ​

The details of the policy grant member.
domainIdentifierstringdomain_identifierstrdomainIdentifierStringDomainIdentifierstringDomainIdentifier*stringrequired#
The ID of the domain where you want to add a policy grant.
entityIdentifierstringentity_identifierstrentityIdentifierStringEntityIdentifierstringEntityIdentifier*stringrequired#
The ID of the entity (resource) to which you want to add a policy grant.
entityTypestringentity_typestrentityTypeStringEntityTypestringEntityType*stringrequired#
The type of entity (resource) to which the grant is added.
policyTypestringpolicy_typestrpolicyTypeStringPolicyTypestringPolicyType*stringrequired#
The type of policy that you want to grant.
principalIResolvable | CfnPolicyGrant.PolicyGrantPrincipalPropertyprincipaltyping.Union[IResolvable, PolicyGrantPrincipalProperty]principalIResolvablePrincipalIResolvablePrincipalinterface{}required#
The principal of the policy grant member.