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:

  • Method Details

    • 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:

    • 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:

    • 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.

    • primaryRegion

      public final String primaryRegion()

      The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

      Returns:
      The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • regions

      public final List<RegionMetadata> regions()

      The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

      Returns:
      The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

    • toBuilder

      public InstanceMetadata.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceMetadata.Builder,InstanceMetadata>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.