Package software.amazon.awssdk.services.finspace.model

Class FederationParameters

java.lang.Object

software.amazon.awssdk.services.finspace.model.FederationParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FederationParameters.Builder,FederationParameters>

@Generated("software.amazon.awssdk:codegen")
public final class FederationParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FederationParameters.Builder,FederationParameters>

Configuration information when authentication mode is FEDERATED.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FederationParameters.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationCallBackURL()	The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
Map<String,String>	attributeMap()	SAML attribute name and value.
static FederationParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	federationProviderName()	Name of the identity provider (IdP).
String	federationURN()	The Uniform Resource Name (URN).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeMap()	For responses, this returns true if the service returned a value for the AttributeMap property.
int	hashCode()
String	samlMetadataDocument()	SAML 2.0 Metadata document from identity provider (IdP).
String	samlMetadataURL()	Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
List<SdkField<?>>	sdkFields()
static Class<? extends FederationParameters.Builder>	serializableBuilderClass()
FederationParameters.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

samlMetadataDocument

public final String samlMetadataDocument()

SAML 2.0 Metadata document from identity provider (IdP).

Returns:

SAML 2.0 Metadata document from identity provider (IdP).

samlMetadataURL

public final String samlMetadataURL()

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Returns:

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

applicationCallBackURL

public final String applicationCallBackURL()

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

Returns:

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

federationURN

public final String federationURN()

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

Returns:

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

federationProviderName

public final String federationProviderName()

Name of the identity provider (IdP).

Returns:

Name of the identity provider (IdP).

hasAttributeMap

public final boolean hasAttributeMap()

For responses, this returns true if the service returned a value for the AttributeMap property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributeMap

public final Map<String,String> attributeMap()

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributeMap() method.

Returns:

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

toBuilder

public FederationParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FederationParameters.Builder,FederationParameters>

builder

public static FederationParameters.Builder builder()

serializableBuilderClass

public static Class<? extends FederationParameters.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