CognitoOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticsearch.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 Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CognitoOptions()

Constructors
Constructor and Description
`CognitoOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CognitoOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` Specifies the option to enable Cognito for Kibana authentication.
`String`	`getIdentityPoolId()` Specifies the Cognito identity pool ID for Kibana authentication.
`String`	`getRoleArn()` Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
`String`	`getUserPoolId()` Specifies the Cognito user pool ID for Kibana authentication.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies the option to enable Cognito for Kibana authentication.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEnabled(Boolean enabled)` Specifies the option to enable Cognito for Kibana authentication.
`void`	`setIdentityPoolId(String identityPoolId)` Specifies the Cognito identity pool ID for Kibana authentication.
`void`	`setRoleArn(String roleArn)` Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
`void`	`setUserPoolId(String userPoolId)` Specifies the Cognito user pool ID for Kibana authentication.
`String`	`toString()` Returns a string representation of this object.
`CognitoOptions`	`withEnabled(Boolean enabled)` Specifies the option to enable Cognito for Kibana authentication.
`CognitoOptions`	`withIdentityPoolId(String identityPoolId)` Specifies the Cognito identity pool ID for Kibana authentication.
`CognitoOptions`	`withRoleArn(String roleArn)` Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
`CognitoOptions`	`withUserPoolId(String userPoolId)` Specifies the Cognito user pool ID for Kibana authentication.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CognitoOptions
```
public CognitoOptions()
```
- Method Detail
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies the option to enable Cognito for Kibana authentication.
    
    Parameters:
    
    enabled - Specifies the option to enable Cognito for Kibana authentication.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies the option to enable Cognito for Kibana authentication.
    
    Returns:
    
    Specifies the option to enable Cognito for Kibana authentication.
  - withEnabled
```
public CognitoOptions withEnabled(Boolean enabled)
```
    Specifies the option to enable Cognito for Kibana authentication.
    
    Parameters:
    
    enabled - Specifies the option to enable Cognito for Kibana authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Specifies the option to enable Cognito for Kibana authentication.
    
    Returns:
    
    Specifies the option to enable Cognito for Kibana authentication.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    Specifies the Cognito user pool ID for Kibana authentication.
    
    Parameters:
    
    userPoolId - Specifies the Cognito user pool ID for Kibana authentication.
  - getUserPoolId
```
public String getUserPoolId()
```
    Specifies the Cognito user pool ID for Kibana authentication.
    
    Returns:
    
    Specifies the Cognito user pool ID for Kibana authentication.
  - withUserPoolId
```
public CognitoOptions withUserPoolId(String userPoolId)
```
    Specifies the Cognito user pool ID for Kibana authentication.
    
    Parameters:
    
    userPoolId - Specifies the Cognito user pool ID for Kibana authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityPoolId
```
public void setIdentityPoolId(String identityPoolId)
```
    Specifies the Cognito identity pool ID for Kibana authentication.
    
    Parameters:
    
    identityPoolId - Specifies the Cognito identity pool ID for Kibana authentication.
  - getIdentityPoolId
```
public String getIdentityPoolId()
```
    Specifies the Cognito identity pool ID for Kibana authentication.
    
    Returns:
    
    Specifies the Cognito identity pool ID for Kibana authentication.
  - withIdentityPoolId
```
public CognitoOptions withIdentityPoolId(String identityPoolId)
```
    Specifies the Cognito identity pool ID for Kibana authentication.
    
    Parameters:
    
    identityPoolId - Specifies the Cognito identity pool ID for Kibana authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
    
    Parameters:
    
    roleArn - Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
  - getRoleArn
```
public String getRoleArn()
```
    Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
    
    Returns:
    
    Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
  - withRoleArn
```
public CognitoOptions withRoleArn(String roleArn)
```
    Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
    
    Parameters:
    
    roleArn - Specifies the role ARN that provides Elasticsearch 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)
```
    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.

Did this page help you?

Class CognitoOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CognitoOptions

Method Detail

setEnabled

getEnabled

withEnabled

isEnabled

setUserPoolId

getUserPoolId

withUserPoolId

setIdentityPoolId

getIdentityPoolId

withIdentityPoolId

setRoleArn

getRoleArn

withRoleArn

toString

equals

hashCode

clone

marshall