CfnProjectProfile

class aws_cdk.aws_datazone.CfnProjectProfile(scope, id, *, name, description=None, domain_identifier=None, domain_unit_identifier=None, environment_configurations=None, status=None)

Bases: CfnResource

The summary of a project profile.

See:

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

CloudformationResource:

AWS::DataZone::ProjectProfile

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

cfn_project_profile = datazone.CfnProjectProfile(self, "MyCfnProjectProfile",
    name="name",

    # the properties below are optional
    description="description",
    domain_identifier="domainIdentifier",
    domain_unit_identifier="domainUnitIdentifier",
    environment_configurations=[datazone.CfnProjectProfile.EnvironmentConfigurationProperty(
        aws_region=datazone.CfnProjectProfile.RegionProperty(
            region_name="regionName"
        ),
        environment_blueprint_id="environmentBlueprintId",
        name="name",

        # the properties below are optional
        aws_account=datazone.CfnProjectProfile.AwsAccountProperty(
            aws_account_id="awsAccountId"
        ),
        configuration_parameters=datazone.CfnProjectProfile.EnvironmentConfigurationParametersDetailsProperty(
            parameter_overrides=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
                is_editable=False,
                name="name",
                value="value"
            )],
            resolved_parameters=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
                is_editable=False,
                name="name",
                value="value"
            )],
            ssm_path="ssmPath"
        ),
        deployment_mode="deploymentMode",
        deployment_order=123,
        description="description",
        id="id"
    )],
    status="status"
)

Parameters:

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

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

• name (str) – The name of a project profile.

• description (Optional[str]) – The description of the project profile.

• domain_identifier (Optional[str]) – A domain ID of the project profile.

• domain_unit_identifier (Optional[str]) – A domain unit ID of the project profile.

• environment_configurations (Union[IResolvable, Sequence[Union[IResolvable, EnvironmentConfigurationProperty, Dict[str, Any]]], None]) – Environment configurations of a project profile.

• status (Optional[str]) – The status of a project profile.

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:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

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::ProjectProfile'

attr_created_at

The timestamp of when the project profile was created.

CloudformationAttribute:

CreatedAt

attr_created_by

The user who created the project profile.

CloudformationAttribute:

CreatedBy

attr_domain_id

The domain ID of the project profile.

CloudformationAttribute:

DomainId

attr_domain_unit_id

The domain unit ID of the project profile.

CloudformationAttribute:

DomainUnitId

attr_id

The ID of the project profile.

CloudformationAttribute:

Id

attr_identifier

Project profile ID.

CloudformationAttribute:

Identifier

attr_last_updated_at

The timestamp at which a project profile was last updated.

CloudformationAttribute:

LastUpdatedAt

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.

description

The description of the project profile.

domain_identifier

A domain ID of the project profile.

domain_unit_identifier

A domain unit ID of the project profile.

environment_configurations

Environment configurations of a project profile.

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.

name

The name of a project profile.

node

The tree node.

project_profile_ref

A reference to a ProjectProfile resource.

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).

status

The status of a project profile.

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.

AwsAccountProperty

class CfnProjectProfile.AwsAccountProperty(*, aws_account_id)

Bases: object

The AWS account of the environment.

Parameters:

aws_account_id (str) – The account ID of a project.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-awsaccount.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

aws_account_property = datazone.CfnProjectProfile.AwsAccountProperty(
    aws_account_id="awsAccountId"
)

Attributes

aws_account_id

The account ID of a project.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-awsaccount.html#cfn-datazone-projectprofile-awsaccount-awsaccountid

EnvironmentConfigurationParameterProperty

class CfnProjectProfile.EnvironmentConfigurationParameterProperty(*, is_editable=None, name=None, value=None)

Bases: object

The environment configuration parameter.

Parameters:

• is_editable (Union[bool, IResolvable, None]) – Specifies whether the environment parameter is editable.

• name (Optional[str]) – The name of the environment configuration parameter.

• value (Optional[str]) – The value of the environment configuration parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.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

environment_configuration_parameter_property = datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
    is_editable=False,
    name="name",
    value="value"
)

Attributes

is_editable

Specifies whether the environment parameter is editable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-iseditable

name

