Package software.amazon.awssdk.services.ssoadmin.model

Class InstanceMetadata

java.lang.Object

software.amazon.awssdk.services.ssoadmin.model.InstanceMetadata

All Implemented Interfaces:

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

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

Provides information about the IAM Identity Center instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstanceMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static InstanceMetadata.Builder	builder()
Instant	createdDate()	The date and time that the Identity Center instance was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityStoreId()	The identifier of the identity store that is connected to the Identity Center instance.
String	instanceArn()	The ARN of the Identity Center instance under which the operation will be executed.
String	name()	The name of the Identity Center instance.
String	ownerAccountId()	The Amazon Web Services account ID number of the owner of the Identity Center instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceMetadata.Builder>	serializableBuilderClass()
InstanceStatus	status()	The current status of this Identity Center instance.
String	statusAsString()	The current status of this Identity Center instance.
String	statusReason()	Provides additional context about the current status of the IAM Identity Center instance.
InstanceMetadata.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

instanceArn

public final String instanceArn()

The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Returns:

The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

identityStoreId

public final String identityStoreId()

The identifier of the identity store that is connected to the Identity Center instance.

Returns:

The identifier of the identity store that is connected to the Identity Center instance.

ownerAccountId

public final String ownerAccountId()

The Amazon Web Services account ID number of the owner of the Identity Center instance.

Returns:

The Amazon Web Services account ID number of the owner of the Identity Center instance.

name

public final String name()

The name of the Identity Center instance.

Returns:

The name of the Identity Center instance.

createdDate

public final Instant createdDate()

The date and time that the Identity Center instance was created.

Returns:

The date and time that the Identity Center instance was created.

status

public final InstanceStatus status()

The current status of this Identity Center instance.

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

Returns:

The current status of this Identity Center instance.

See Also:

InstanceStatus

statusAsString

public final String statusAsString()

The current status of this Identity Center instance.

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

Returns:

The current status of this Identity Center instance.

See Also:

InstanceStatus

statusReason

public final String statusReason()

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.

Returns:

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance creation fails, this field contains information about the cause, which may include issues with KMS key configuration or insufficient permissions.

toBuilder

public InstanceMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceMetadata.Builder,InstanceMetadata>

builder

public static InstanceMetadata.Builder builder()

serializableBuilderClass

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