CfnDataTransformationProfileProps

class aws_cdk.aws_healthlake.CfnDataTransformationProfileProps(*, profile_name, source_format, kms_key_id=None, profile_description=None, source=None, tags=None)

Bases: object

Properties for defining a CfnDataTransformationProfile.

Parameters:

• profile_name (str) – The human-readable name of the profile.

• source_format (str) – The source format that this profile converts from.

• kms_key_id (Optional[str]) – The identifier (key ID or ARN) of a customer-managed KMS key used to encrypt the profile’s template content at rest. If omitted, an AWS owned key is used.

• profile_description (Optional[str]) – A human-readable description of the profile’s purpose.

• source (Union[IResolvable, SourceProperty, Dict[str, Any], None]) – The source from which to create the profile’s initial template content. Exactly one of the members must be specified. Use StarterProfile (C-CDA only), ProfileMapping (C-CDA or CSV), or ExistingVersionedProfileId to clone an existing profile. Each produces a published profile.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_data_transformation_profile_props = healthlake.CfnDataTransformationProfileProps(
    profile_name="profileName",
    source_format="sourceFormat",

    # the properties below are optional
    kms_key_id="kmsKeyId",
    profile_description="profileDescription",
    source=healthlake.CfnDataTransformationProfile.SourceProperty(
        existing_versioned_profile_id=healthlake.CfnDataTransformationProfile.ExistingVersionedProfileSourceProperty(
            profile_id="profileId",
            version=123
        ),
        profile_mapping=healthlake.CfnDataTransformationProfile.ProfileMappingSourceProperty(
            profile_mapping={
                "profile_mapping_key": "profileMapping"
            }
        ),
        starter_profile=healthlake.CfnDataTransformationProfile.StarterProfileSourceProperty(
            starter_profile_name="starterProfileName"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

kms_key_id

The identifier (key ID or ARN) of a customer-managed KMS key used to encrypt the profile’s template content at rest.

If omitted, an AWS owned key is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-kmskeyid

profile_description

A human-readable description of the profile’s purpose.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-profiledescription

profile_name

The human-readable name of the profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-profilename

source

The source from which to create the profile’s initial template content.

Exactly one of the members must be specified. Use StarterProfile (C-CDA only), ProfileMapping (C-CDA or CSV), or ExistingVersionedProfileId to clone an existing profile. Each produces a published profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-source

source_format

The source format that this profile converts from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-sourceformat

tags

An array of key-value pairs to apply to this profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html#cfn-healthlake-datatransformationprofile-tags