DatastoreProperties - AWS HealthLake

DatastoreProperties

Displays the properties of the data store, including the ID, ARN, name, and the status of the data store.

Contents

DatastoreArn

The Amazon Resource Name used in the creation of the data store.

Type: String

Pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?

Required: Yes

DatastoreEndpoint

The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: [\P{M}\p{M}]{0,10000}

Required: Yes

DatastoreId

The AWS-generated ID number for the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: Yes

DatastoreStatus

The status of the data store.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED

Required: Yes

DatastoreTypeVersion

The FHIR version. Only R4 version data is supported.

Type: String

Valid Values: R4

Required: Yes

CreatedAt

The time that a data store was created.

Type: Timestamp

Required: No

DatastoreName

The user-generated name for the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

IdentityProviderConfiguration

The identity provider that you selected when you created the data store.

Type: IdentityProviderConfiguration object

Required: No

PreloadDataConfig

The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.

Type: PreloadDataConfig object

Required: No

SseConfiguration

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

Type: SseConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: