Construct Hub

• Implements: IInspectable

A CloudFormation AWS::HealthLake::FHIRDatastore.

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

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.

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

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.*;

CfnFHIRDatastore cfnFHIRDatastore = CfnFHIRDatastore.Builder.create(this, "MyCfnFHIRDatastore")
        .datastoreTypeVersion("datastoreTypeVersion")

        // the properties below are optional
        .datastoreName("datastoreName")
        .preloadDataConfig(PreloadDataConfigProperty.builder()
                .preloadDataType("preloadDataType")
                .build())
        .sseConfiguration(SseConfigurationProperty.builder()
                .kmsEncryptionConfig(KmsEncryptionConfigProperty.builder()
                        .cmkType("cmkType")

                        // the properties below are optional
                        .kmsKeyId("kmsKeyId")
                        .build())
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();

import software.amazon.awscdk.services.healthlake.CfnFHIRDatastore;

CfnFHIRDatastore.Builder.create(Construct scope, java.lang.String id)
    .datastoreTypeVersion(java.lang.String)
//  .datastoreName(java.lang.String)
//  .preloadDataConfig(PreloadDataConfigProperty)
//  .preloadDataConfig(IResolvable)
//  .sseConfiguration(IResolvable)
//  .sseConfiguration(SseConfigurationProperty)
//  .tags(java.util.List<CfnTag>)
    .build();

• Type: Construct

scope in which this resource is defined.

• Type: java.lang.String

scoped id of the resource.

• Type: java.lang.String

The FHIR version of the Data Store.

The only supported version is R4.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastoretypeversion

• Type: java.lang.String

The user generated name for the Data Store.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastorename

• Type: PreloadDataConfigProperty OR IResolvable

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-preloaddataconfig

• Type: IResolvable OR SseConfigurationProperty

The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-sseconfiguration

• Type: java.util.List<CfnTag>

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

For more information, see Tag .

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

public java.lang.String toString()

Returns a string representation of this construct.

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

• Type: java.lang.String

The new logical ID to use for this stack element.

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

• Type: java.lang.String

The path of the value to delete.

public void addDependsOn(CfnResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

• Type: CfnResource

public void addMetadata(java.lang.String key, java.lang.Object value)

Add a value to the CloudFormation Resource Metadata.

[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

• Type: java.lang.String

• Type: java.lang.Object

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

• Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

• Type: java.lang.Object

The value.

Could be primitive or complex.

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

• Type: java.lang.String

The path to the property.

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

• Type: java.lang.String

The path of the property.

• Type: java.lang.Object

The value.

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

• Type: RemovalPolicy

• Type: RemovalPolicyOptions

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

• Type: java.lang.String

The name of the attribute.

public java.lang.Object getMetadata(java.lang.String key)

Retrieve a value value from the CloudFormation Resource Metadata.

[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

• Type: java.lang.String

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

• Type: TreeInspector

tree inspector to collect and process attributes.

import software.amazon.awscdk.services.healthlake.CfnFHIRDatastore;

CfnFHIRDatastore.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

• Type: java.lang.Object

import software.amazon.awscdk.services.healthlake.CfnFHIRDatastore;

CfnFHIRDatastore.isCfnElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

• Type: java.lang.Object

import software.amazon.awscdk.services.healthlake.CfnFHIRDatastore;

CfnFHIRDatastore.isCfnResource(IConstruct construct)

Check whether the given construct is a CfnResource.

• Type: IConstruct

public ConstructNode getNode();

• Type: ConstructNode

The construct tree node associated with this construct.

public java.util.List<java.lang.String> getCreationStack();

• Type: java.util.List<java.lang.String>

public java.lang.String getLogicalId();

• Type: java.lang.String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

public Stack getStack();

• Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

public java.lang.String getRef();

• Type: java.lang.String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

public ICfnResourceOptions getCfnOptions();

• Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

public java.lang.String getCfnResourceType();

• Type: java.lang.String

AWS resource type.

public java.lang.Number getAttrCreatedAtNanos();

• Type: java.lang.Number

public java.lang.String getAttrCreatedAtSeconds();

• Type: java.lang.String

public java.lang.String getAttrDatastoreArn();

• Type: java.lang.String

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.

public java.lang.String getAttrDatastoreEndpoint();

• Type: java.lang.String

The endpoint for the created Data Store.

public java.lang.String getAttrDatastoreId();

• Type: java.lang.String

The Amazon generated Data Store id.

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

public java.lang.String getAttrDatastoreStatus();

• Type: java.lang.String

The status of the FHIR Data Store.

Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.

public TagManager getTags();

• Type: TagManager

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

For more information, see Tag .

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

public java.lang.String getDatastoreTypeVersion();

• Type: java.lang.String

The FHIR version of the Data Store.

The only supported version is R4.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastoretypeversion

public java.lang.String getDatastoreName();

• Type: java.lang.String

The user generated name for the Data Store.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastorename

public java.lang.Object getPreloadDataConfig();

• Type: PreloadDataConfigProperty OR IResolvable

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-preloaddataconfig

public java.lang.Object getSseConfiguration();

• Type: IResolvable OR SseConfigurationProperty

The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-sseconfiguration

public java.lang.String getCfnResourceTypeName();

• Type: java.lang.String

The CloudFormation resource type name for this resource class.