Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. healthlake
  5. FhirDatastore

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.healthlake.FhirDatastore

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    HealthLake FHIR Datastore

    Create FhirDatastore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FhirDatastore(name: string, args: FhirDatastoreArgs, opts?: CustomResourceOptions);
    @overload
def FhirDatastore(resource_name: str,
                  args: FhirDatastoreArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def FhirDatastore(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  datastore_type_version: Optional[FhirDatastoreDatastoreTypeVersion] = None,
                  datastore_name: Optional[str] = None,
                  identity_provider_configuration: Optional[FhirDatastoreIdentityProviderConfigurationArgs] = None,
                  preload_data_config: Optional[FhirDatastorePreloadDataConfigArgs] = None,
                  sse_configuration: Optional[FhirDatastoreSseConfigurationArgs] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewFhirDatastore(ctx *Context, name string, args FhirDatastoreArgs, opts ...ResourceOption) (*FhirDatastore, error)
    public FhirDatastore(string name, FhirDatastoreArgs args, CustomResourceOptions? opts = null)
    public FhirDatastore(String name, FhirDatastoreArgs args)
public FhirDatastore(String name, FhirDatastoreArgs args, CustomResourceOptions options)

    type: aws-native:healthlake:FhirDatastore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args FhirDatastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FhirDatastoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FhirDatastoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FhirDatastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FhirDatastoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FhirDatastore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FhirDatastore resource accepts the following input properties:

    DatastoreTypeVersion Pulumi.AwsNative.HealthLake.FhirDatastoreDatastoreTypeVersion
    The FHIR release version supported by the data store. Current support is for version R4 .
    DatastoreName string
    The data store name (user-generated).
    IdentityProviderConfiguration Pulumi.AwsNative.HealthLake.Inputs.FhirDatastoreIdentityProviderConfiguration
    The identity provider configuration selected when the data store was created.
    PreloadDataConfig Pulumi.AwsNative.HealthLake.Inputs.FhirDatastorePreloadDataConfig
    The preloaded Synthea data configuration for the data store.
    SseConfiguration Pulumi.AwsNative.HealthLake.Inputs.FhirDatastoreSseConfiguration
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    Tags List<Pulumi.AwsNative.Inputs.Tag>

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

    For more information, see Tag .

    DatastoreTypeVersion FhirDatastoreDatastoreTypeVersion
    The FHIR release version supported by the data store. Current support is for version R4 .
    DatastoreName string
    The data store name (user-generated).
    IdentityProviderConfiguration FhirDatastoreIdentityProviderConfigurationArgs
    The identity provider configuration selected when the data store was created.
    PreloadDataConfig FhirDatastorePreloadDataConfigArgs
    The preloaded Synthea data configuration for the data store.
    SseConfiguration FhirDatastoreSseConfigurationArgs
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    Tags TagArgs

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

    For more information, see Tag .

    datastoreTypeVersion FhirDatastoreDatastoreTypeVersion
    The FHIR release version supported by the data store. Current support is for version R4 .
    datastoreName String
    The data store name (user-generated).
    identityProviderConfiguration FhirDatastoreIdentityProviderConfiguration
    The identity provider configuration selected when the data store was created.
    preloadDataConfig FhirDatastorePreloadDataConfig
    The preloaded Synthea data configuration for the data store.
    sseConfiguration FhirDatastoreSseConfiguration
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    tags List<Tag>

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

    For more information, see Tag .

    datastoreTypeVersion FhirDatastoreDatastoreTypeVersion
    The FHIR release version supported by the data store. Current support is for version R4 .
    datastoreName string
    The data store name (user-generated).
    identityProviderConfiguration FhirDatastoreIdentityProviderConfiguration
    The identity provider configuration selected when the data store was created.
    preloadDataConfig FhirDatastorePreloadDataConfig
    The preloaded Synthea data configuration for the data store.
    sseConfiguration FhirDatastoreSseConfiguration
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    tags Tag[]

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

    For more information, see Tag .

    datastore_type_version FhirDatastoreDatastoreTypeVersion
    The FHIR release version supported by the data store. Current support is for version R4 .
    datastore_name str
    The data store name (user-generated).
    identity_provider_configuration FhirDatastoreIdentityProviderConfigurationArgs
    The identity provider configuration selected when the data store was created.
    preload_data_config FhirDatastorePreloadDataConfigArgs
    The preloaded Synthea data configuration for the data store.
    sse_configuration FhirDatastoreSseConfigurationArgs
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    tags Sequence[TagArgs]

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

    For more information, see Tag .

    datastoreTypeVersion "R4"
    The FHIR release version supported by the data store. Current support is for version R4 .
    datastoreName String
    The data store name (user-generated).
    identityProviderConfiguration Property Map
    The identity provider configuration selected when the data store was created.
    preloadDataConfig Property Map
    The preloaded Synthea data configuration for the data store.
    sseConfiguration Property Map
    The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store.
    tags List<Property Map>

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

    For more information, see Tag .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FhirDatastore resource produces the following output properties:

    CreatedAt Pulumi.AwsNative.HealthLake.Outputs.FhirDatastoreCreatedAt
    DatastoreArn 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.
    DatastoreEndpoint string
    The endpoint for the created Data Store.
    DatastoreId string
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    DatastoreStatus Pulumi.AwsNative.HealthLake.FhirDatastoreDatastoreStatus
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt FhirDatastoreCreatedAt
    DatastoreArn 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.
    DatastoreEndpoint string
    The endpoint for the created Data Store.
    DatastoreId string
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    DatastoreStatus FhirDatastoreDatastoreStatus
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt FhirDatastoreCreatedAt
    datastoreArn 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.
    datastoreEndpoint String
    The endpoint for the created Data Store.
    datastoreId String
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    datastoreStatus FhirDatastoreDatastoreStatus
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt FhirDatastoreCreatedAt
    datastoreArn 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.
    datastoreEndpoint string
    The endpoint for the created Data Store.
    datastoreId string
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    datastoreStatus FhirDatastoreDatastoreStatus
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at FhirDatastoreCreatedAt
    datastore_arn str
    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.
    datastore_endpoint str
    The endpoint for the created Data Store.
    datastore_id str
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    datastore_status FhirDatastoreDatastoreStatus
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt Property Map
    datastoreArn 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.
    datastoreEndpoint String
    The endpoint for the created Data Store.
    datastoreId String
    The Amazon generated Data Store id. This id is in the output from the initial Data Store creation call.
    datastoreStatus "CREATING" | "ACTIVE" | "DELETING" | "DELETED"
    The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FhirDatastoreCreatedAt, FhirDatastoreCreatedAtArgs

    Nanos int
    Nanoseconds.
    Seconds string
    Seconds since epoch.
    Nanos int
    Nanoseconds.
    Seconds string
    Seconds since epoch.
    nanos Integer
    Nanoseconds.
    seconds String
    Seconds since epoch.
    nanos number
    Nanoseconds.
    seconds string
    Seconds since epoch.
    nanos int
    Nanoseconds.
    seconds str
    Seconds since epoch.
    nanos Number
    Nanoseconds.
    seconds String
    Seconds since epoch.

    FhirDatastoreDatastoreStatus, FhirDatastoreDatastoreStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    FhirDatastoreDatastoreStatusCreating
    CREATING
    FhirDatastoreDatastoreStatusActive
    ACTIVE
    FhirDatastoreDatastoreStatusDeleting
    DELETING
    FhirDatastoreDatastoreStatusDeleted
    DELETED
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Deleted
    DELETED
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    DELETED
    DELETED
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "DELETED"
    DELETED

    FhirDatastoreDatastoreTypeVersion, FhirDatastoreDatastoreTypeVersionArgs

    R4
    R4
    FhirDatastoreDatastoreTypeVersionR4
    R4
    R4
    R4
    R4
    R4
    R4
    R4
    "R4"
    R4

    FhirDatastoreIdentityProviderConfiguration, FhirDatastoreIdentityProviderConfigurationArgs

    AuthorizationStrategy Pulumi.AwsNative.HealthLake.FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    FineGrainedAuthorizationEnabled bool
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    IdpLambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    Metadata string
    The JSON metadata elements for identity provider configuration.
    AuthorizationStrategy FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    FineGrainedAuthorizationEnabled bool
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    IdpLambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    Metadata string
    The JSON metadata elements for identity provider configuration.
    authorizationStrategy FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    fineGrainedAuthorizationEnabled Boolean
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    idpLambdaArn String
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    metadata String
    The JSON metadata elements for identity provider configuration.
    authorizationStrategy FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    fineGrainedAuthorizationEnabled boolean
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    idpLambdaArn string
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    metadata string
    The JSON metadata elements for identity provider configuration.
    authorization_strategy FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    fine_grained_authorization_enabled bool
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    idp_lambda_arn str
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    metadata str
    The JSON metadata elements for identity provider configuration.
    authorizationStrategy "SMART_ON_FHIR_V1" | "AWS_AUTH" | "SMART_ON_FHIR"
    Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.
    fineGrainedAuthorizationEnabled Boolean
    Flag to indicate if fine-grained authorization will be enabled for the datastore
    idpLambdaArn String
    The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server.
    metadata String
    The JSON metadata elements for identity provider configuration.

    FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy, FhirDatastoreIdentityProviderConfigurationAuthorizationStrategyArgs

    SmartOnFhirV1
    SMART_ON_FHIR_V1
    AwsAuth
    AWS_AUTH
    SmartOnFhir
    SMART_ON_FHIR
    FhirDatastoreIdentityProviderConfigurationAuthorizationStrategySmartOnFhirV1
    SMART_ON_FHIR_V1
    FhirDatastoreIdentityProviderConfigurationAuthorizationStrategyAwsAuth
    AWS_AUTH
    FhirDatastoreIdentityProviderConfigurationAuthorizationStrategySmartOnFhir
    SMART_ON_FHIR
    SmartOnFhirV1
    SMART_ON_FHIR_V1
    AwsAuth
    AWS_AUTH
    SmartOnFhir
    SMART_ON_FHIR
    SmartOnFhirV1
    SMART_ON_FHIR_V1
    AwsAuth
    AWS_AUTH
    SmartOnFhir
    SMART_ON_FHIR
    SMART_ON_FHIR_V1
    SMART_ON_FHIR_V1
    AWS_AUTH
    AWS_AUTH
    SMART_ON_FHIR
    SMART_ON_FHIR
    "SMART_ON_FHIR_V1"
    SMART_ON_FHIR_V1
    "AWS_AUTH"
    AWS_AUTH
    "SMART_ON_FHIR"
    SMART_ON_FHIR

    FhirDatastoreKmsEncryptionConfig, FhirDatastoreKmsEncryptionConfigArgs

    CmkType Pulumi.AwsNative.HealthLake.FhirDatastoreKmsEncryptionConfigCmkType
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    KmsKeyId string
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
    CmkType FhirDatastoreKmsEncryptionConfigCmkType
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    KmsKeyId string
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
    cmkType FhirDatastoreKmsEncryptionConfigCmkType
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    kmsKeyId String
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
    cmkType FhirDatastoreKmsEncryptionConfigCmkType
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    kmsKeyId string
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
    cmk_type FhirDatastoreKmsEncryptionConfigCmkType
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    kms_key_id str
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
    cmkType "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KMS_KEY"
    The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
    kmsKeyId String
    The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

    FhirDatastoreKmsEncryptionConfigCmkType, FhirDatastoreKmsEncryptionConfigCmkTypeArgs

    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    FhirDatastoreKmsEncryptionConfigCmkTypeCustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    FhirDatastoreKmsEncryptionConfigCmkTypeAwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CustomerManagedKmsKey
    CUSTOMER_MANAGED_KMS_KEY
    AwsOwnedKmsKey
    AWS_OWNED_KMS_KEY
    CUSTOMER_MANAGED_KMS_KEY
    CUSTOMER_MANAGED_KMS_KEY
    AWS_OWNED_KMS_KEY
    AWS_OWNED_KMS_KEY
    "CUSTOMER_MANAGED_KMS_KEY"
    CUSTOMER_MANAGED_KMS_KEY
    "AWS_OWNED_KMS_KEY"
    AWS_OWNED_KMS_KEY

    FhirDatastorePreloadDataConfig, FhirDatastorePreloadDataConfigArgs

    PreloadDataType Pulumi.AwsNative.HealthLake.FhirDatastorePreloadDataConfigPreloadDataType
    The type of preloaded data. Only Synthea preloaded data is supported.
    PreloadDataType FhirDatastorePreloadDataConfigPreloadDataType
    The type of preloaded data. Only Synthea preloaded data is supported.
    preloadDataType FhirDatastorePreloadDataConfigPreloadDataType
    The type of preloaded data. Only Synthea preloaded data is supported.
    preloadDataType FhirDatastorePreloadDataConfigPreloadDataType
    The type of preloaded data. Only Synthea preloaded data is supported.
    preload_data_type FhirDatastorePreloadDataConfigPreloadDataType
    The type of preloaded data. Only Synthea preloaded data is supported.
    preloadDataType "SYNTHEA"
    The type of preloaded data. Only Synthea preloaded data is supported.

    FhirDatastorePreloadDataConfigPreloadDataType, FhirDatastorePreloadDataConfigPreloadDataTypeArgs

    Synthea
    SYNTHEA
    FhirDatastorePreloadDataConfigPreloadDataTypeSynthea
    SYNTHEA
    Synthea
    SYNTHEA
    Synthea
    SYNTHEA
    SYNTHEA
    SYNTHEA
    "SYNTHEA"
    SYNTHEA

    FhirDatastoreSseConfiguration, FhirDatastoreSseConfigurationArgs

    KmsEncryptionConfig Pulumi.AwsNative.HealthLake.Inputs.FhirDatastoreKmsEncryptionConfig
    The server-side encryption key configuration for a customer provided encryption key.
    KmsEncryptionConfig FhirDatastoreKmsEncryptionConfig
    The server-side encryption key configuration for a customer provided encryption key.
    kmsEncryptionConfig FhirDatastoreKmsEncryptionConfig
    The server-side encryption key configuration for a customer provided encryption key.
    kmsEncryptionConfig FhirDatastoreKmsEncryptionConfig
    The server-side encryption key configuration for a customer provided encryption key.
    kms_encryption_config FhirDatastoreKmsEncryptionConfig
    The server-side encryption key configuration for a customer provided encryption key.
    kmsEncryptionConfig Property Map
    The server-side encryption key configuration for a customer provided encryption key.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native