MDAA TS Docs
    Preparing search index...

    Interface HealthLakeL3ConstructProps

    Properties for the HealthLakeL3Construct.

    interface HealthLakeL3ConstructProps {
        createOutputs?: boolean;
        createParams?: boolean;
        crossAccountStacks?: { [account: string]: { [region: string]: Stack } };
        dataAdminRoles?: MdaaRoleRef[];
        datastores: { [datastoreName: string]: HealthLakeDatastoreDefinition };
        kmsKeyArn?: string;
        naming: IMdaaResourceNaming;
        roleHelper: MdaaRoleHelper;
        tags?: { [key: string]: string };
    }

    Hierarchy (View Summary)

    Index

    Properties

    createOutputs? createParams? crossAccountStacks? dataAdminRoles? datastores kmsKeyArn? naming roleHelper tags?

    Properties

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    crossAccountStacks?: { [account: string]: { [region: string]: Stack } }
    dataAdminRoles?: MdaaRoleRef[]

    Roles granted administer and use permissions on the auto-created KMS key. Only applies when kmsKeyArn is omitted (the module creates the key). Because MdaaKmsKey forces RemovalPolicy.RETAIN, a key created without any admin role is retained after stack teardown with only an account-root key policy — leaving a PHI-encrypting key that no normal role can administer. Supplying data-admin roles here avoids that. When kmsKeyArn is provided, the caller owns the key policy and this property is ignored.

    none (key created with only the default account-root policy)
    datastores: { [datastoreName: string]: HealthLakeDatastoreDefinition }

    Named map of HealthLake datastores to deploy. Each map key is the datastore name suffix (combined with MDAA naming prefix); each value is the per-datastore configuration.

    kmsKeyArn?: string

    KMS key ARN used to encrypt all datastores. If not provided, a customer-managed KMS key is created automatically and shared across datastores. Must be a fully-qualified key ARN (not an alias) — HealthLake's SseConfiguration requires a key ARN, and an invalid value fails at CreateFHIRDatastore. Not constrained by a schema pattern so that MDAA config references (e.g. ssm-domain:) which resolve to CDK tokens are accepted; the ARN is consumed by MdaaKmsKey.fromKeyArn.

    auto-created
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    roleHelper: MdaaRoleHelper
    tags?: { [key: string]: string }

    Settings

    Member Visibility

    On This Page

    Properties