Class: Aws::ResourceExplorer2::Types::GetIndexOutput

Inherits:

Struct

• Object
• Struct
• Aws::ResourceExplorer2::Types::GetIndexOutput

Includes:

Structure

Defined in:

lib/aws-sdk-resourceexplorer2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags]

Instance Attribute Summary

• #arn ⇒ String

  The [Amazon resource name (ARN)] of the index.

• #created_at ⇒ Time

  The date and time when the index was originally created.

• #last_updated_at ⇒ Time

  The date and time when the index was last updated.

• #replicating_from ⇒ Array<String>

  This response value is present only if this index is ‘Type=AGGREGATOR`.

• #replicating_to ⇒ Array<String>

  This response value is present only if this index is ‘Type=LOCAL`.

• #state ⇒ String

  The current state of the index in this Amazon Web Services Region.

• #tags ⇒ Hash<String,String>

  Tag key and value pairs that are attached to the index.

• #type ⇒ String

  The type of the index in this Region.

Instance Attribute Details

#arn ⇒ String

The [Amazon resource name (ARN)] of the index.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the index was originally created.

Returns:

• (Time)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#last_updated_at ⇒ Time

The date and time when the index was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#replicating_from ⇒ Array<String>

This response value is present only if this index is ‘Type=AGGREGATOR`.

A list of the Amazon Web Services Regions that replicate their content to the index in this Region.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#replicating_to ⇒ Array<String>

This response value is present only if this index is ‘Type=LOCAL`.

The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#state ⇒ String

The current state of the index in this Amazon Web Services Region.

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tag key and value pairs that are attached to the index.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#type ⇒ String

The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see [Turning on cross-Region search by creating an aggregator index].

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 568

class GetIndexOutput < Struct.new(
  :arn,
  :type,
  :state,
  :replicating_from,
  :replicating_to,
  :created_at,
  :last_updated_at,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end