FederationParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspace.model.FederationParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FederationParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configuration information when authentication mode is FEDERATED.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FederationParameters()

Constructors
Constructor and Description
`FederationParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FederationParameters`	`addAttributeMapEntry(String key, String value)` Add a single AttributeMap entry
`FederationParameters`	`clearAttributeMapEntries()` Removes all the entries added into AttributeMap.
`FederationParameters`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationCallBackURL()` The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
`Map<String,String>`	`getAttributeMap()` SAML attribute name and value.
`String`	`getFederationProviderName()` Name of the identity provider (IdP).
`String`	`getFederationURN()` The Uniform Resource Name (URN).
`String`	`getSamlMetadataDocument()` SAML 2.0 Metadata document from identity provider (IdP).
`String`	`getSamlMetadataURL()` Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplicationCallBackURL(String applicationCallBackURL)` The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
`void`	`setAttributeMap(Map<String,String> attributeMap)` SAML attribute name and value.
`void`	`setFederationProviderName(String federationProviderName)` Name of the identity provider (IdP).
`void`	`setFederationURN(String federationURN)` The Uniform Resource Name (URN).
`void`	`setSamlMetadataDocument(String samlMetadataDocument)` SAML 2.0 Metadata document from identity provider (IdP).
`void`	`setSamlMetadataURL(String samlMetadataURL)` Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
`String`	`toString()` Returns a string representation of this object.
`FederationParameters`	`withApplicationCallBackURL(String applicationCallBackURL)` The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
`FederationParameters`	`withAttributeMap(Map<String,String> attributeMap)` SAML attribute name and value.
`FederationParameters`	`withFederationProviderName(String federationProviderName)` Name of the identity provider (IdP).
`FederationParameters`	`withFederationURN(String federationURN)` The Uniform Resource Name (URN).
`FederationParameters`	`withSamlMetadataDocument(String samlMetadataDocument)` SAML 2.0 Metadata document from identity provider (IdP).
`FederationParameters`	`withSamlMetadataURL(String samlMetadataURL)` Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FederationParameters
```
public FederationParameters()
```
- Method Detail
  - setSamlMetadataDocument
```
public void setSamlMetadataDocument(String samlMetadataDocument)
```
    SAML 2.0 Metadata document from identity provider (IdP).
    
    Parameters:
    
    samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).
  - getSamlMetadataDocument
```
public String getSamlMetadataDocument()
```
    SAML 2.0 Metadata document from identity provider (IdP).
    
    Returns:
    
    SAML 2.0 Metadata document from identity provider (IdP).
  - withSamlMetadataDocument
```
public FederationParameters withSamlMetadataDocument(String samlMetadataDocument)
```
    SAML 2.0 Metadata document from identity provider (IdP).
    
    Parameters:
    
    samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSamlMetadataURL
```
public void setSamlMetadataURL(String samlMetadataURL)
```
    Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
    
    Parameters:
    
    samlMetadataURL - Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
  - getSamlMetadataURL
```
public String getSamlMetadataURL()
```
    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).
  - withSamlMetadataURL
```
public FederationParameters withSamlMetadataURL(String samlMetadataURL)
```
    Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
    
    Parameters:
    
    samlMetadataURL - Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationCallBackURL
```
public void setApplicationCallBackURL(String applicationCallBackURL)
```
    The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
    
    Parameters:
    
    applicationCallBackURL - The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
  - getApplicationCallBackURL
```
public String getApplicationCallBackURL()
```
    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).
  - withApplicationCallBackURL
```
public FederationParameters withApplicationCallBackURL(String applicationCallBackURL)
```
    The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
    
    Parameters:
    
    applicationCallBackURL - The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFederationURN
```
public void setFederationURN(String federationURN)
```
    The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
    
    Parameters:
    
    federationURN - The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
  - getFederationURN
```
public String getFederationURN()
```
    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.
  - withFederationURN
```
public FederationParameters withFederationURN(String federationURN)
```
    The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
    
    Parameters:
    
    federationURN - The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFederationProviderName
```
public void setFederationProviderName(String federationProviderName)
```
    Name of the identity provider (IdP).
    
    Parameters:
    
    federationProviderName - Name of the identity provider (IdP).
  - getFederationProviderName
```
public String getFederationProviderName()
```
    Name of the identity provider (IdP).
    
    Returns:
    
    Name of the identity provider (IdP).
  - withFederationProviderName
```
public FederationParameters withFederationProviderName(String federationProviderName)
```
    Name of the identity provider (IdP).
    
    Parameters:
    
    federationProviderName - Name of the identity provider (IdP).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributeMap
```
public Map<String,String> getAttributeMap()
```
    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.
    
    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.
  - setAttributeMap
```
public void setAttributeMap(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.
    
    Parameters:
    
    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.
  - withAttributeMap
```
public FederationParameters withAttributeMap(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributeMapEntry
```
public FederationParameters addAttributeMapEntry(String key,
                                                 String value)
```
    Add a single AttributeMap entry
    
    See Also:
    
    withAttributeMap(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributeMapEntries
```
public FederationParameters clearAttributeMapEntries()
```
    Removes all the entries added into AttributeMap.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FederationParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.480

Class FederationParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FederationParameters

Method Detail

setSamlMetadataDocument

getSamlMetadataDocument

withSamlMetadataDocument

setSamlMetadataURL

getSamlMetadataURL

withSamlMetadataURL

setApplicationCallBackURL

getApplicationCallBackURL

withApplicationCallBackURL

setFederationURN

getFederationURN

withFederationURN

setFederationProviderName

getFederationProviderName

withFederationProviderName

getAttributeMap

setAttributeMap

withAttributeMap

addAttributeMapEntry

clearAttributeMapEntries

toString

equals

hashCode

clone

marshall