Class IdentityCenterOptions

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

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

See Also:

  • Method Details

    • enabledAPIAccess

      public final Boolean enabledAPIAccess()

      Indicates whether IAM Identity Center is enabled for the application.

      Returns:
      Indicates whether IAM Identity Center is enabled for the application.

    • identityCenterInstanceARN

      public final String identityCenterInstanceARN()

      The Amazon Resource Name (ARN) of the IAM Identity Center instance.

      Returns:
      The Amazon Resource Name (ARN) of the IAM Identity Center instance.

    • subjectKey

      public final SubjectKeyIdCOption subjectKey()

      Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

      If the service returns an enum value that is not available in the current SDK version, subjectKey will return SubjectKeyIdCOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subjectKeyAsString().

      Returns:
      Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.
      See Also:

    • subjectKeyAsString

      public final String subjectKeyAsString()

      Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

      If the service returns an enum value that is not available in the current SDK version, subjectKey will return SubjectKeyIdCOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subjectKeyAsString().

      Returns:
      Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.
      See Also:

    • rolesKey

      public final RolesKeyIdCOption rolesKey()

      Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

      If the service returns an enum value that is not available in the current SDK version, rolesKey will return RolesKeyIdCOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rolesKeyAsString().

      Returns:
      Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
      See Also:

    • rolesKeyAsString

      public final String rolesKeyAsString()

      Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

      If the service returns an enum value that is not available in the current SDK version, rolesKey will return RolesKeyIdCOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rolesKeyAsString().

      Returns:
      Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
      See Also:

    • identityCenterApplicationARN

      public final String identityCenterApplicationARN()

      The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

      Returns:
      The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

    • identityStoreId

      public final String identityStoreId()

      The identifier of the IAM Identity Store.

      Returns:
      The identifier of the IAM Identity Store.

    • toBuilder

      public IdentityCenterOptions.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<IdentityCenterOptions.Builder,IdentityCenterOptions>
      Returns:
      a builder for type T

    • builder

      public static IdentityCenterOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IdentityCenterOptions.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.