Package 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, ITaggable, IFHIRDatastoreRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:41.087Z") @Stability(Stable) public class CfnFHIRDatastore extends CfnResource implements IInspectable, IFHIRDatastoreRef, ITaggable
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")
         .identityProviderConfiguration(IdentityProviderConfigurationProperty.builder()
                 .authorizationStrategy("authorizationStrategy")
                 // the properties below are optional
                 .fineGrainedAuthorizationEnabled(false)
                 .idpLambdaArn("idpLambdaArn")
                 .metadata("metadata")
                 .build())
         .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();

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

    • CfnFHIRDatastore

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

    • CfnFHIRDatastore

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

    • CfnFHIRDatastore

      @Stability(Stable) public CfnFHIRDatastore(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFHIRDatastoreProps props)
      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

    • fromDatastoreId

      @Stability(Stable) @NotNull public static IFHIRDatastoreRef fromDatastoreId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String datastoreId)
      Creates a new IFHIRDatastoreRef from a datastoreId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      datastoreId - 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public IResolvable getAttrCreatedAt()
      The time that a Data Store was created.

    • getAttrCreatedAtNanos

      @Stability(Stable) @NotNull public Number getAttrCreatedAtNanos()

    • getAttrCreatedAtSeconds

      @Stability(Stable) @NotNull public String getAttrCreatedAtSeconds()

    • getAttrDatastoreArn

      @Stability(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(Stable) @NotNull public String getAttrDatastoreEndpoint()
      The endpoint for the created Data Store.

    • getAttrDatastoreId

      @Stability(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(Stable) @NotNull public String getAttrDatastoreStatus()
      The status of the FHIR Data Store.

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

    • getCfnProperties

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

    • getFhirDatastoreRef

      @Stability(Stable) @NotNull public FHIRDatastoreReference getFhirDatastoreRef()
      A reference to a FHIRDatastore resource.
      Specified by:
      getFhirDatastoreRef in interface IFHIRDatastoreRef

    • getTags

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

    • getDatastoreTypeVersion

      @Stability(Stable) @NotNull public String getDatastoreTypeVersion()
      The FHIR release version supported by the data store.

    • setDatastoreTypeVersion

      @Stability(Stable) public void setDatastoreTypeVersion(@NotNull String value)
      The FHIR release version supported by the data store.

    • getDatastoreName

      @Stability(Stable) @Nullable public String getDatastoreName()
      The data store name (user-generated).

    • setDatastoreName

      @Stability(Stable) public void setDatastoreName(@Nullable String value)
      The data store name (user-generated).

    • getIdentityProviderConfiguration

      @Stability(Stable) @Nullable public Object getIdentityProviderConfiguration()
      The identity provider configuration selected when the data store was created.

      Returns union: either IResolvable or CfnFHIRDatastore.IdentityProviderConfigurationProperty

    • setIdentityProviderConfiguration

      @Stability(Stable) public void setIdentityProviderConfiguration(@Nullable IResolvable value)
      The identity provider configuration selected when the data store was created.

    • setIdentityProviderConfiguration

      @Stability(Stable) public void setIdentityProviderConfiguration(@Nullable CfnFHIRDatastore.IdentityProviderConfigurationProperty value)
      The identity provider configuration selected when the data store was created.

    • getPreloadDataConfig

      @Stability(Stable) @Nullable public Object getPreloadDataConfig()
      The preloaded Synthea data configuration for the data store.

      Returns union: either IResolvable or CfnFHIRDatastore.PreloadDataConfigProperty

    • setPreloadDataConfig

      @Stability(Stable) public void setPreloadDataConfig(@Nullable IResolvable value)
      The preloaded Synthea data configuration for the data store.

    • setPreloadDataConfig

      @Stability(Stable) public void setPreloadDataConfig(@Nullable CfnFHIRDatastore.PreloadDataConfigProperty value)
      The preloaded Synthea data configuration for the data store.

    • getSseConfiguration

      @Stability(Stable) @Nullable public Object getSseConfiguration()
      The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.

      Returns union: either IResolvable or CfnFHIRDatastore.SseConfigurationProperty

    • setSseConfiguration

      @Stability(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.

    • setSseConfiguration

      @Stability(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.

    • getTagsRaw

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

    • setTagsRaw

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