Package software.amazon.awssdk.services.healthlake.model

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 that you gave when the data store was created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentityProviderConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
AuthorizationStrategy	authorizationStrategy()	The authorization strategy that you selected when you created the data store.
String	authorizationStrategyAsString()	The authorization strategy that you selected when you created the data store.
static IdentityProviderConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	fineGrainedAuthorizationEnabled()	If you enabled fine-grained authorization when you created the data store.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	idpLambdaArn()	The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
String	metadata()	The JSON metadata elements that you want to use in your identity provider configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityProviderConfiguration.Builder>	serializableBuilderClass()
IdentityProviderConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

authorizationStrategy

public final AuthorizationStrategy authorizationStrategy()

The authorization strategy that you selected when you created the data store.

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 that you selected when you created the data store.

See Also:

AuthorizationStrategy

authorizationStrategyAsString

public final String authorizationStrategyAsString()

The authorization strategy that you selected when you created the data store.

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 that you selected when you created the data store.

See Also:

AuthorizationStrategy

fineGrainedAuthorizationEnabled

public final Boolean fineGrainedAuthorizationEnabled()

If you enabled fine-grained authorization when you created the data store.

Returns:

If you enabled fine-grained authorization when you created the data store.

metadata

public final String metadata()

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.

Returns:

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.

idpLambdaArn

public final String idpLambdaArn()

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

Returns:

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

toBuilder

public IdentityProviderConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityProviderConfiguration.Builder,IdentityProviderConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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