Package software.amazon.awscdk.services.healthlake

Interface CfnFHIRDatastoreProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFHIRDatastoreProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.194Z")
@Stability(Stable)
public interface CfnFHIRDatastoreProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFHIRDatastore.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.healthlake.*;
 CfnFHIRDatastoreProps cfnFHIRDatastoreProps = CfnFHIRDatastoreProps.builder()
         .datastoreTypeVersion("datastoreTypeVersion")
         // the properties below are optional
         .datastoreName("datastoreName")
         .identityProviderConfiguration(IdentityProviderConfigurationProperty.builder()
                 .authorizationStrategy("authorizationStrategy")
                 // the properties below are optional
                 .fineGrainedAuthorizationEnabled(false)
                 .idpLambdaArn("idpLambdaArn")
                 .metadata("metadata")
                 .build())
         .preloadDataConfig(PreloadDataConfigProperty.builder()
                 .preloadDataType("preloadDataType")
                 .build())
         .sseConfiguration(SseConfigurationProperty.builder()
                 .kmsEncryptionConfig(KmsEncryptionConfigProperty.builder()
                         .cmkType("cmkType")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFHIRDatastoreProps.Builder	A builder for CfnFHIRDatastoreProps
static final class	CfnFHIRDatastoreProps.Jsii$Proxy	An implementation for CfnFHIRDatastoreProps

Method Summary

Modifier and Type	Method	Description
static CfnFHIRDatastoreProps.Builder	builder()
default String	getDatastoreName()	The user generated name for the data store.
String	getDatastoreTypeVersion()	The FHIR version of the data store.
default Object	getIdentityProviderConfiguration()	The identity provider configuration that you gave when the data store was created.
default Object	getPreloadDataConfig()	The preloaded data configuration for the data store.
default Object	getSseConfiguration()	The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatastoreTypeVersion

@Stability(Stable)
@NotNull
String getDatastoreTypeVersion()

The FHIR version of the data store.

The only supported version is R4.

See Also:

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

getDatastoreName

@Stability(Stable)
@Nullable
default String getDatastoreName()

The user generated name for the data store.

See Also:

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

getIdentityProviderConfiguration

@Stability(Stable)
@Nullable
default Object getIdentityProviderConfiguration()

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

See Also:

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

getPreloadDataConfig

@Stability(Stable)
@Nullable
default Object getPreloadDataConfig()

The preloaded data configuration for the data store.

Only data preloaded from Synthea is supported.

See Also:

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

getSseConfiguration

@Stability(Stable)
@Nullable
default Object getSseConfiguration()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnFHIRDatastoreProps.Builder builder()

Returns:

a CfnFHIRDatastoreProps.Builder of CfnFHIRDatastoreProps