awshealthlake

Documentation

Index

• func CfnFHIRDatastore_CFN_RESOURCE_TYPE_NAME() *string
• func CfnFHIRDatastore_IsCfnElement(x interface{}) *bool
• func CfnFHIRDatastore_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnFHIRDatastore_IsConstruct(x interface{}) *bool
• func NewCfnFHIRDatastore_Override(c CfnFHIRDatastore, scope constructs.Construct, id *string, ...)
• type CfnFHIRDatastore
  • func NewCfnFHIRDatastore(scope constructs.Construct, id *string, props *CfnFHIRDatastoreProps) CfnFHIRDatastore
• type CfnFHIRDatastoreProps
• type CfnFHIRDatastore_KmsEncryptionConfigProperty
• type CfnFHIRDatastore_PreloadDataConfigProperty
• type CfnFHIRDatastore_SseConfigurationProperty

Functions

func CfnFHIRDatastore_CFN_RESOURCE_TYPE_NAME

func CfnFHIRDatastore_CFN_RESOURCE_TYPE_NAME() *string

func CfnFHIRDatastore_IsCfnElement

func CfnFHIRDatastore_IsCfnElement(x interface{}) *bool

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.

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

func CfnFHIRDatastore_IsCfnResource

func CfnFHIRDatastore_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFHIRDatastore_IsConstruct

func CfnFHIRDatastore_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnFHIRDatastore_Override

func NewCfnFHIRDatastore_Override(c CfnFHIRDatastore, scope constructs.Construct, id *string, props *CfnFHIRDatastoreProps)

Create a new `AWS::HealthLake::FHIRDatastore`.

Types

type CfnFHIRDatastore

type CfnFHIRDatastore interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrDatastoreArn() *string
	AttrDatastoreEndpoint() *string
	AttrDatastoreId() *string
	AttrDatastoreStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DatastoreName() *string
	SetDatastoreName(val *string)
	DatastoreTypeVersion() *string
	SetDatastoreTypeVersion(val *string)
	LogicalId() *string
	Node() constructs.Node
	PreloadDataConfig() interface{}
	SetPreloadDataConfig(val interface{})
	Ref() *string
	SseConfiguration() interface{}
	SetSseConfiguration(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::HealthLake::FHIRDatastore`.

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.

TODO: EXAMPLE

func NewCfnFHIRDatastore

func NewCfnFHIRDatastore(scope constructs.Construct, id *string, props *CfnFHIRDatastoreProps) CfnFHIRDatastore

Create a new `AWS::HealthLake::FHIRDatastore`.

type CfnFHIRDatastoreProps

type CfnFHIRDatastoreProps struct {
	// The FHIR version of the Data Store.
	//
	// The only supported version is R4.
	DatastoreTypeVersion *string `json:"datastoreTypeVersion" yaml:"datastoreTypeVersion"`
	// The user generated name for the Data Store.
	DatastoreName *string `json:"datastoreName" yaml:"datastoreName"`
	// The preloaded data configuration for the Data Store.
	//
	// Only data preloaded from Synthea is supported.
	PreloadDataConfig interface{} `json:"preloadDataConfig" yaml:"preloadDataConfig"`
	// The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.
	SseConfiguration interface{} `json:"sseConfiguration" yaml:"sseConfiguration"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnFHIRDatastore`.

TODO: EXAMPLE

type CfnFHIRDatastore_KmsEncryptionConfigProperty

type CfnFHIRDatastore_KmsEncryptionConfigProperty struct {
	// 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](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_KmsEncryptionConfig.html#HealthLake-Type-KmsEncryptionConfig-CmkType) .
	CmkType *string `json:"cmkType" yaml:"cmkType"`
	// The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
	KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"`
}

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.

TODO: EXAMPLE

type CfnFHIRDatastore_PreloadDataConfigProperty

type CfnFHIRDatastore_PreloadDataConfigProperty struct {
	// The type of preloaded data.
	//
	// Only Synthea preloaded data is supported.
	PreloadDataType *string `json:"preloadDataType" yaml:"preloadDataType"`
}

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

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

TODO: EXAMPLE

type CfnFHIRDatastore_SseConfigurationProperty

type CfnFHIRDatastore_SseConfigurationProperty struct {
	// The server-side encryption key configuration for a customer provided encryption key (CMK).
	KmsEncryptionConfig interface{} `json:"kmsEncryptionConfig" yaml:"kmsEncryptionConfig"`
}

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

TODO: EXAMPLE