Class: Aws::SSOAdmin::Types::InstanceMetadata

Inherits:

Struct

• Object
• Struct
• Aws::SSOAdmin::Types::InstanceMetadata

Defined in:

gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb

Overview

Provides information about the IAM Identity Center instance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_date ⇒ Time

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

• #identity_store_id ⇒ String

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

• #instance_arn ⇒ String

  The ARN of the Identity Center instance under which the operation will be executed.

• #name ⇒ String

  The name of the Identity Center instance.

• #owner_account_id ⇒ String

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

• #primary_region ⇒ String

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

• #regions ⇒ Array<Types::RegionMetadata>

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

• #status ⇒ String

  The current status of this Identity Center instance.

• #status_reason ⇒ String

  Provides additional context about the current status of the IAM Identity Center instance.

Instance Attribute Details

#created_date ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#identity_store_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#instance_arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the Identity Center instance.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#primary_region ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<Types::RegionMetadata>

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

Returns:

• (Array<Types::RegionMetadata>)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of this Identity Center instance.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

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:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 2405

class InstanceMetadata < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions)
  SENSITIVE = []
  include Aws::Structure
end