Interface InstanceMetadata.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InstanceMetadata.Builder,InstanceMetadata>, SdkBuilder<InstanceMetadata.Builder,InstanceMetadata>, SdkPojo
Enclosing class:
InstanceMetadata
@Mutable @NotThreadSafe public static interface InstanceMetadata.Builder extends SdkPojo, CopyableBuilder<InstanceMetadata.Builder,InstanceMetadata>

  • Method Details

    • instanceArn

      InstanceMetadata.Builder instanceArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • identityStoreId

      InstanceMetadata.Builder identityStoreId(String identityStoreId)

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

      Parameters:
      identityStoreId - The identifier of the identity store that is connected to the Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ownerAccountId

      InstanceMetadata.Builder ownerAccountId(String ownerAccountId)

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

      Parameters:
      ownerAccountId - The Amazon Web Services account ID number of the owner of the Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      InstanceMetadata.Builder name(String name)

      The name of the Identity Center instance.

      Parameters:
      name - The name of the Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdDate

      InstanceMetadata.Builder createdDate(Instant createdDate)

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

      Parameters:
      createdDate - The date and time that the Identity Center instance was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      InstanceMetadata.Builder status(String status)

      The current status of this Identity Center instance.

      Parameters:
      status - The current status of this Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      InstanceMetadata.Builder status(InstanceStatus status)

      The current status of this Identity Center instance.

      Parameters:
      status - The current status of this Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      InstanceMetadata.Builder statusReason(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • primaryRegion

      InstanceMetadata.Builder primaryRegion(String primaryRegion)

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

      Parameters:
      primaryRegion - The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      InstanceMetadata.Builder regions(Collection<RegionMetadata> regions)

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

      Parameters:
      regions - The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      InstanceMetadata.Builder regions(RegionMetadata... regions)

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

      Parameters:
      regions - The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      InstanceMetadata.Builder regions(Consumer<RegionMetadata.Builder>... regions)

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

      This is a convenience method that creates an instance of the RegionMetadata.Builder avoiding the need to create one manually via RegionMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regions(List<RegionMetadata>).

      Parameters:
      regions - a consumer that will call methods on RegionMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: