CfnPolicyGrant

class aws_cdk.aws_datazone.CfnPolicyGrant(scope, id, *, domain_identifier, entity_identifier, entity_type, policy_type, detail=None, principal=None)

Bases: CfnResource

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

See:

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

CloudformationResource:

AWS::DataZone::PolicyGrant

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# all_domain_units_grant_filter: Any
# all_users_grant_filter: Any
# create_environment: Any
# create_environment_from_blueprint: Any
# delegate_create_environment_profile: Any

cfn_policy_grant = datazone.CfnPolicyGrant(self, "MyCfnPolicyGrant",
    domain_identifier="domainIdentifier",
    entity_identifier="entityIdentifier",
    entity_type="entityType",
    policy_type="policyType",

    # the properties below are optional
    detail=datazone.CfnPolicyGrant.PolicyGrantDetailProperty(
        add_to_project_member_pool=datazone.CfnPolicyGrant.AddToProjectMemberPoolPolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_asset_type=datazone.CfnPolicyGrant.CreateAssetTypePolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_domain_unit=datazone.CfnPolicyGrant.CreateDomainUnitPolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_environment=create_environment,
        create_environment_from_blueprint=create_environment_from_blueprint,
        create_environment_profile=datazone.CfnPolicyGrant.CreateEnvironmentProfilePolicyGrantDetailProperty(
            domain_unit_id="domainUnitId"
        ),
        create_form_type=datazone.CfnPolicyGrant.CreateFormTypePolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_glossary=datazone.CfnPolicyGrant.CreateGlossaryPolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_project=datazone.CfnPolicyGrant.CreateProjectPolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        create_project_from_project_profile=datazone.CfnPolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetailProperty(
            include_child_domain_units=False,
            project_profiles=["projectProfiles"]
        ),
        delegate_create_environment_profile=delegate_create_environment_profile,
        override_domain_unit_owners=datazone.CfnPolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetailProperty(
            include_child_domain_units=False
        ),
        override_project_owners=datazone.CfnPolicyGrant.OverrideProjectOwnersPolicyGrantDetailProperty(
            include_child_domain_units=False
        )
    ),
    principal=datazone.CfnPolicyGrant.PolicyGrantPrincipalProperty(
        domain_unit=datazone.CfnPolicyGrant.DomainUnitPolicyGrantPrincipalProperty(
            domain_unit_designation="domainUnitDesignation",
            domain_unit_grant_filter=datazone.CfnPolicyGrant.DomainUnitGrantFilterProperty(
                all_domain_units_grant_filter=all_domain_units_grant_filter
            ),
            domain_unit_identifier="domainUnitIdentifier"
        ),
        group=datazone.CfnPolicyGrant.GroupPolicyGrantPrincipalProperty(
            group_identifier="groupIdentifier"
        ),
        project=datazone.CfnPolicyGrant.ProjectPolicyGrantPrincipalProperty(
            project_designation="projectDesignation",
            project_grant_filter=datazone.CfnPolicyGrant.ProjectGrantFilterProperty(
                domain_unit_filter=datazone.CfnPolicyGrant.DomainUnitFilterForProjectProperty(
                    domain_unit="domainUnit",

                    # the properties below are optional
                    include_child_domain_units=False
                )
            ),
            project_identifier="projectIdentifier"
        ),
        user=datazone.CfnPolicyGrant.UserPolicyGrantPrincipalProperty(
            all_users_grant_filter=all_users_grant_filter,
            user_identifier="userIdentifier"
        )
    )
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • domain_identifier (str) – The ID of the domain where you want to add a policy grant.

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

  • entity_type (str) – The type of entity (resource) to which the grant is added.

  • policy_type (str) – The type of policy that you want to grant.

  • detail (Union[IResolvable, PolicyGrantDetailProperty, Dict[str, Any], None]) – The details of the policy grant member.

  • principal (Union[IResolvable, PolicyGrantPrincipalProperty, Dict[str, Any], None]) – The principal of the policy grant member.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DataZone::PolicyGrant'
attr_created_at

Specifies the timestamp at which policy grant member was created.

CloudformationAttribute:

CreatedAt

attr_created_by

Specifies the user who created the policy grant member.

CloudformationAttribute:

CreatedBy

attr_grant_id

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

CloudformationAttribute:

GrantId

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

detail

The details of the policy grant member.

domain_identifier

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

entity_identifier

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

entity_type

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

policy_type

The type of policy that you want to grant.

principal

The principal of the policy grant member.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AddToProjectMemberPoolPolicyGrantDetailProperty

class CfnPolicyGrant.AddToProjectMemberPoolPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

add_to_project_member_pool_policy_grant_detail_property = datazone.CfnPolicyGrant.AddToProjectMemberPoolPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html#cfn-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail-includechilddomainunits

CreateAssetTypePolicyGrantDetailProperty

class CfnPolicyGrant.CreateAssetTypePolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_asset_type_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateAssetTypePolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html#cfn-datazone-policygrant-createassettypepolicygrantdetail-includechilddomainunits

CreateDomainUnitPolicyGrantDetailProperty

class CfnPolicyGrant.CreateDomainUnitPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_domain_unit_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateDomainUnitPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html#cfn-datazone-policygrant-createdomainunitpolicygrantdetail-includechilddomainunits

CreateEnvironmentProfilePolicyGrantDetailProperty

class CfnPolicyGrant.CreateEnvironmentProfilePolicyGrantDetailProperty(*, domain_unit_id=None)

Bases: object

The details of the policy grant.

Parameters:

domain_unit_id (Optional[str]) – The ID of the domain unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_environment_profile_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateEnvironmentProfilePolicyGrantDetailProperty(
    domain_unit_id="domainUnitId"
)

Attributes

domain_unit_id

The ID of the domain unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html#cfn-datazone-policygrant-createenvironmentprofilepolicygrantdetail-domainunitid

CreateFormTypePolicyGrantDetailProperty

class CfnPolicyGrant.CreateFormTypePolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_form_type_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateFormTypePolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html#cfn-datazone-policygrant-createformtypepolicygrantdetail-includechilddomainunits

CreateGlossaryPolicyGrantDetailProperty

class CfnPolicyGrant.CreateGlossaryPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_glossary_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateGlossaryPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html#cfn-datazone-policygrant-createglossarypolicygrantdetail-includechilddomainunits

CreateProjectFromProjectProfilePolicyGrantDetailProperty

class CfnPolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetailProperty(*, include_child_domain_units=None, project_profiles=None)

Bases: object

Specifies whether to create a project from project profile policy grant details.

Parameters:

  • include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether to include child domain units when creating a project from project profile policy grant details.

  • project_profiles (Optional[Sequence[str]]) – Specifies project profiles when creating a project from project profile policy grant details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_project_from_project_profile_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetailProperty(
    include_child_domain_units=False,
    project_profiles=["projectProfiles"]
)

Attributes

include_child_domain_units

Specifies whether to include child domain units when creating a project from project profile policy grant details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-includechilddomainunits

project_profiles

Specifies project profiles when creating a project from project profile policy grant details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-projectprofiles

CreateProjectPolicyGrantDetailProperty

class CfnPolicyGrant.CreateProjectPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

create_project_policy_grant_detail_property = datazone.CfnPolicyGrant.CreateProjectPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy grant is applied to child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html#cfn-datazone-policygrant-createprojectpolicygrantdetail-includechilddomainunits

DomainUnitFilterForProjectProperty

class CfnPolicyGrant.DomainUnitFilterForProjectProperty(*, domain_unit, include_child_domain_units=None)

Bases: object

The domain unit filter of the project grant filter.

Parameters:

  • domain_unit (str) – The domain unit ID to use in the filter.

  • include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether to include child domain units. Default: - false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

domain_unit_filter_for_project_property = datazone.CfnPolicyGrant.DomainUnitFilterForProjectProperty(
    domain_unit="domainUnit",

    # the properties below are optional
    include_child_domain_units=False
)

Attributes

domain_unit

The domain unit ID to use in the filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-domainunit

include_child_domain_units

Specifies whether to include child domain units.

Default:

  • false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-includechilddomainunits

DomainUnitGrantFilterProperty

class CfnPolicyGrant.DomainUnitGrantFilterProperty(*, all_domain_units_grant_filter)

Bases: object

The grant filter for the domain unit.

In the current release of Amazon DataZone, the only supported filter is the allDomainUnitsGrantFilter .

Parameters:

all_domain_units_grant_filter (Any) – Specifies a grant filter containing all domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitgrantfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# all_domain_units_grant_filter: Any

domain_unit_grant_filter_property = datazone.CfnPolicyGrant.DomainUnitGrantFilterProperty(
    all_domain_units_grant_filter=all_domain_units_grant_filter
)

Attributes

all_domain_units_grant_filter

Specifies a grant filter containing all domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitgrantfilter.html#cfn-datazone-policygrant-domainunitgrantfilter-alldomainunitsgrantfilter

DomainUnitPolicyGrantPrincipalProperty

class CfnPolicyGrant.DomainUnitPolicyGrantPrincipalProperty(*, domain_unit_designation=None, domain_unit_grant_filter=None, domain_unit_identifier=None)

Bases: object

The domain unit principal to whom the policy is granted.

Parameters:

  • domain_unit_designation (Optional[str]) – Specifes the designation of the domain unit users.

  • domain_unit_grant_filter (Union[IResolvable, DomainUnitGrantFilterProperty, Dict[str, Any], None]) – The grant filter for the domain unit.

  • domain_unit_identifier (Optional[str]) – The ID of the domain unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# all_domain_units_grant_filter: Any

domain_unit_policy_grant_principal_property = datazone.CfnPolicyGrant.DomainUnitPolicyGrantPrincipalProperty(
    domain_unit_designation="domainUnitDesignation",
    domain_unit_grant_filter=datazone.CfnPolicyGrant.DomainUnitGrantFilterProperty(
        all_domain_units_grant_filter=all_domain_units_grant_filter
    ),
    domain_unit_identifier="domainUnitIdentifier"
)

Attributes

domain_unit_designation

Specifes the designation of the domain unit users.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitdesignation

domain_unit_grant_filter

The grant filter for the domain unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitgrantfilter

domain_unit_identifier

The ID of the domain unit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitidentifier

GroupPolicyGrantPrincipalProperty

class CfnPolicyGrant.GroupPolicyGrantPrincipalProperty(*, group_identifier)

Bases: object

The group principal to whom the policy is granted.

Parameters:

group_identifier (str) – The ID Of the group of the group principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-grouppolicygrantprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

group_policy_grant_principal_property = datazone.CfnPolicyGrant.GroupPolicyGrantPrincipalProperty(
    group_identifier="groupIdentifier"
)

Attributes

group_identifier

The ID Of the group of the group principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-grouppolicygrantprincipal.html#cfn-datazone-policygrant-grouppolicygrantprincipal-groupidentifier

OverrideDomainUnitOwnersPolicyGrantDetailProperty

class CfnPolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The grant details of the override domain unit owners policy.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy is inherited by child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

override_domain_unit_owners_policy_grant_detail_property = datazone.CfnPolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy is inherited by child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html#cfn-datazone-policygrant-overridedomainunitownerspolicygrantdetail-includechilddomainunits

OverrideProjectOwnersPolicyGrantDetailProperty

class CfnPolicyGrant.OverrideProjectOwnersPolicyGrantDetailProperty(*, include_child_domain_units=None)

Bases: object

The details of the override project owners policy grant.

Parameters:

include_child_domain_units (Union[bool, IResolvable, None]) – Specifies whether the policy is inherited by child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

override_project_owners_policy_grant_detail_property = datazone.CfnPolicyGrant.OverrideProjectOwnersPolicyGrantDetailProperty(
    include_child_domain_units=False
)

Attributes

include_child_domain_units

Specifies whether the policy is inherited by child domain units.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html#cfn-datazone-policygrant-overrideprojectownerspolicygrantdetail-includechilddomainunits

PolicyGrantDetailProperty

class CfnPolicyGrant.PolicyGrantDetailProperty(*, add_to_project_member_pool=None, create_asset_type=None, create_domain_unit=None, create_environment=None, create_environment_from_blueprint=None, create_environment_profile=None, create_form_type=None, create_glossary=None, create_project=None, create_project_from_project_profile=None, delegate_create_environment_profile=None, override_domain_unit_owners=None, override_project_owners=None)

Bases: object

The details of the policy grant.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# create_environment: Any
# create_environment_from_blueprint: Any
# delegate_create_environment_profile: Any

policy_grant_detail_property = datazone.CfnPolicyGrant.PolicyGrantDetailProperty(
    add_to_project_member_pool=datazone.CfnPolicyGrant.AddToProjectMemberPoolPolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_asset_type=datazone.CfnPolicyGrant.CreateAssetTypePolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_domain_unit=datazone.CfnPolicyGrant.CreateDomainUnitPolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_environment=create_environment,
    create_environment_from_blueprint=create_environment_from_blueprint,
    create_environment_profile=datazone.CfnPolicyGrant.CreateEnvironmentProfilePolicyGrantDetailProperty(
        domain_unit_id="domainUnitId"
    ),
    create_form_type=datazone.CfnPolicyGrant.CreateFormTypePolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_glossary=datazone.CfnPolicyGrant.CreateGlossaryPolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_project=datazone.CfnPolicyGrant.CreateProjectPolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    create_project_from_project_profile=datazone.CfnPolicyGrant.CreateProjectFromProjectProfilePolicyGrantDetailProperty(
        include_child_domain_units=False,
        project_profiles=["projectProfiles"]
    ),
    delegate_create_environment_profile=delegate_create_environment_profile,
    override_domain_unit_owners=datazone.CfnPolicyGrant.OverrideDomainUnitOwnersPolicyGrantDetailProperty(
        include_child_domain_units=False
    ),
    override_project_owners=datazone.CfnPolicyGrant.OverrideProjectOwnersPolicyGrantDetailProperty(
        include_child_domain_units=False
    )
)

Attributes

add_to_project_member_pool

Specifies that the policy grant is to be added to the members of the project.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-addtoprojectmemberpool

create_asset_type

Specifies that this is a create asset type policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createassettype

create_domain_unit

Specifies that this is a create domain unit policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createdomainunit

create_environment

Specifies that this is a create environment policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironment

create_environment_from_blueprint

The details of the policy of creating an environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentfromblueprint

create_environment_profile

Specifies that this is a create environment profile policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentprofile

create_form_type

Specifies that this is a create form type policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createformtype

create_glossary

Specifies that this is a create glossary policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createglossary

create_project

Specifies that this is a create project policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createproject

create_project_from_project_profile

Specifies whether to create a project from project profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createprojectfromprojectprofile

delegate_create_environment_profile

Specifies that this is the delegation of the create environment profile policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-delegatecreateenvironmentprofile

override_domain_unit_owners

Specifies whether to override domain unit owners.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overridedomainunitowners

override_project_owners

Specifies whether to override project owners.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overrideprojectowners

PolicyGrantPrincipalProperty

class CfnPolicyGrant.PolicyGrantPrincipalProperty(*, domain_unit=None, group=None, project=None, user=None)

Bases: object

The policy grant principal.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# all_domain_units_grant_filter: Any
# all_users_grant_filter: Any

policy_grant_principal_property = datazone.CfnPolicyGrant.PolicyGrantPrincipalProperty(
    domain_unit=datazone.CfnPolicyGrant.DomainUnitPolicyGrantPrincipalProperty(
        domain_unit_designation="domainUnitDesignation",
        domain_unit_grant_filter=datazone.CfnPolicyGrant.DomainUnitGrantFilterProperty(
            all_domain_units_grant_filter=all_domain_units_grant_filter
        ),
        domain_unit_identifier="domainUnitIdentifier"
    ),
    group=datazone.CfnPolicyGrant.GroupPolicyGrantPrincipalProperty(
        group_identifier="groupIdentifier"
    ),
    project=datazone.CfnPolicyGrant.ProjectPolicyGrantPrincipalProperty(
        project_designation="projectDesignation",
        project_grant_filter=datazone.CfnPolicyGrant.ProjectGrantFilterProperty(
            domain_unit_filter=datazone.CfnPolicyGrant.DomainUnitFilterForProjectProperty(
                domain_unit="domainUnit",

                # the properties below are optional
                include_child_domain_units=False
            )
        ),
        project_identifier="projectIdentifier"
    ),
    user=datazone.CfnPolicyGrant.UserPolicyGrantPrincipalProperty(
        all_users_grant_filter=all_users_grant_filter,
        user_identifier="userIdentifier"
    )
)

Attributes

domain_unit

The domain unit of the policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-domainunit

group

The group of the policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-group

project

The project of the policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-project

user

The user of the policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-user

ProjectGrantFilterProperty

class CfnPolicyGrant.ProjectGrantFilterProperty(*, domain_unit_filter)

Bases: object

The project grant filter.

Parameters:

domain_unit_filter (Union[IResolvable, DomainUnitFilterForProjectProperty, Dict[str, Any]]) – The domain unit filter of the project grant filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectgrantfilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

project_grant_filter_property = datazone.CfnPolicyGrant.ProjectGrantFilterProperty(
    domain_unit_filter=datazone.CfnPolicyGrant.DomainUnitFilterForProjectProperty(
        domain_unit="domainUnit",

        # the properties below are optional
        include_child_domain_units=False
    )
)

Attributes

domain_unit_filter

The domain unit filter of the project grant filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectgrantfilter.html#cfn-datazone-policygrant-projectgrantfilter-domainunitfilter

ProjectPolicyGrantPrincipalProperty

class CfnPolicyGrant.ProjectPolicyGrantPrincipalProperty(*, project_designation=None, project_grant_filter=None, project_identifier=None)

Bases: object

The project policy grant principal.

Parameters:

  • project_designation (Optional[str]) – The project designation of the project policy grant principal.

  • project_grant_filter (Union[IResolvable, ProjectGrantFilterProperty, Dict[str, Any], None]) – The project grant filter of the project policy grant principal.

  • project_identifier (Optional[str]) – The project ID of the project policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

project_policy_grant_principal_property = datazone.CfnPolicyGrant.ProjectPolicyGrantPrincipalProperty(
    project_designation="projectDesignation",
    project_grant_filter=datazone.CfnPolicyGrant.ProjectGrantFilterProperty(
        domain_unit_filter=datazone.CfnPolicyGrant.DomainUnitFilterForProjectProperty(
            domain_unit="domainUnit",

            # the properties below are optional
            include_child_domain_units=False
        )
    ),
    project_identifier="projectIdentifier"
)

Attributes

project_designation

The project designation of the project policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectdesignation

project_grant_filter

The project grant filter of the project policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectgrantfilter

project_identifier

The project ID of the project policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectidentifier

UserPolicyGrantPrincipalProperty

class CfnPolicyGrant.UserPolicyGrantPrincipalProperty(*, all_users_grant_filter=None, user_identifier=None)

Bases: object

The user policy grant principal.

Parameters:

  • all_users_grant_filter (Any) – The all users grant filter of the user policy grant principal.

  • user_identifier (Optional[str]) – The user ID of the user policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datazone as datazone

# all_users_grant_filter: Any

user_policy_grant_principal_property = datazone.CfnPolicyGrant.UserPolicyGrantPrincipalProperty(
    all_users_grant_filter=all_users_grant_filter,
    user_identifier="userIdentifier"
)

Attributes

all_users_grant_filter

The all users grant filter of the user policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-allusersgrantfilter

user_identifier

The user ID of the user policy grant principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-useridentifier