AWS::HealthLake::FHIRDatastore - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::HealthLake::FHIRDatastore

Creates a Data Store that can ingest and export FHIR formatted data.

Important

Please note that when a user tries to do an Update operation via CloudFormation, changes to the Data Store name, Type Version, PreloadDataConfig, or SSEConfiguration will delete their existing Data Store for the stack and create a new one. This will lead to potential loss of data.

Syntax

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

JSON

{
  "Type" : "AWS::HealthLake::FHIRDatastore",
  "Properties" : {
      "DatastoreName" : String,
      "DatastoreTypeVersion" : String,
      "IdentityProviderConfiguration" : IdentityProviderConfiguration,
      "PreloadDataConfig" : PreloadDataConfig,
      "SseConfiguration" : SseConfiguration,
      "Tags" : [ Tag, ... ]
    }
}

Properties

DatastoreName

The user generated name for the data store.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

DatastoreTypeVersion

The FHIR version of the data store. The only supported version is R4.

Required: Yes

Type: String

Allowed values: R4

Update requires: Replacement

IdentityProviderConfiguration

The identity provider configuration that you gave when the data store was created.

Required: No

Type: IdentityProviderConfiguration

Update requires: Replacement

PreloadDataConfig

The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

Required: No

Type: PreloadDataConfig

Update requires: Replacement

SseConfiguration

The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.

Required: No

Type: SseConfiguration

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

DatastoreArn

The Data Store ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation request.

DatastoreEndpoint

The endpoint for the created Data Store.

DatastoreId

The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.

DatastoreStatus

The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.