software.amazon.awssdk.services.workspaces.model

Interface SamlProperties.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SamlProperties.Builder,SamlProperties>, SdkBuilder<SamlProperties.Builder,SamlProperties>, SdkPojo

Enclosing class:

SamlProperties

public static interface SamlProperties.Builder
extends SdkPojo, CopyableBuilder<SamlProperties.Builder,SamlProperties>

Method Summary

Modifier and Type	Method and Description
SamlProperties.Builder	relayStateParameterName(String relayStateParameterName) The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
SamlProperties.Builder	status(SamlStatusEnum status) Indicates the status of SAML 2.0 authentication.
SamlProperties.Builder	status(String status) Indicates the status of SAML 2.0 authentication.
SamlProperties.Builder	userAccessUrl(String userAccessUrl) The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

status

SamlProperties.Builder status(String status)

Indicates the status of SAML 2.0 authentication. These statuses include the following.

• If the setting is DISABLED, end users will be directed to login with their directory credentials.

• If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

• If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

Parameters:

status - Indicates the status of SAML 2.0 authentication. These statuses include the following.

• If the setting is DISABLED, end users will be directed to login with their directory credentials.

• If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

• If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SamlStatusEnum, SamlStatusEnum

status

SamlProperties.Builder status(SamlStatusEnum status)

Indicates the status of SAML 2.0 authentication. These statuses include the following.

• If the setting is DISABLED, end users will be directed to login with their directory credentials.

• If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

• If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

Parameters:

status - Indicates the status of SAML 2.0 authentication. These statuses include the following.

• If the setting is DISABLED, end users will be directed to login with their directory credentials.

• If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

• If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SamlStatusEnum, SamlStatusEnum

userAccessUrl

SamlProperties.Builder userAccessUrl(String userAccessUrl)

The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

Parameters:

userAccessUrl - The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

Returns:

Returns a reference to this object so that method calls can be chained together.

relayStateParameterName

SamlProperties.Builder relayStateParameterName(String relayStateParameterName)

The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

Parameters:

relayStateParameterName - The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.