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>

Container for IAM Identity Center Options settings.

See Also:

  • Method Details

    • enabledAPIAccess

      public final Boolean enabledAPIAccess()

      True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

      Returns:
      True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

    • identityCenterInstanceARN

      public final String identityCenterInstanceARN()

      The ARN for IAM Identity Center Instance.

      Returns:
      The ARN for IAM Identity Center Instance.

    • subjectKey

      public final SubjectKeyIdCOption subjectKey()

      Specify the attribute that contains the subject (username, userID, email) of 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:
      Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.
      See Also:

    • subjectKeyAsString

      public final String subjectKeyAsString()

      Specify the attribute that contains the subject (username, userID, email) of 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:
      Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.
      See Also:

    • rolesKey

      public final RolesKeyIdCOption rolesKey()

      Specify the attribute that contains the backend role (groupName, groupID) of 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:
      Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
      See Also:

    • rolesKeyAsString

      public final String rolesKeyAsString()

      Specify the attribute that contains the backend role (groupName, groupID) of 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:
      Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
      See Also:

    • identityCenterApplicationARN

      public final String identityCenterApplicationARN()

      The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

      Returns:
      The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

    • identityStoreId

      public final String identityStoreId()

      The ID of IAM Identity Store.

      Returns:
      The ID of 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.