View a markdown version of this page

AWS::HealthLake::DataTransformationProfile - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::HealthLake::DataTransformationProfile

Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::HealthLake::DataTransformationProfile",
  "Properties" : {
      "KmsKeyId" : String,
      "ProfileDescription" : String,
      "ProfileName" : String,
      "Source" : Source,
      "SourceFormat" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::HealthLake::DataTransformationProfile
Properties:
  KmsKeyId: String
  ProfileDescription: String
  ProfileName: String
  Source: 
    Source
  SourceFormat: String
  Tags: 
    - Tag

Properties

KmsKeyId

The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

ProfileDescription

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

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: Replacement

ProfileName

A name for the data transformation profile.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

Source

The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.

Required: No

Type: Source

Update requires: Replacement

SourceFormat

The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).

Required: Yes

Type: String

Allowed values: CCDA | CSV

Update requires: Replacement

Tags

The tags to associate with the profile at creation time.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

ProfileId

The unique identifier of the profile.

TargetFormat

The target output format of the profile.