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

Class IdentityCenterOptionsInput

java.lang.Object

software.amazon.awssdk.services.opensearch.model.IdentityCenterOptionsInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IdentityCenterOptionsInput.Builder,IdentityCenterOptionsInput>

@Generated("software.amazon.awssdk:codegen")
public final class IdentityCenterOptionsInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IdentityCenterOptionsInput.Builder,IdentityCenterOptionsInput>

Configuration settings for enabling and managing IAM Identity Center.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentityCenterOptionsInput.Builder

Method Summary

Modifier and Type	Method	Description
static IdentityCenterOptionsInput.Builder	builder()
Boolean	enabledAPIAccess()	Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityCenterInstanceARN()	The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.
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 IdentityCenterOptionsInput.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.
IdentityCenterOptionsInput.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 API access in Amazon OpenSearch Service.

Returns:

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.

identityCenterInstanceARN

public final String identityCenterInstanceARN()

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

Returns:

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

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

toBuilder

public IdentityCenterOptionsInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityCenterOptionsInput.Builder,IdentityCenterOptionsInput>

builder

public static IdentityCenterOptionsInput.Builder builder()

serializableBuilderClass

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