CfnFHIRDatastore

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

Bases: CfnResource

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-healthlake-fhirdatastore.html
CloudformationResource:: AWS::HealthLake::FHIRDatastore
ExampleMetadata:: fixture=_generated

Example:

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

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

    # the properties below are optional
    datastore_name="datastoreName",
    identity_provider_configuration=healthlake.CfnFHIRDatastore.IdentityProviderConfigurationProperty(
        authorization_strategy="authorizationStrategy",

        # the properties below are optional
        fine_grained_authorization_enabled=False,
        idp_lambda_arn="idpLambdaArn",
        metadata="metadata"
    ),
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.
identity_provider_configuration (Union[IResolvable, IdentityProviderConfigurationProperty, Dict[str, Any], None]) – The identity provider configuration that you gave when the data store was created.
preload_data_config (Union[IResolvable, PreloadDataConfigProperty, Dict[str, Any], None]) – The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
sse_configuration (Union[IResolvable, SseConfigurationProperty, Dict[str, Any], None]) – The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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.

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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_created_at

The time that a Data Store was created.

CloudformationAttribute:: CreatedAt

attr_created_at_nanos

CreatedAt.Nanos

Type:: cloudformationAttribute

attr_created_at_seconds

CreatedAt.Seconds

Type:: cloudformationAttribute

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

attr_datastore_endpoint

The endpoint for the created Data Store.

CloudformationAttribute:: DatastoreEndpoint

attr_datastore_id

The Amazon generated Data Store id.

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

CloudformationAttribute:: DatastoreId

attr_datastore_status

The status of the FHIR Data Store.

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

CloudformationAttribute:: DatastoreStatus

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

cfn_resource_type: AWS resource type.

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.

datastore_name: The user generated name for the data store.

datastore_type_version: The FHIR version of the data store.

identity_provider_configuration: The identity provider configuration that you gave when the data store was created.

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

Returns:

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

node: The tree node.

preload_data_config: The preloaded data configuration for the data store.

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 }).

sse_configuration: The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.

stack

The stack in which this element is defined.

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

tags: Tag Manager which manages the tags for this resource.

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

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CreatedAtProperty

class CfnFHIRDatastore.CreatedAtProperty(*, nanos, seconds)

Bases: object

The time that a Data Store was created.

Parameters:

nanos (Union[int, float]) – Nanoseconds.
seconds (str) – Seconds since epoch.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

created_at_property = healthlake.CfnFHIRDatastore.CreatedAtProperty(
    nanos=123,
    seconds="seconds"
)

Attributes

nanos

Nanoseconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-createdat.html#cfn-healthlake-fhirdatastore-createdat-nanos

seconds

Seconds since epoch.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-createdat.html#cfn-healthlake-fhirdatastore-createdat-seconds

IdentityProviderConfigurationProperty

class CfnFHIRDatastore.IdentityProviderConfigurationProperty(*, authorization_strategy, fine_grained_authorization_enabled=None, idp_lambda_arn=None, metadata=None)

Bases: object

The identity provider configuration that you gave when the data store was created.

Parameters:

authorization_strategy (str) – The authorization strategy that you selected when you created the data store.
fine_grained_authorization_enabled (Union[bool, IResolvable, None]) – If you enabled fine-grained authorization when you created the data store.
idp_lambda_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
metadata (Optional[str]) – The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART’s App Launch specification. authorization_endpoint : The URL to the OAuth2 authorization endpoint. grant_types_supported : An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials . token_endpoint : The URL to the OAuth2 token endpoint. capabilities : An array of strings of the SMART capabilities that the authorization server supports. code_challenge_methods_supported : An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

identity_provider_configuration_property = healthlake.CfnFHIRDatastore.IdentityProviderConfigurationProperty(
    authorization_strategy="authorizationStrategy",

    # the properties below are optional
    fine_grained_authorization_enabled=False,
    idp_lambda_arn="idpLambdaArn",
    metadata="metadata"
)

Attributes

authorization_strategy

The authorization strategy that you selected when you created the data store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-authorizationstrategy

fine_grained_authorization_enabled

If you enabled fine-grained authorization when you created the data store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-finegrainedauthorizationenabled

idp_lambda_arn

The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-idplambdaarn

metadata

The JSON metadata elements that you want to use in your identity provider configuration.

Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART’s App Launch specification.

authorization_endpoint : The URL to the OAuth2 authorization endpoint.

grant_types_supported : An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials .

token_endpoint : The URL to the OAuth2 token endpoint.

capabilities : An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported : An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-identityproviderconfiguration.html#cfn-healthlake-fhirdatastore-identityproviderconfiguration-metadata

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.

See:

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.
from aws_cdk import 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 .

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

kms_key_id

The KMS encryption key id/alias used to encrypt the data store contents at rest.

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

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.
See:: 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.
from aws_cdk import 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.

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

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, Dict[str, Any]]) – The server-side encryption key configuration for a customer provided encryption key (CMK).
See:: 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.
from aws_cdk import 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).

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