Package software.amazon.awscdk.services.healthlake

Interface CfnDataTransformationProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataTransformationProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:04.685Z")
@Stability(Stable)
public interface CfnDataTransformationProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataTransformationProfile.

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.healthlake.*;
 CfnDataTransformationProfileProps cfnDataTransformationProfileProps = CfnDataTransformationProfileProps.builder()
         .profileName("profileName")
         .sourceFormat("sourceFormat")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .profileDescription("profileDescription")
         .source(SourceProperty.builder()
                 .existingVersionedProfileId(ExistingVersionedProfileSourceProperty.builder()
                         .profileId("profileId")
                         .version(123)
                         .build())
                 .profileMapping(ProfileMappingSourceProperty.builder()
                         .profileMapping(Map.of(
                                 "profileMappingKey", "profileMapping"))
                         .build())
                 .starterProfile(StarterProfileSourceProperty.builder()
                         .starterProfileName("starterProfileName")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataTransformationProfileProps.Builder	A builder for CfnDataTransformationProfileProps
static final class	CfnDataTransformationProfileProps.Jsii$Proxy	An implementation for CfnDataTransformationProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnDataTransformationProfileProps.Builder	builder()
default String	getKmsKeyId()	The identifier (key ID or ARN) of a customer-managed KMS key used to encrypt the profile's template content at rest.
default String	getProfileDescription()	A human-readable description of the profile's purpose.
String	getProfileName()	The human-readable name of the profile.
default Object	getSource()	The source from which to create the profile's initial template content.
String	getSourceFormat()	The source format that this profile converts from.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProfileName

@Stability(Stable)
@NotNull
String getProfileName()

The human-readable name of the profile.

See Also:

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

getSourceFormat

@Stability(Stable)
@NotNull
String getSourceFormat()

The source format that this profile converts from.

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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 Also:

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

getProfileDescription

@Stability(Stable)
@Nullable
default String getProfileDescription()

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

See Also:

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

getSource

@Stability(Stable)
@Nullable
default Object getSource()

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.

Returns union: either IResolvable or CfnDataTransformationProfile.SourceProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnDataTransformationProfileProps.Builder builder()

Returns:

a CfnDataTransformationProfileProps.Builder of CfnDataTransformationProfileProps