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

Class AuthenticationDescription

java.lang.Object

software.amazon.awssdk.services.grafana.model.AuthenticationDescription

All Implemented Interfaces:

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

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

A structure containing information about the user authentication methods used by the workspace.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthenticationDescription.Builder

Method Summary

Modifier and Type	Method	Description
AwsSsoAuthentication	awsSso()	A structure containing information about how this workspace works with IAM Identity Center.
static AuthenticationDescription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProviders()	For responses, this returns true if the service returned a value for the Providers property.
List<AuthenticationProviderTypes>	providers()	Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
List<String>	providersAsStrings()	Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
SamlAuthentication	saml()	A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthenticationDescription.Builder>	serializableBuilderClass()
AuthenticationDescription.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

awsSso

public final AwsSsoAuthentication awsSso()

A structure containing information about how this workspace works with IAM Identity Center.

Returns:

A structure containing information about how this workspace works with IAM Identity Center.

providers

public final List<AuthenticationProviderTypes> providers()

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

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

Returns:

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

hasProviders

public final boolean hasProviders()

For responses, this returns true if the service returned a value for the Providers 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.

providersAsStrings

public final List<String> providersAsStrings()

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

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

Returns:

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

saml

public final SamlAuthentication saml()

A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

Returns:

A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

toBuilder

public AuthenticationDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthenticationDescription.Builder,AuthenticationDescription>

builder

public static AuthenticationDescription.Builder builder()

serializableBuilderClass

public static Class<? extends AuthenticationDescription.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