CfnFHIRDatastorePropsMixin

class aws_cdk.mixins_preview.aws_healthlake.mixins.CfnFHIRDatastorePropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_healthlake import mixins as healthlake_mixins

cfn_fHIRDatastore_props_mixin = healthlake_mixins.CfnFHIRDatastorePropsMixin(healthlake_mixins.CfnFHIRDatastoreMixinProps(
    datastore_name="datastoreName",
    datastore_type_version="datastoreTypeVersion",
    identity_provider_configuration=healthlake_mixins.CfnFHIRDatastorePropsMixin.IdentityProviderConfigurationProperty(
        authorization_strategy="authorizationStrategy",
        fine_grained_authorization_enabled=False,
        idp_lambda_arn="idpLambdaArn",
        metadata="metadata"
    ),
    preload_data_config=healthlake_mixins.CfnFHIRDatastorePropsMixin.PreloadDataConfigProperty(
        preload_data_type="preloadDataType"
    ),
    sse_configuration=healthlake_mixins.CfnFHIRDatastorePropsMixin.SseConfigurationProperty(
        kms_encryption_config=healthlake_mixins.CfnFHIRDatastorePropsMixin.KmsEncryptionConfigProperty(
            cmk_type="cmkType",
            kms_key_id="kmsKeyId"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::HealthLake::FHIRDatastore.

Parameters:

props (Union[CfnFHIRDatastoreMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['datastoreName', 'datastoreTypeVersion', 'identityProviderConfiguration', 'preloadDataConfig', 'sseConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

CreatedAtProperty

class CfnFHIRDatastorePropsMixin.CreatedAtProperty(*, nanos=None, seconds=None)

Bases: object

The time that a Data Store was created.

Parameters:

nanos (Union[int, float, None]) – Nanoseconds.
seconds (Optional[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.mixins_preview.aws_healthlake import mixins as healthlake_mixins

created_at_property = healthlake_mixins.CfnFHIRDatastorePropsMixin.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 CfnFHIRDatastorePropsMixin.IdentityProviderConfigurationProperty(*, authorization_strategy=None, fine_grained_authorization_enabled=None, idp_lambda_arn=None, metadata=None)

Bases: object

The identity provider configuration selected when the data store was created.

Parameters:

authorization_strategy (Optional[str]) – The authorization strategy selected when the HealthLake data store is created. .. epigraph:: HealthLake provides support for both SMART on FHIR V1 and V2 as described below. - SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions. - SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create , read , update , delete , and search permissions. - AWS_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.
fine_grained_authorization_enabled (Union[bool, IResolvable, None]) – The parameter to enable SMART on FHIR fine-grained authorization for the data store.
idp_lambda_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.
metadata (Optional[str]) – The JSON metadata elements 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.mixins_preview.aws_healthlake import mixins as healthlake_mixins

identity_provider_configuration_property = healthlake_mixins.CfnFHIRDatastorePropsMixin.IdentityProviderConfigurationProperty(
    authorization_strategy="authorizationStrategy",
    fine_grained_authorization_enabled=False,
    idp_lambda_arn="idpLambdaArn",
    metadata="metadata"
)

Attributes

authorization_strategy

The authorization strategy selected when the HealthLake data store is created.

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions.

SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create , read , update , delete , and search permissions.

AWS_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.

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

fine_grained_authorization_enabled

The parameter to enable SMART on FHIR fine-grained authorization for 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 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 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 CfnFHIRDatastorePropsMixin.KmsEncryptionConfigProperty(*, cmk_type=None, 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 (Optional[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 Key Management Service (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.mixins_preview.aws_healthlake import mixins as healthlake_mixins

kms_encryption_config_property = healthlake_mixins.CfnFHIRDatastorePropsMixin.KmsEncryptionConfigProperty(
    cmk_type="cmkType",
    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 Key Management Service (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 CfnFHIRDatastorePropsMixin.PreloadDataConfigProperty(*, preload_data_type=None)

Bases: object

An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.

Parameters:: preload_data_type (Optional[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.mixins_preview.aws_healthlake import mixins as healthlake_mixins

preload_data_config_property = healthlake_mixins.CfnFHIRDatastorePropsMixin.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 CfnFHIRDatastorePropsMixin.SseConfigurationProperty(*, kms_encryption_config=None)

Bases: object

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

Parameters:: kms_encryption_config (Union[IResolvable, KmsEncryptionConfigProperty, Dict[str, Any], None]) – The server-side encryption key configuration for a customer provided encryption key.
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.mixins_preview.aws_healthlake import mixins as healthlake_mixins

sse_configuration_property = healthlake_mixins.CfnFHIRDatastorePropsMixin.SseConfigurationProperty(
    kms_encryption_config=healthlake_mixins.CfnFHIRDatastorePropsMixin.KmsEncryptionConfigProperty(
        cmk_type="cmkType",
        kms_key_id="kmsKeyId"
    )
)

Attributes

kms_encryption_config

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

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