Package software.amazon.awscdk.services.healthlake

Interface CfnFHIRDatastore.IdentityProviderConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFHIRDatastore.IdentityProviderConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFHIRDatastore

@Stability(Stable)
public static interface CfnFHIRDatastore.IdentityProviderConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 IdentityProviderConfigurationProperty identityProviderConfigurationProperty = IdentityProviderConfigurationProperty.builder()
         .authorizationStrategy("authorizationStrategy")
         // the properties below are optional
         .fineGrainedAuthorizationEnabled(false)
         .idpLambdaArn("idpLambdaArn")
         .metadata("metadata")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFHIRDatastore.IdentityProviderConfigurationProperty.Builder	builder()
String	getAuthorizationStrategy()	The authorization strategy selected when the HealthLake data store is created.
default Object	getFineGrainedAuthorizationEnabled()	The parameter to enable SMART on FHIR fine-grained authorization for the data store.
default String	getIdpLambdaArn()	The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.
default String	getMetadata()	The JSON metadata elements to use in your identity provider configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationStrategy

@Stability(Stable)
@NotNull
String getAuthorizationStrategy()

The authorization strategy selected when the HealthLake data store is created.

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.

See Also:

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

getFineGrainedAuthorizationEnabled

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

The parameter to enable SMART on FHIR fine-grained authorization for the data store.

See Also:

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

getIdpLambdaArn

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

The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.

See Also:

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

getMetadata

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

The JSON metadata elements 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.

See Also:

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

builder

@Stability(Stable)
static CfnFHIRDatastore.IdentityProviderConfigurationProperty.Builder builder()

Returns:

a CfnFHIRDatastore.IdentityProviderConfigurationProperty.Builder of CfnFHIRDatastore.IdentityProviderConfigurationProperty