Package software.amazon.awscdk.services.finspace

Class CfnEnvironment.FederationParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.finspace.CfnEnvironment.FederationParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEnvironment.FederationParametersProperty>

Enclosing interface:

CfnEnvironment.FederationParametersProperty

@Stability(Stable)
public static final class CfnEnvironment.FederationParametersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEnvironment.FederationParametersProperty>

A builder for CfnEnvironment.FederationParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEnvironment.FederationParametersProperty.Builder	applicationCallBackUrl(String applicationCallBackUrl)	Sets the value of CfnEnvironment.FederationParametersProperty.getApplicationCallBackUrl()
CfnEnvironment.FederationParametersProperty.Builder	attributeMap(List<? extends Object> attributeMap)	Sets the value of CfnEnvironment.FederationParametersProperty.getAttributeMap()
CfnEnvironment.FederationParametersProperty.Builder	attributeMap(IResolvable attributeMap)	Sets the value of CfnEnvironment.FederationParametersProperty.getAttributeMap()
CfnEnvironment.FederationParametersProperty	build()	Builds the configured instance.
CfnEnvironment.FederationParametersProperty.Builder	federationProviderName(String federationProviderName)	Sets the value of CfnEnvironment.FederationParametersProperty.getFederationProviderName()
CfnEnvironment.FederationParametersProperty.Builder	federationUrn(String federationUrn)	Sets the value of CfnEnvironment.FederationParametersProperty.getFederationUrn()
CfnEnvironment.FederationParametersProperty.Builder	samlMetadataDocument(String samlMetadataDocument)	Sets the value of CfnEnvironment.FederationParametersProperty.getSamlMetadataDocument()
CfnEnvironment.FederationParametersProperty.Builder	samlMetadataUrl(String samlMetadataUrl)	Sets the value of CfnEnvironment.FederationParametersProperty.getSamlMetadataUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

applicationCallBackUrl

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder applicationCallBackUrl(String applicationCallBackUrl)

Sets the value of CfnEnvironment.FederationParametersProperty.getApplicationCallBackUrl()

Parameters:

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

Returns:

this

attributeMap

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder attributeMap(IResolvable attributeMap)

Sets the value of CfnEnvironment.FederationParametersProperty.getAttributeMap()

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:

this

attributeMap

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder attributeMap(List<? extends Object> attributeMap)

Sets the value of CfnEnvironment.FederationParametersProperty.getAttributeMap()

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:

this

federationProviderName

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder federationProviderName(String federationProviderName)

Sets the value of CfnEnvironment.FederationParametersProperty.getFederationProviderName()

Parameters:

federationProviderName - Name of the identity provider (IdP).

Returns:

this

federationUrn

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder federationUrn(String federationUrn)

Sets the value of CfnEnvironment.FederationParametersProperty.getFederationUrn()

Parameters:

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

Returns:

this

samlMetadataDocument

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder samlMetadataDocument(String samlMetadataDocument)

Sets the value of CfnEnvironment.FederationParametersProperty.getSamlMetadataDocument()

Parameters:

samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).

Returns:

this

samlMetadataUrl

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty.Builder samlMetadataUrl(String samlMetadataUrl)

Sets the value of CfnEnvironment.FederationParametersProperty.getSamlMetadataUrl()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnEnvironment.FederationParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEnvironment.FederationParametersProperty>

Returns:

a new instance of CfnEnvironment.FederationParametersProperty

Throws:

NullPointerException - if any required attribute was not provided