software.amazon.awscdk.services.healthlake

Class CfnFHIRDatastore

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.CfnFHIRDatastore

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.705Z")
 @Stability(value=Stable)
public class CfnFHIRDatastore
extends CfnResource
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.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFHIRDatastore.Builder A fluent builder for CfnFHIRDatastore.
static interface	CfnFHIRDatastore.KmsEncryptionConfigProperty The customer-managed-key(CMK) used when creating a Data Store.
static interface	CfnFHIRDatastore.PreloadDataConfigProperty Optional parameter to preload data upon creation of the Data Store.
static interface	CfnFHIRDatastore.SseConfigurationProperty The server-side encryption key configuration for a customer provided encryption key.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFHIRDatastore(software.constructs.Construct scope, String id, CfnFHIRDatastoreProps props) Create a new `AWS::HealthLake::FHIRDatastore`.
protected	CfnFHIRDatastore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFHIRDatastore(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDatastoreArn() 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.
String	getAttrDatastoreEndpoint() The endpoint for the created Data Store.
String	getAttrDatastoreId() The Amazon generated Data Store id.
String	getAttrDatastoreStatus() The status of the FHIR Data Store.
protected Map<String,Object>	getCfnProperties()
String	getDatastoreName() The user generated name for the Data Store.
String	getDatastoreTypeVersion() The FHIR version of the Data Store.
Object	getPreloadDataConfig() The preloaded data configuration for the Data Store.
Object	getSseConfiguration() The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatastoreName(String value) The user generated name for the Data Store.
void	setDatastoreTypeVersion(String value) The FHIR version of the Data Store.
void	setPreloadDataConfig(CfnFHIRDatastore.PreloadDataConfigProperty value) The preloaded data configuration for the Data Store.
void	setPreloadDataConfig(IResolvable value) The preloaded data configuration for the Data Store.
void	setSseConfiguration(CfnFHIRDatastore.SseConfigurationProperty value) The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.
void	setSseConfiguration(IResolvable value) The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFHIRDatastore

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

CfnFHIRDatastore

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

CfnFHIRDatastore

@Stability(value=Stable)
public CfnFHIRDatastore(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnFHIRDatastoreProps props)

Create a new `AWS::HealthLake::FHIRDatastore`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDatastoreArn

@Stability(value=Stable)
 @NotNull
public String getAttrDatastoreArn()

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.

getAttrDatastoreEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrDatastoreEndpoint()

The endpoint for the created Data Store.

getAttrDatastoreId

@Stability(value=Stable)
 @NotNull
public String getAttrDatastoreId()

The Amazon generated Data Store id.

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

getAttrDatastoreStatus

@Stability(value=Stable)
 @NotNull
public String getAttrDatastoreStatus()

The status of the FHIR Data Store.

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDatastoreTypeVersion

@Stability(value=Stable)
 @NotNull
public String getDatastoreTypeVersion()

The FHIR version of the Data Store.

The only supported version is R4.

setDatastoreTypeVersion

@Stability(value=Stable)
public void setDatastoreTypeVersion(@NotNull
                                                             String value)

The FHIR version of the Data Store.

The only supported version is R4.

getDatastoreName

@Stability(value=Stable)
 @Nullable
public String getDatastoreName()

The user generated name for the Data Store.

setDatastoreName

@Stability(value=Stable)
public void setDatastoreName(@Nullable
                                                      String value)

The user generated name for the Data Store.

getPreloadDataConfig

@Stability(value=Stable)
 @Nullable
public Object getPreloadDataConfig()

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

setPreloadDataConfig

@Stability(value=Stable)
public void setPreloadDataConfig(@Nullable
                                                          CfnFHIRDatastore.PreloadDataConfigProperty value)

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

setPreloadDataConfig

@Stability(value=Stable)
public void setPreloadDataConfig(@Nullable
                                                          IResolvable value)

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

getSseConfiguration

@Stability(value=Stable)
 @Nullable
public Object getSseConfiguration()

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

setSseConfiguration

@Stability(value=Stable)
public void setSseConfiguration(@Nullable
                                                         CfnFHIRDatastore.SseConfigurationProperty value)

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

setSseConfiguration

@Stability(value=Stable)
public void setSseConfiguration(@Nullable
                                                         IResolvable value)

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