Class IamIdentityCenterConfigOptions

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

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

See Also:

  • Method Details

    • instanceArn

      public final String instanceArn()

      The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

      Returns:
      The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

    • applicationArn

      public final String applicationArn()

      The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      Returns:
      The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

    • applicationName

      public final String applicationName()

      The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      Returns:
      The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

    • applicationDescription

      public final String applicationDescription()

      The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      Returns:
      The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

    • userAttribute

      public final IamIdentityCenterUserAttribute userAttribute()

      The user attribute for this IAM Identity Center integration. Defaults to UserId

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

      Returns:
      The user attribute for this IAM Identity Center integration. Defaults to UserId
      See Also:

    • userAttributeAsString

      public final String userAttributeAsString()

      The user attribute for this IAM Identity Center integration. Defaults to UserId

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

      Returns:
      The user attribute for this IAM Identity Center integration. Defaults to UserId
      See Also:

    • groupAttribute

      public final IamIdentityCenterGroupAttribute groupAttribute()

      The group attribute for this IAM Identity Center integration. Defaults to GroupId.

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

      Returns:
      The group attribute for this IAM Identity Center integration. Defaults to GroupId.
      See Also:

    • groupAttributeAsString

      public final String groupAttributeAsString()

      The group attribute for this IAM Identity Center integration. Defaults to GroupId.

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

      Returns:
      The group attribute for this IAM Identity Center integration. Defaults to GroupId.
      See Also:

    • toBuilder

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

    • builder

      public static IamIdentityCenterConfigOptions.Builder builder()

    • serializableBuilderClass

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