com.amazonaws.services.managedgrafana.model

Class AuthenticationDescription

java.lang.Object

com.amazonaws.services.managedgrafana.model.AuthenticationDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticationDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationDescription()

Method Summary

Modifier and Type	Method and Description
AuthenticationDescription	clone()
boolean	equals(Object obj)
AwsSsoAuthentication	getAwsSso() A structure containing information about how this workspace works with IAM Identity Center.
List<String>	getProviders() 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	getSaml() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAwsSso(AwsSsoAuthentication awsSso) A structure containing information about how this workspace works with IAM Identity Center.
void	setProviders(Collection<String> 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.
void	setSaml(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.
String	toString() Returns a string representation of this object.
AuthenticationDescription	withAwsSso(AwsSsoAuthentication awsSso) A structure containing information about how this workspace works with IAM Identity Center.
AuthenticationDescription	withProviders(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.
AuthenticationDescription	withProviders(Collection<String> 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.
AuthenticationDescription	withProviders(String... 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.
AuthenticationDescription	withSaml(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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationDescription

public AuthenticationDescription()

Method Detail

setAwsSso

public void setAwsSso(AwsSsoAuthentication awsSso)

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

Parameters:

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

getAwsSso

public AwsSsoAuthentication getAwsSso()

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.

withAwsSso

public AuthenticationDescription withAwsSso(AwsSsoAuthentication awsSso)

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

Parameters:

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

Returns:

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

getProviders

public List<String> getProviders()

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.

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.

See Also:

AuthenticationProviderTypes

setProviders

public void setProviders(Collection<String> 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.

Parameters:

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.

See Also:

AuthenticationProviderTypes

withProviders

public AuthenticationDescription withProviders(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setProviders(java.util.Collection) or withProviders(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

See Also:

AuthenticationProviderTypes

withProviders

public AuthenticationDescription withProviders(Collection<String> 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.

Parameters:

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.

Returns:

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

See Also:

AuthenticationProviderTypes

withProviders

public AuthenticationDescription withProviders(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.

Parameters:

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.

Returns:

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

See Also:

AuthenticationProviderTypes

setSaml

public void setSaml(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.

Parameters:

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.

getSaml

public SamlAuthentication getSaml()

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.

withSaml

public AuthenticationDescription withSaml(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.

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AuthenticationDescription clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.