Package software.amazon.awssdk.services.opensearchserverless.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IamIdentityCenterConfigOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationArn()	The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
String	applicationDescription()	The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
String	applicationName()	The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
static IamIdentityCenterConfigOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
IamIdentityCenterGroupAttribute	groupAttribute()	The group attribute for this IAM Identity Center integration.
String	groupAttributeAsString()	The group attribute for this IAM Identity Center integration.
int	hashCode()
String	instanceArn()	The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IamIdentityCenterConfigOptions.Builder>	serializableBuilderClass()
IamIdentityCenterConfigOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IamIdentityCenterUserAttribute	userAttribute()	The user attribute for this IAM Identity Center integration.
String	userAttributeAsString()	The user attribute for this IAM Identity Center integration.

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

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.

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.

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.

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:

IamIdentityCenterGroupAttribute

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:

IamIdentityCenterGroupAttribute

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.

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:

IamIdentityCenterUserAttribute

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:

IamIdentityCenterUserAttribute

toBuilder

public IamIdentityCenterConfigOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IamIdentityCenterConfigOptions.Builder,IamIdentityCenterConfigOptions>

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)

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