The name of the environment configuration parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-name

value

The value of the environment configuration parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-value

EnvironmentConfigurationParametersDetailsProperty

class CfnProjectProfile.EnvironmentConfigurationParametersDetailsProperty(*, parameter_overrides=None, resolved_parameters=None, ssm_path=None)

Bases: object

The details of the environment configuration parameter.

Parameters:

• parameter_overrides (Union[IResolvable, Sequence[Union[IResolvable, EnvironmentConfigurationParameterProperty, Dict[str, Any]]], None]) – The parameter overrides.

• resolved_parameters (Union[IResolvable, Sequence[Union[IResolvable, EnvironmentConfigurationParameterProperty, Dict[str, Any]]], None]) – The resolved environment configuration parameters.

• ssm_path (Optional[str]) – Ssm path environment configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.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

environment_configuration_parameters_details_property = datazone.CfnProjectProfile.EnvironmentConfigurationParametersDetailsProperty(
    parameter_overrides=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
        is_editable=False,
        name="name",
        value="value"
    )],
    resolved_parameters=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
        is_editable=False,
        name="name",
        value="value"
    )],
    ssm_path="ssmPath"
)

Attributes

parameter_overrides

The parameter overrides.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-parameteroverrides

resolved_parameters

The resolved environment configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-resolvedparameters

ssm_path

Ssm path environment configuration parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-ssmpath

EnvironmentConfigurationProperty

class CfnProjectProfile.EnvironmentConfigurationProperty(*, aws_region, environment_blueprint_id, name, aws_account=None, configuration_parameters=None, deployment_mode=None, deployment_order=None, description=None, id=None)

Bases: object

The configuration of an environment.

Parameters:

• aws_region (Union[IResolvable, RegionProperty, Dict[str, Any]]) – The AWS Region of the environment.

• environment_blueprint_id (str) – The environment blueprint ID.

• name (str) – The environment name.

• aws_account (Union[IResolvable, AwsAccountProperty, Dict[str, Any], None]) – The AWS account of the environment.

• configuration_parameters (Union[IResolvable, EnvironmentConfigurationParametersDetailsProperty, Dict[str, Any], None]) – The configuration parameters of the environment.

• deployment_mode (Optional[str]) – The deployment mode of the environment.

• deployment_order (Union[int, float, None]) – The deployment order of the environment.

• description (Optional[str]) – The environment description.

• id (Optional[str]) – The environment ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.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

environment_configuration_property = datazone.CfnProjectProfile.EnvironmentConfigurationProperty(
    aws_region=datazone.CfnProjectProfile.RegionProperty(
        region_name="regionName"
    ),
    environment_blueprint_id="environmentBlueprintId",
    name="name",

    # the properties below are optional
    aws_account=datazone.CfnProjectProfile.AwsAccountProperty(
        aws_account_id="awsAccountId"
    ),
    configuration_parameters=datazone.CfnProjectProfile.EnvironmentConfigurationParametersDetailsProperty(
        parameter_overrides=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
            is_editable=False,
            name="name",
            value="value"
        )],
        resolved_parameters=[datazone.CfnProjectProfile.EnvironmentConfigurationParameterProperty(
            is_editable=False,
            name="name",
            value="value"
        )],
        ssm_path="ssmPath"
    ),
    deployment_mode="deploymentMode",
    deployment_order=123,
    description="description",
    id="id"
)

Attributes

aws_account

The AWS account of the environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsaccount

aws_region

The AWS Region of the environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsregion

configuration_parameters

The configuration parameters of the environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-configurationparameters

deployment_mode

The deployment mode of the environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentmode

deployment_order

The deployment order of the environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentorder

description

The environment description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-description

environment_blueprint_id

The environment blueprint ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-environmentblueprintid

id

The environment ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-id

name

The environment name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-name

RegionProperty

class CfnProjectProfile.RegionProperty(*, region_name)

Bases: object

The AWS Region.

Parameters:

region_name (str) – The AWS Region name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-region.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

region_property = datazone.CfnProjectProfile.RegionProperty(
    region_name="regionName"
)

Attributes

region_name

The AWS Region name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-region.html#cfn-datazone-projectprofile-region-regionname