Class CfnPolicyGrant
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datazone.CfnPolicyGrant
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-09-02T11:25:29.415Z")
@Stability(Stable)
public class CfnPolicyGrant
extends CfnResource
implements IInspectable
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.datazone.*; Object allDomainUnitsGrantFilter; Object allUsersGrantFilter; Object createEnvironment; Object createEnvironmentFromBlueprint; Object delegateCreateEnvironmentProfile; CfnPolicyGrant cfnPolicyGrant = CfnPolicyGrant.Builder.create(this, "MyCfnPolicyGrant") .domainIdentifier("domainIdentifier") .entityIdentifier("entityIdentifier") .entityType("entityType") .policyType("policyType") // the properties below are optional .detail(PolicyGrantDetailProperty.builder() .addToProjectMemberPool(AddToProjectMemberPoolPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createAssetType(CreateAssetTypePolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createDomainUnit(CreateDomainUnitPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createEnvironment(createEnvironment) .createEnvironmentFromBlueprint(createEnvironmentFromBlueprint) .createEnvironmentProfile(CreateEnvironmentProfilePolicyGrantDetailProperty.builder() .domainUnitId("domainUnitId") .build()) .createFormType(CreateFormTypePolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createGlossary(CreateGlossaryPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createProject(CreateProjectPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .createProjectFromProjectProfile(CreateProjectFromProjectProfilePolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .projectProfiles(List.of("projectProfiles")) .build()) .delegateCreateEnvironmentProfile(delegateCreateEnvironmentProfile) .overrideDomainUnitOwners(OverrideDomainUnitOwnersPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .overrideProjectOwners(OverrideProjectOwnersPolicyGrantDetailProperty.builder() .includeChildDomainUnits(false) .build()) .build()) .principal(PolicyGrantPrincipalProperty.builder() .domainUnit(DomainUnitPolicyGrantPrincipalProperty.builder() .domainUnitDesignation("domainUnitDesignation") .domainUnitGrantFilter(DomainUnitGrantFilterProperty.builder() .allDomainUnitsGrantFilter(allDomainUnitsGrantFilter) .build()) .domainUnitIdentifier("domainUnitIdentifier") .build()) .group(GroupPolicyGrantPrincipalProperty.builder() .groupIdentifier("groupIdentifier") .build()) .project(ProjectPolicyGrantPrincipalProperty.builder() .projectDesignation("projectDesignation") .projectGrantFilter(ProjectGrantFilterProperty.builder() .domainUnitFilter(DomainUnitFilterForProjectProperty.builder() .domainUnit("domainUnit") // the properties below are optional .includeChildDomainUnits(false) .build()) .build()) .projectIdentifier("projectIdentifier") .build()) .user(UserPolicyGrantPrincipalProperty.builder() .allUsersGrantFilter(allUsersGrantFilter) .userIdentifier("userIdentifier") .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
The details of the policy grant.static final class
A fluent builder forCfnPolicyGrant
.static interface
The details of the policy grant.static interface
The details of the policy grant.static interface
The details of the policy grant.static interface
The details of the policy grant.static interface
The details of the policy grant.static interface
Specifies whether to create a project from project profile policy grant details.static interface
The details of the policy grant.static interface
The domain unit filter of the project grant filter.static interface
The grant filter for the domain unit.static interface
The domain unit principal to whom the policy is granted.static interface
The group principal to whom the policy is granted.static interface
The grant details of the override domain unit owners policy.static interface
The details of the override project owners policy grant.static interface
The details of the policy grant.static interface
The policy grant principal.static interface
The project grant filter.static interface
The project policy grant principal.static interface
The user policy grant principal.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnPolicyGrant
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPolicyGrant
(software.amazon.jsii.JsiiObjectRef objRef) CfnPolicyGrant
(software.constructs.Construct scope, String id, CfnPolicyGrantProps props) -
Method Summary
Modifier and TypeMethodDescriptionSpecifies the timestamp at which policy grant member was created.Specifies the user who created the policy grant member.The unique identifier of the policy grant returned by the AddPolicyGrant API.The details of the policy grant member.The ID of the domain where you want to add a policy grant.The ID of the entity (resource) to which you want to add a policy grant.The type of entity (resource) to which the grant is added.The type of policy that you want to grant.The principal of the policy grant member.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDetail
(IResolvable value) The details of the policy grant member.void
The details of the policy grant member.void
setDomainIdentifier
(String value) The ID of the domain where you want to add a policy grant.void
setEntityIdentifier
(String value) The ID of the entity (resource) to which you want to add a policy grant.void
setEntityType
(String value) The type of entity (resource) to which the grant is added.void
setPolicyType
(String value) The type of policy that you want to grant.void
setPrincipal
(IResolvable value) The principal of the policy grant member.void
The principal of the policy grant member.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPolicyGrant
protected CfnPolicyGrant(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPolicyGrant
protected CfnPolicyGrant(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPolicyGrant
@Stability(Stable) public CfnPolicyGrant(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPolicyGrantProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
Specifies the timestamp at which policy grant member was created. -
getAttrCreatedBy
Specifies the user who created the policy grant member. -
getAttrGrantId
The unique identifier of the policy grant returned by the AddPolicyGrant API. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDomainIdentifier
The ID of the domain where you want to add a policy grant. -
setDomainIdentifier
The ID of the domain where you want to add a policy grant. -
getEntityIdentifier
The ID of the entity (resource) to which you want to add a policy grant. -
setEntityIdentifier
The ID of the entity (resource) to which you want to add a policy grant. -
getEntityType
The type of entity (resource) to which the grant is added. -
setEntityType
The type of entity (resource) to which the grant is added. -
getPolicyType
The type of policy that you want to grant. -
setPolicyType
The type of policy that you want to grant. -
getDetail
The details of the policy grant member. -
setDetail
The details of the policy grant member. -
setDetail
The details of the policy grant member. -
getPrincipal
The principal of the policy grant member. -
setPrincipal
The principal of the policy grant member. -
setPrincipal
@Stability(Stable) public void setPrincipal(@Nullable CfnPolicyGrant.PolicyGrantPrincipalProperty value) The principal of the policy grant member.
-