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>

Container for IAM Identity Center Options settings.

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()	True to enable IAM Identity Center 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	identityCenterApplicationARN()	The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.
String	identityCenterInstanceARN()	The ARN for IAM Identity Center Instance.
String	identityStoreId()	The ID of IAM Identity Store.
RolesKeyIdCOption	rolesKey()	Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
String	rolesKeyAsString()	Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityCenterOptions.Builder>	serializableBuilderClass()
SubjectKeyIdCOption	subjectKey()	Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.
String	subjectKeyAsString()	Specify the attribute that contains the subject (username, userID, email) of 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()

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:

SubjectKeyIdCOption

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:

SubjectKeyIdCOption

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:

RolesKeyIdCOption

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:

RolesKeyIdCOption

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

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