Class IdentityProviderConfiguration

java.lang.Object
software.amazon.awssdk.services.healthlake.model.IdentityProviderConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class IdentityProviderConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>

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

See Also:

  • Method Details

    • authorizationStrategy

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, authorizationStrategy will return AuthorizationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationStrategyAsString().

      Returns:
      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:

    • authorizationStrategyAsString

      public final String authorizationStrategyAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, authorizationStrategy will return AuthorizationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationStrategyAsString().

      Returns:
      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:

    • fineGrainedAuthorizationEnabled

      public final Boolean fineGrainedAuthorizationEnabled()

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

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

    • metadata

      public final 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.

      Returns:
      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.

    • idpLambdaArn

      public final String idpLambdaArn()

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

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

    • toBuilder

      public IdentityProviderConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>
      Returns:
      a builder for type T

    • builder

      public static IdentityProviderConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IdentityProviderConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.