Class FederationParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FederationParameters.Builder,
FederationParameters>
Configuration information when authentication mode is FEDERATED.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).SAML attribute name and value.static FederationParameters.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Name of the identity provider (IdP).final String
The Uniform Resource Name (URN).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AttributeMap property.final int
hashCode()
final String
SAML 2.0 Metadata document from identity provider (IdP).final String
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).static Class
<? extends FederationParameters.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
samlMetadataDocument
SAML 2.0 Metadata document from identity provider (IdP).
- Returns:
- SAML 2.0 Metadata document from identity provider (IdP).
-
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
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
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
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 theisEmpty()
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
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 beEmail
and valuehttp://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 beEmail
and valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
-
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 interfaceToCopyableBuilder<FederationParameters.Builder,
FederationParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-