Class CognitoOptions

java.lang.Object
software.amazon.awssdk.services.opensearch.model.CognitoOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>
@Generated("software.amazon.awssdk:codegen") public final class CognitoOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>

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.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      Returns:
      Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

    • userPoolId

      public final String userPoolId()

      The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      Returns:
      The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

    • identityPoolId

      public final String identityPoolId()

      The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      Returns:
      The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

    • roleArn

      public final String roleArn()

      The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

      Returns:
      The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • toBuilder

      public CognitoOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>
      Returns:
      a builder for type T

    • builder

      public static CognitoOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CognitoOptions.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.