AWS CDK Reference

Appearance

v2.275.0

IdentityProviderConfigurationProperty Struct ​

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

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_healthlake as healthlake } from 'aws-cdk-lib';
const identityProviderConfigurationProperty: healthlake.CfnFHIRDatastore.IdentityProviderConfigurationProperty = {
  authorizationStrategy: 'authorizationStrategy',

  // the properties below are optional
  fineGrainedAuthorizationEnabled: false,
  idpLambdaArn: 'idpLambdaArn',
  metadata: 'metadata',
};

Properties ​

authorizationStrategystringauthorization_strategystrauthorizationStrategyStringAuthorizationStrategystringAuthorizationStrategy*stringrequired#
The authorization strategy selected when the HealthLake data store is created.
notes

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.
fineGrainedAuthorizationEnabledoptionalboolean | IResolvablefine_grained_authorization_enabledoptionaltyping.Union[bool, IResolvable]fineGrainedAuthorizationEnabledoptionalBooleanFineGrainedAuthorizationEnabledoptionalboolFineGrainedAuthorizationEnabledoptionalinterface{}#
The parameter to enable SMART on FHIR fine-grained authorization for the data store.
idpLambdaArnoptionalstringidp_lambda_arnoptionalstridpLambdaArnoptionalStringIdpLambdaArnoptionalstringIdpLambdaArnoptional*string#
The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.
metadataoptionalstringmetadataoptionalstrmetadataoptionalStringMetadataoptionalstringMetadataoptional*string#
The JSON metadata elements to use in your identity provider configuration.
notes

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.