MDAA TS Docs
    Preparing search index...

    Interface HealthLakeDatastoreDefinition

    Per-datastore configuration for a HealthLake FHIR R4 datastore.

    The datastore's MDAA-prefixed name is derived from the map key under which this definition is registered; do not include the datastore name here.

    interface HealthLakeDatastoreDefinition {
        acknowledgeReplacement?: boolean;
        identityProviderConfiguration?: IdentityProviderConfiguration;
        preloadSynthea?: boolean;
        rawBucketArn: string;
    }
    Index

    Properties

    acknowledgeReplacement? identityProviderConfiguration? preloadSynthea? rawBucketArn

    Properties

    acknowledgeReplacement?: boolean

    Explicitly permits a change to this datastore's name, kmsKeyArn (module-level), identityProviderConfiguration, or preloadSynthea — fields whose change causes AWS::HealthLake::FHIRDatastore to be replaced (deleted and recreated), risking data loss. When false (default), such a change fails the deployment before the datastore is touched. Set to true only when the replacement is intentional.

    false
    identityProviderConfiguration?: IdentityProviderConfiguration

    Identity provider configuration for SMART on FHIR authorization for this datastore. When omitted, defaults to AWS_AUTH (IAM Signature v4).

    { authorizationStrategy: 'AWS_AUTH' }
    preloadSynthea?: boolean

    Preload Synthea sample data into this datastore.

    false
    rawBucketArn: string

    S3 bucket ARN for HealthLake import/export data access for this datastore. Must be a bare bucket ARN with no key/prefix suffix — a key-prefixed ARN produces an invalid bucket-level IAM resource and fails at import/export time. The bare-ARN shape is enforced at construction (skipped for unresolved references, which validate at deploy time) rather than via a schema pattern, so MDAA config references (e.g. ssm-domain:) that resolve to CDK tokens are still accepted.

    Settings

    Member Visibility

    On This Page

    Properties