Package software.amazon.awssdk.services.opensearch.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentityCenterOptions.Builder

Method Summary

Modifier and Type	Method	Description
static IdentityCenterOptions.Builder	builder()
Boolean	enabledAPIAccess()	Indicates whether IAM Identity Center is enabled for the application.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityCenterApplicationARN()	The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.
String	identityCenterInstanceARN()	The Amazon Resource Name (ARN) of the IAM Identity Center instance.
String	identityStoreId()	The identifier of the IAM Identity Store.
RolesKeyIdCOption	rolesKey()	Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
String	rolesKeyAsString()	Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityCenterOptions.Builder>	serializableBuilderClass()
SubjectKeyIdCOption	subjectKey()	Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.
String	subjectKeyAsString()	Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.
IdentityCenterOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SubjectKeyIdCOption

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:

SubjectKeyIdCOption

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:

RolesKeyIdCOption

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:

RolesKeyIdCOption

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()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityCenterOptions.Builder,IdentityCenterOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo