CfnFHIRDatastore

class aws_cdk.aws_healthlake.CfnFHIRDatastore(scope, id, *, datastore_type_version, datastore_name=None, preload_data_config=None, sse_configuration=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::HealthLake::FHIRDatastore.

Creates a Data Store that can ingest and export FHIR formatted data. .. epigraph:

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

AWS::HealthLake::FHIRDatastore

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_healthlake as healthlake

cfn_fHIRDatastore = healthlake.CfnFHIRDatastore(self, "MyCfnFHIRDatastore",
    datastore_type_version="datastoreTypeVersion",

    # the properties below are optional
    datastore_name="datastoreName",
    preload_data_config=healthlake.CfnFHIRDatastore.PreloadDataConfigProperty(
        preload_data_type="preloadDataType"
    ),
    sse_configuration=healthlake.CfnFHIRDatastore.SseConfigurationProperty(
        kms_encryption_config=healthlake.CfnFHIRDatastore.KmsEncryptionConfigProperty(
            cmk_type="cmkType",

            # the properties below are optional
            kms_key_id="kmsKeyId"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::HealthLake::FHIRDatastore.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • datastore_type_version (str) – The FHIR version of the Data Store. The only supported version is R4.

  • datastore_name (Optional[str]) – The user generated name for the Data Store.

  • preload_data_config (Union[PreloadDataConfigProperty, IResolvable, None]) – The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.

  • sse_configuration (Union[IResolvable, SseConfigurationProperty, None]) – The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::HealthLake::FHIRDatastore'
attr_datastore_arn

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.

CloudformationAttribute

DatastoreArn

Return type

str

attr_datastore_endpoint

The endpoint for the created Data Store.

CloudformationAttribute

DatastoreEndpoint

Return type

str

attr_datastore_id

The Amazon generated Data Store id.

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

CloudformationAttribute

DatastoreId

Return type

str

attr_datastore_status

The status of the FHIR Data Store.

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

CloudformationAttribute

DatastoreStatus

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

datastore_name

The user generated name for the Data Store.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastorename

Return type

Optional[str]

datastore_type_version

The FHIR version of the Data Store.

The only supported version is R4.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-datastoretypeversion

Return type

str

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

preload_data_config

The preloaded data configuration for the Data Store.

Only data preloaded from Synthea is supported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-preloaddataconfig

Return type

Union[PreloadDataConfigProperty, IResolvable, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

sse_configuration

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-sseconfiguration

Return type

Union[IResolvable, SseConfigurationProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

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

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html#cfn-healthlake-fhirdatastore-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

KmsEncryptionConfigProperty

class CfnFHIRDatastore.KmsEncryptionConfigProperty(*, cmk_type, kms_key_id=None)

Bases: object

The customer-managed-key(CMK) used when creating a Data Store.

If a customer owned key is not specified, an Amazon owned key will be used for encryption.

Parameters
  • cmk_type (str) – The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and Amazon owned CMKs. For more information on CMK types, see KmsEncryptionConfig .

  • kms_key_id (Optional[str]) – The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_healthlake as healthlake

kms_encryption_config_property = healthlake.CfnFHIRDatastore.KmsEncryptionConfigProperty(
    cmk_type="cmkType",

    # the properties below are optional
    kms_key_id="kmsKeyId"
)

Attributes

cmk_type

The type of customer-managed-key(CMK) used for encryption.

The two types of supported CMKs are customer owned CMKs and Amazon owned CMKs. For more information on CMK types, see KmsEncryptionConfig .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-cmktype

Return type

str

kms_key_id

The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-kmsencryptionconfig.html#cfn-healthlake-fhirdatastore-kmsencryptionconfig-kmskeyid

Return type

Optional[str]

PreloadDataConfigProperty

class CfnFHIRDatastore.PreloadDataConfigProperty(*, preload_data_type)

Bases: object

Optional parameter to preload data upon creation of the Data Store.

Currently, the only supported preloaded data is synthetic data generated from Synthea.

Parameters

preload_data_type (str) – The type of preloaded data. Only Synthea preloaded data is supported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-preloaddataconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_healthlake as healthlake

preload_data_config_property = healthlake.CfnFHIRDatastore.PreloadDataConfigProperty(
    preload_data_type="preloadDataType"
)

Attributes

preload_data_type

The type of preloaded data.

Only Synthea preloaded data is supported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-preloaddataconfig.html#cfn-healthlake-fhirdatastore-preloaddataconfig-preloaddatatype

Return type

str

SseConfigurationProperty

class CfnFHIRDatastore.SseConfigurationProperty(*, kms_encryption_config)

Bases: object

The server-side encryption key configuration for a customer provided encryption key.

Parameters

kms_encryption_config (Union[IResolvable, KmsEncryptionConfigProperty]) – The server-side encryption key configuration for a customer provided encryption key (CMK).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-sseconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_healthlake as healthlake

sse_configuration_property = healthlake.CfnFHIRDatastore.SseConfigurationProperty(
    kms_encryption_config=healthlake.CfnFHIRDatastore.KmsEncryptionConfigProperty(
        cmk_type="cmkType",

        # the properties below are optional
        kms_key_id="kmsKeyId"
    )
)

Attributes

kms_encryption_config

The server-side encryption key configuration for a customer provided encryption key (CMK).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-sseconfiguration.html#cfn-healthlake-fhirdatastore-sseconfiguration-kmsencryptionconfig

Return type

Union[IResolvable, KmsEncryptionConfigProperty]