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

Class SamlConfiguration

java.lang.Object

software.amazon.awssdk.services.grafana.model.SamlConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class SamlConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>

A structure containing information about how this workspace works with SAML.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SamlConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	allowedOrganizations()	Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
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.
static SamlConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedOrganizations()	For responses, this returns true if the service returned a value for the AllowedOrganizations property.
int	hashCode()
IdpMetadata	idpMetadata()	A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
Integer	loginValidityDuration()	How long a sign-on session by a SAML user is valid, before the user has to sign on again.
RoleValues	roleValues()	A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
List<SdkField<?>>	sdkFields()
static Class<? extends SamlConfiguration.Builder>	serializableBuilderClass()
SamlConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasAllowedOrganizations

public final boolean hasAllowedOrganizations()

For responses, this returns true if the service returned a value for the AllowedOrganizations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

allowedOrganizations

public final List<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.

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 hasAllowedOrganizations() method.

Returns:

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.

assertionAttributes

public final 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.

Returns:

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.

idpMetadata

public final IdpMetadata idpMetadata()

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

Returns:

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

loginValidityDuration

public final Integer loginValidityDuration()

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

Returns:

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

roleValues

public final RoleValues roleValues()

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

Returns:

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

toBuilder

public SamlConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>

builder

public static SamlConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SamlConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo