CfnDataTransformationProfilePropsMixin

class aws_cdk.cfn_property_mixins.aws_healthlake.CfnDataTransformationProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a Data Transformation Profile in AWS HealthLake that converts healthcare data from a source format (such as C-CDA or CSV) into FHIR R4.

A profile is immutable once created; to change its template content, replace the resource. Only its tags can be updated in place.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-datatransformationprofile.html
CloudformationResource:: AWS::HealthLake::DataTransformationProfile
Mixin:: true
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.cfn_property_mixins import aws_healthlake as healthlake
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_data_transformation_profile_props_mixin = healthlake.CfnDataTransformationProfilePropsMixin(healthlake.CfnDataTransformationProfileMixinProps(
    kms_key_id="kmsKeyId",
    profile_description="profileDescription",
    profile_name="profileName",
    source=healthlake.CfnDataTransformationProfilePropsMixin.SourceProperty(
        existing_versioned_profile_id=healthlake.CfnDataTransformationProfilePropsMixin.ExistingVersionedProfileSourceProperty(
            profile_id="profileId",
            version=123
        ),
        profile_mapping=healthlake.CfnDataTransformationProfilePropsMixin.ProfileMappingSourceProperty(
            profile_mapping={
                "profile_mapping_key": "profileMapping"
            }
        ),
        starter_profile=healthlake.CfnDataTransformationProfilePropsMixin.StarterProfileSourceProperty(
            starter_profile_name="starterProfileName"
        )
    ),
    source_format="sourceFormat",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::HealthLake::DataTransformationProfile.

Parameters:

props (Union[CfnDataTransformationProfileMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['kmsKeyId', 'profileDescription', 'profileName', 'source', 'sourceFormat', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ExistingVersionedProfileSourceProperty

class CfnDataTransformationProfilePropsMixin.ExistingVersionedProfileSourceProperty(*, profile_id=None, version=None)

Bases: object

Create the profile by cloning a specific version of an existing profile.

Parameters:

profile_id (Optional[str]) – The unique identifier of the source profile to clone.
version (Union[int, float, None]) – The version number of the source profile to clone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-existingversionedprofilesource.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.cfn_property_mixins import aws_healthlake as healthlake

existing_versioned_profile_source_property = healthlake.CfnDataTransformationProfilePropsMixin.ExistingVersionedProfileSourceProperty(
    profile_id="profileId",
    version=123
)

Attributes

profile_id

The unique identifier of the source profile to clone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-existingversionedprofilesource.html#cfn-healthlake-datatransformationprofile-existingversionedprofilesource-profileid

version

The version number of the source profile to clone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-existingversionedprofilesource.html#cfn-healthlake-datatransformationprofile-existingversionedprofilesource-version

ProfileMappingSourceProperty

class CfnDataTransformationProfilePropsMixin.ProfileMappingSourceProperty(*, profile_mapping=None)

Bases: object

Create the profile from raw Velocity template mapping content.

Parameters:: profile_mapping (Union[IResolvable, Mapping[str, str], None]) – Map of template file paths to their Velocity template content.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-profilemappingsource.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.cfn_property_mixins import aws_healthlake as healthlake

profile_mapping_source_property = healthlake.CfnDataTransformationProfilePropsMixin.ProfileMappingSourceProperty(
    profile_mapping={
        "profile_mapping_key": "profileMapping"
    }
)

Attributes

profile_mapping

Map of template file paths to their Velocity template content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-profilemappingsource.html#cfn-healthlake-datatransformationprofile-profilemappingsource-profilemapping

SourceProperty

class CfnDataTransformationProfilePropsMixin.SourceProperty(*, existing_versioned_profile_id=None, profile_mapping=None, starter_profile=None)

Bases: object

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.

Parameters:

existing_versioned_profile_id (Union[IResolvable, ExistingVersionedProfileSourceProperty, Dict[str, Any], None]) – Create the profile by cloning a specific version of an existing profile.
profile_mapping (Union[IResolvable, ProfileMappingSourceProperty, Dict[str, Any], None]) – Create the profile from raw Velocity template mapping content.
starter_profile (Union[IResolvable, StarterProfileSourceProperty, Dict[str, Any], None]) – Create the profile from a predefined starter profile of transformation templates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-source.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.cfn_property_mixins import aws_healthlake as healthlake

source_property = healthlake.CfnDataTransformationProfilePropsMixin.SourceProperty(
    existing_versioned_profile_id=healthlake.CfnDataTransformationProfilePropsMixin.ExistingVersionedProfileSourceProperty(
        profile_id="profileId",
        version=123
    ),
    profile_mapping=healthlake.CfnDataTransformationProfilePropsMixin.ProfileMappingSourceProperty(
        profile_mapping={
            "profile_mapping_key": "profileMapping"
        }
    ),
    starter_profile=healthlake.CfnDataTransformationProfilePropsMixin.StarterProfileSourceProperty(
        starter_profile_name="starterProfileName"
    )
)

Attributes

existing_versioned_profile_id

Create the profile by cloning a specific version of an existing profile.

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

profile_mapping

Create the profile from raw Velocity template mapping content.

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

starter_profile

Create the profile from a predefined starter profile of transformation templates.

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

StarterProfileSourceProperty

class CfnDataTransformationProfilePropsMixin.StarterProfileSourceProperty(*, starter_profile_name=None)

Bases: object

Create the profile from a predefined starter profile of transformation templates.

Parameters:: starter_profile_name (Optional[str]) – The name of the starter profile to seed the profile from.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-starterprofilesource.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.cfn_property_mixins import aws_healthlake as healthlake

starter_profile_source_property = healthlake.CfnDataTransformationProfilePropsMixin.StarterProfileSourceProperty(
    starter_profile_name="starterProfileName"
)

Attributes

starter_profile_name

The name of the starter profile to seed the profile from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-datatransformationprofile-starterprofilesource.html#cfn-healthlake-datatransformationprofile-starterprofilesource-starterprofilename