AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon HealthLake CreateFHIRDatastore API operation.

Syntax

New-AHLFHIRDatastore
-DatastoreTypeVersion <FHIRVersion>
-IdentityProviderConfiguration_AuthorizationStrategy <AuthorizationStrategy>
-KmsEncryptionConfig_CmkType <CmkType>
-DatastoreName <String>
-IdentityProviderConfiguration_FineGrainedAuthorizationEnabled <Boolean>
-IdentityProviderConfiguration_IdpLambdaArn <String>
-KmsEncryptionConfig_KmsKeyId <String>
-IdentityProviderConfiguration_Metadata <String>
-PreloadDataConfig_PreloadDataType <PreloadDataType>
-Tag <Tag[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonHealthLakeConfig>

Description

Creates a data store that can ingest and export FHIR formatted data.

Parameters

-ClientConfig <AmazonHealthLakeConfig>
Amazon.PowerShell.Cmdlets.AHL.AmazonHealthLakeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Optional user provided token used for ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatastoreName <String>
The user generated name for the data store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatastoreTypeVersion <FHIRVersion>
The FHIR version of the data store. The only supported version is R4.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityProviderConfiguration_AuthorizationStrategy <AuthorizationStrategy>
The authorization strategy that you selected when you created the data store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityProviderConfiguration_FineGrainedAuthorizationEnabled <Boolean>
If you enabled fine-grained authorization when you created the data store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityProviderConfiguration_IdpLambdaArn <String>
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdentityProviderConfiguration_Metadata <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsEncryptionConfig_CmkType <CmkType>
The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSseConfiguration_KmsEncryptionConfig_CmkType
-KmsEncryptionConfig_KmsKeyId <String>
The KMS encryption key id/alias used to encrypt the data store contents at rest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSseConfiguration_KmsEncryptionConfig_KmsKeyId
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DatastoreTypeVersion parameter. The -PassThru parameter is deprecated, use -Select '^DatastoreTypeVersion' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreloadDataConfig_PreloadDataType <PreloadDataType>
The type of preloaded data. Only Synthea preloaded data is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.HealthLake.Model.CreateFHIRDatastoreResponse). Specifying the name of a property of type Amazon.HealthLake.Model.CreateFHIRDatastoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Resource tags that are applied to a data store when it is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.HealthLake.Model.CreateFHIRDatastoreResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z