Interface DescribeInstanceResponse.Builder

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

  • Method Details

    • instanceArn

      DescribeInstanceResponse.Builder instanceArn(String instanceArn)

      The ARN of the instance of IAM Identity Center under which the operation will run. 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 instance of IAM Identity Center under which the operation will run. 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

      DescribeInstanceResponse.Builder identityStoreId(String identityStoreId)

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

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

    • identityStoreArn

      DescribeInstanceResponse.Builder identityStoreArn(String identityStoreArn)

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

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

    • ownerAccountId

      DescribeInstanceResponse.Builder ownerAccountId(String ownerAccountId)

      The identifier of the Amazon Web Services account for which the instance was created.

      Parameters:
      ownerAccountId - The identifier of the Amazon Web Services account for which the instance was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      DescribeInstanceResponse.Builder name(String name)

      Specifies the instance name.

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

    • createdDate

      DescribeInstanceResponse.Builder createdDate(Instant createdDate)

      The date the instance was created.

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

    • status

      DescribeInstanceResponse.Builder status(String status)

      The status of the instance.

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

    • status

      DescribeInstanceResponse.Builder status(InstanceStatus status)

      The status of the instance.

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

    • statusReason

      DescribeInstanceResponse.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 fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.

      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 fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryRegion

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

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

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

      DescribeInstanceResponse.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:

    • encryptionConfigurationDetails

      DescribeInstanceResponse.Builder encryptionConfigurationDetails(EncryptionConfigurationDetails encryptionConfigurationDetails)

      Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

      Parameters:
      encryptionConfigurationDetails - Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfigurationDetails

      default DescribeInstanceResponse.Builder encryptionConfigurationDetails(Consumer<EncryptionConfigurationDetails.Builder> encryptionConfigurationDetails)

      Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfigurationDetails(EncryptionConfigurationDetails).

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

    • permissionSetsEnabled

      DescribeInstanceResponse.Builder permissionSetsEnabled(Boolean permissionSetsEnabled)

      Indicates whether permission sets are enabled for this Identity Center instance.

      Parameters:
      permissionSetsEnabled - Indicates whether permission sets are enabled for this Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.