Package software.amazon.awssdk.services.grafana.model

Interface SamlConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

SamlConfiguration

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

Method Summary

Modifier and Type	Method	Description
SamlConfiguration.Builder	allowedOrganizations(String... allowedOrganizations)	Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
SamlConfiguration.Builder	allowedOrganizations(Collection<String> allowedOrganizations)	Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
default SamlConfiguration.Builder	assertionAttributes(Consumer<AssertionAttributes.Builder> assertionAttributes)	A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
SamlConfiguration.Builder	assertionAttributes(AssertionAttributes assertionAttributes)	A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
default SamlConfiguration.Builder	idpMetadata(Consumer<IdpMetadata.Builder> idpMetadata)	A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
SamlConfiguration.Builder	idpMetadata(IdpMetadata idpMetadata)	A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
SamlConfiguration.Builder	loginValidityDuration(Integer loginValidityDuration)	How long a sign-on session by a SAML user is valid, before the user has to sign on again.
default SamlConfiguration.Builder	roleValues(Consumer<RoleValues.Builder> roleValues)	A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
SamlConfiguration.Builder	roleValues(RoleValues roleValues)	A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

allowedOrganizations

SamlConfiguration.Builder allowedOrganizations(Collection<String> allowedOrganizations)

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

Parameters:

allowedOrganizations - Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

Returns:

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

allowedOrganizations

SamlConfiguration.Builder allowedOrganizations(String... allowedOrganizations)

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

Parameters:

allowedOrganizations - Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

Returns:

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

assertionAttributes

SamlConfiguration.Builder assertionAttributes(AssertionAttributes assertionAttributes)

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

Parameters:

assertionAttributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

Returns:

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

assertionAttributes

default SamlConfiguration.Builder assertionAttributes(Consumer<AssertionAttributes.Builder> assertionAttributes)

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

This is a convenience method that creates an instance of the AssertionAttributes.Builder avoiding the need to create one manually via AssertionAttributes.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assertionAttributes(AssertionAttributes).

Parameters:

assertionAttributes - a consumer that will call methods on AssertionAttributes.Builder

Returns:

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

See Also:

assertionAttributes(AssertionAttributes)

idpMetadata

SamlConfiguration.Builder idpMetadata(IdpMetadata idpMetadata)

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

Parameters:

idpMetadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

Returns:

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

idpMetadata

default SamlConfiguration.Builder idpMetadata(Consumer<IdpMetadata.Builder> idpMetadata)

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

This is a convenience method that creates an instance of the IdpMetadata.Builder avoiding the need to create one manually via IdpMetadata.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to idpMetadata(IdpMetadata).

Parameters:

idpMetadata - a consumer that will call methods on IdpMetadata.Builder

Returns:

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

See Also:

idpMetadata(IdpMetadata)

loginValidityDuration

SamlConfiguration.Builder loginValidityDuration(Integer loginValidityDuration)

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

Parameters:

loginValidityDuration - How long a sign-on session by a SAML user is valid, before the user has to sign on again.

Returns:

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

roleValues

SamlConfiguration.Builder roleValues(RoleValues roleValues)

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

Parameters:

roleValues - A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

Returns:

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

roleValues

default SamlConfiguration.Builder roleValues(Consumer<RoleValues.Builder> roleValues)

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

This is a convenience method that creates an instance of the RoleValues.Builder avoiding the need to create one manually via RoleValues.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to roleValues(RoleValues).

Parameters:

roleValues - a consumer that will call methods on RoleValues.Builder

Returns:

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

See Also:

roleValues(RoleValues)