Interface IdentityProviderConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>, SdkBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>, SdkPojo
Enclosing class:
IdentityProviderConfiguration
@Mutable @NotThreadSafe public static interface IdentityProviderConfiguration.Builder extends SdkPojo, CopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>

  • Method Details

    • authorizationStrategy

      IdentityProviderConfiguration.Builder authorizationStrategy(String authorizationStrategy)

      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.

      Parameters:
      authorizationStrategy - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizationStrategy

      IdentityProviderConfiguration.Builder authorizationStrategy(AuthorizationStrategy authorizationStrategy)

      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.

      Parameters:
      authorizationStrategy - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fineGrainedAuthorizationEnabled

      IdentityProviderConfiguration.Builder fineGrainedAuthorizationEnabled(Boolean fineGrainedAuthorizationEnabled)

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

      Parameters:
      fineGrainedAuthorizationEnabled - The parameter to enable SMART on FHIR fine-grained authorization for the data store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadata

      IdentityProviderConfiguration.Builder metadata(String metadata)

      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.

      Parameters:
      metadata - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idpLambdaArn

      IdentityProviderConfiguration.Builder idpLambdaArn(String idpLambdaArn)

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

      Parameters:
      idpLambdaArn - The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.