Package software.amazon.awscdk.services.healthlake

Class CfnDataTransformationProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.healthlake.CfnDataTransformationProfile
All Implemented Interfaces:
IInspectable, IDataTransformationProfileRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:04.682Z") @Stability(Stable) public class CfnDataTransformationProfile extends CfnResource implements IInspectable, IDataTransformationProfileRef, ITaggableV2
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.

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.*;
 CfnDataTransformationProfile cfnDataTransformationProfile = CfnDataTransformationProfile.Builder.create(this, "MyCfnDataTransformationProfile")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataTransformationProfile

      protected CfnDataTransformationProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataTransformationProfile

      protected CfnDataTransformationProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataTransformationProfile

      @Stability(Stable) public CfnDataTransformationProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataTransformationProfileProps props)
      Create a new AWS::HealthLake::DataTransformationProfile.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDataTransformationProfile

      @Stability(Stable) @NotNull public static String arnForDataTransformationProfile(@NotNull IDataTransformationProfileRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDataTransformationProfile

      @Stability(Stable) @NotNull public static Boolean isCfnDataTransformationProfile(@NotNull Object x)
      Checks whether the given object is a CfnDataTransformationProfile.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the data transformation profile.

    • getAttrProfileId

      @Stability(Stable) @NotNull public String getAttrProfileId()
      The unique, server-generated identifier of the profile (32-character lowercase hexadecimal).

    • getAttrTargetFormat

      @Stability(Stable) @NotNull public String getAttrTargetFormat()
      The target format that this profile converts to.

      Always FHIR_R4.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getDataTransformationProfileRef

      @Stability(Stable) @NotNull public DataTransformationProfileReference getDataTransformationProfileRef()
      A reference to a DataTransformationProfile resource.
      Specified by:
      getDataTransformationProfileRef in interface IDataTransformationProfileRef

    • getProfileName

      @Stability(Stable) @NotNull public String getProfileName()
      The human-readable name of the profile.

    • setProfileName

      @Stability(Stable) public void setProfileName(@NotNull String value)
      The human-readable name of the profile.

    • getSourceFormat

      @Stability(Stable) @NotNull public String getSourceFormat()
      The source format that this profile converts from.

    • setSourceFormat

      @Stability(Stable) public void setSourceFormat(@NotNull String value)
      The source format that this profile converts from.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The identifier (key ID or ARN) of a customer-managed KMS key used to encrypt the profile's template content at rest.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The identifier (key ID or ARN) of a customer-managed KMS key used to encrypt the profile's template content at rest.

    • getProfileDescription

      @Stability(Stable) @Nullable public String getProfileDescription()
      A human-readable description of the profile's purpose.

    • setProfileDescription

      @Stability(Stable) public void setProfileDescription(@Nullable String value)
      A human-readable description of the profile's purpose.

    • getSource

      @Stability(Stable) @Nullable public Object getSource()
      The source from which to create the profile's initial template content.

      Returns union: either IResolvable or CfnDataTransformationProfile.SourceProperty

    • setSource

      @Stability(Stable) public void setSource(@Nullable IResolvable value)
      The source from which to create the profile's initial template content.

    • setSource

      @Stability(Stable) public void setSource(@Nullable CfnDataTransformationProfile.SourceProperty value)
      The source from which to create the profile's initial template content.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this profile.