com.amazonaws.services.opensearch.model

Class CognitoOptions

java.lang.Object

com.amazonaws.services.opensearch.model.CognitoOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CognitoOptions()

Method Summary

Modifier and Type	Method and Description
CognitoOptions	clone()
boolean	equals(Object obj)
Boolean	getEnabled() The option to enable Cognito for OpenSearch Dashboards authentication.
String	getIdentityPoolId() The Cognito identity pool ID for OpenSearch Dashboards authentication.
String	getRoleArn() The role ARN that provides OpenSearch permissions for accessing Cognito resources.
String	getUserPoolId() The Cognito user pool ID for OpenSearch Dashboards authentication.
int	hashCode()
Boolean	isEnabled() The option to enable Cognito for OpenSearch Dashboards authentication.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setEnabled(Boolean enabled) The option to enable Cognito for OpenSearch Dashboards authentication.
void	setIdentityPoolId(String identityPoolId) The Cognito identity pool ID for OpenSearch Dashboards authentication.
void	setRoleArn(String roleArn) The role ARN that provides OpenSearch permissions for accessing Cognito resources.
void	setUserPoolId(String userPoolId) The Cognito user pool ID for OpenSearch Dashboards authentication.
String	toString() Returns a string representation of this object.
CognitoOptions	withEnabled(Boolean enabled) The option to enable Cognito for OpenSearch Dashboards authentication.
CognitoOptions	withIdentityPoolId(String identityPoolId) The Cognito identity pool ID for OpenSearch Dashboards authentication.
CognitoOptions	withRoleArn(String roleArn) The role ARN that provides OpenSearch permissions for accessing Cognito resources.
CognitoOptions	withUserPoolId(String userPoolId) The Cognito user pool ID for OpenSearch Dashboards authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoOptions

public CognitoOptions()

Method Detail

setEnabled

public void setEnabled(Boolean enabled)

The option to enable Cognito for OpenSearch Dashboards authentication.

Parameters:

enabled - The option to enable Cognito for OpenSearch Dashboards authentication.

getEnabled

public Boolean getEnabled()

The option to enable Cognito for OpenSearch Dashboards authentication.

Returns:

The option to enable Cognito for OpenSearch Dashboards authentication.

withEnabled

public CognitoOptions withEnabled(Boolean enabled)

The option to enable Cognito for OpenSearch Dashboards authentication.

Parameters:

enabled - The option to enable Cognito for OpenSearch Dashboards authentication.

Returns:

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

isEnabled

public Boolean isEnabled()

The option to enable Cognito for OpenSearch Dashboards authentication.

Returns:

The option to enable Cognito for OpenSearch Dashboards authentication.

setUserPoolId

public void setUserPoolId(String userPoolId)

The Cognito user pool ID for OpenSearch Dashboards authentication.

Parameters:

userPoolId - The Cognito user pool ID for OpenSearch Dashboards authentication.

getUserPoolId

public String getUserPoolId()

The Cognito user pool ID for OpenSearch Dashboards authentication.

Returns:

The Cognito user pool ID for OpenSearch Dashboards authentication.

withUserPoolId

public CognitoOptions withUserPoolId(String userPoolId)

The Cognito user pool ID for OpenSearch Dashboards authentication.

Parameters:

userPoolId - The Cognito user pool ID for OpenSearch Dashboards authentication.

Returns:

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

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

The Cognito identity pool ID for OpenSearch Dashboards authentication.

Parameters:

identityPoolId - The Cognito identity pool ID for OpenSearch Dashboards authentication.

getIdentityPoolId

public String getIdentityPoolId()

The Cognito identity pool ID for OpenSearch Dashboards authentication.

Returns:

The Cognito identity pool ID for OpenSearch Dashboards authentication.

withIdentityPoolId

public CognitoOptions withIdentityPoolId(String identityPoolId)

The Cognito identity pool ID for OpenSearch Dashboards authentication.

Parameters:

identityPoolId - The Cognito identity pool ID for OpenSearch Dashboards authentication.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

Parameters:

roleArn - The role ARN that provides OpenSearch permissions for accessing Cognito resources.

getRoleArn

public String getRoleArn()

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

Returns:

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

withRoleArn

public CognitoOptions withRoleArn(String roleArn)

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

Parameters:

roleArn - The role ARN that provides OpenSearch permissions for accessing Cognito resources.

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 CognitoOptions clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo