@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CognitoOptions extends Object implements Serializable, Cloneable, StructuredPojo
Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Constructor and Description |
---|
CognitoOptions() |
Modifier and Type | Method and Description |
---|---|
CognitoOptions |
clone() |
boolean |
equals(Object obj) |
Boolean |
getEnabled()
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
|
String |
getIdentityPoolId()
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.
|
String |
getRoleArn()
The
AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user
pool and identity pool. |
String |
getUserPoolId()
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
|
int |
hashCode() |
Boolean |
isEnabled()
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setEnabled(Boolean enabled)
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
|
void |
setIdentityPoolId(String identityPoolId)
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.
|
void |
setRoleArn(String roleArn)
The
AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user
pool and identity pool. |
void |
setUserPoolId(String userPoolId)
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
|
String |
toString()
Returns a string representation of this object.
|
CognitoOptions |
withEnabled(Boolean enabled)
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
|
CognitoOptions |
withIdentityPoolId(String identityPoolId)
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.
|
CognitoOptions |
withRoleArn(String roleArn)
The
AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user
pool and identity pool. |
CognitoOptions |
withUserPoolId(String userPoolId)
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
|
public void setEnabled(Boolean enabled)
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
enabled
- Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.public Boolean getEnabled()
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
public CognitoOptions withEnabled(Boolean enabled)
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
enabled
- Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.public Boolean isEnabled()
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
public void setUserPoolId(String userPoolId)
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
userPoolId
- The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.public String getUserPoolId()
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
public CognitoOptions withUserPoolId(String userPoolId)
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
userPoolId
- The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.public void setIdentityPoolId(String identityPoolId)
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
identityPoolId
- The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.public String getIdentityPoolId()
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
public CognitoOptions withIdentityPoolId(String identityPoolId)
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
identityPoolId
- The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards
authentication.public void setRoleArn(String roleArn)
The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user
pool and identity pool.
roleArn
- The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure
your user pool and identity pool.public String getRoleArn()
The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user
pool and identity pool.
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure
your user pool and identity pool.public CognitoOptions withRoleArn(String roleArn)
The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user
pool and identity pool.
roleArn
- The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure
your user pool and identity pool.public String toString()
toString
in class Object
Object.toString()
public CognitoOptions clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.