Class: Aws::PrometheusService::Types::ScraperDescription

Inherits:

Struct

• Object
• Struct
• Aws::PrometheusService::Types::ScraperDescription

Includes:

Structure

Defined in:

lib/aws-sdk-prometheusservice/types.rb

Overview

The ScraperDescription structure contains the full details about one scraper in your account.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  (Optional) A name associated with the scraper.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the scraper.

• #created_at ⇒ Time

  The date and time that the scraper was created.

• #destination ⇒ Types::Destination

  The destination where the scraper sends metrics.

• #exporters ⇒ Array<Types::ExporterConfiguration>

  The exporter configurations for the scraper, if configured.

• #last_modified_at ⇒ Time

  The date and time that the scraper was last modified.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

• #role_configuration ⇒ Types::RoleConfiguration

  This structure displays information about the IAM roles used for cross-account scraping configuration.

• #scrape_configuration ⇒ Types::ScrapeConfiguration

  The configuration in use by the scraper.

• #scraper_id ⇒ String

  The ID of the scraper.

• #source ⇒ Types::Source

  The Amazon EKS cluster from which the scraper collects metrics.

• #status ⇒ Types::ScraperStatus

  A structure that contains the current status of the scraper.

• #status_reason ⇒ String

  If there is a failure, the reason for the failure.

• #tags ⇒ Hash<String,String>

  (Optional) The list of tag keys and values associated with the scraper.

Instance Attribute Details

#alias ⇒ String

(Optional) A name associated with the scraper.

Returns:

• (String)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the scraper. For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.

Returns:

• (String)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time that the scraper was created.

Returns:

• (Time)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::Destination

The destination where the scraper sends metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.

Returns:

• (Types::Destination)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#exporters ⇒ Array<Types::ExporterConfiguration>

The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain.

Returns:

• (Array<Types::ExporterConfiguration>)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_at ⇒ Time

The date and time that the scraper was last modified.

Returns:

• (Time)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.

Returns:

• (String)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#role_configuration ⇒ Types::RoleConfiguration

This structure displays information about the IAM roles used for cross-account scraping configuration.

Returns:

• (Types::RoleConfiguration)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#scrape_configuration ⇒ Types::ScrapeConfiguration

The configuration in use by the scraper.

Returns:

• (Types::ScrapeConfiguration)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#scraper_id ⇒ String

The ID of the scraper. For example, s-example1-1234-abcd-5678-ef9012abcd34.

Returns:

• (String)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::Source

The Amazon EKS cluster from which the scraper collects metrics.

Returns:

• (Types::Source)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::ScraperStatus

A structure that contains the current status of the scraper.

Returns:

• (Types::ScraperStatus)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

If there is a failure, the reason for the failure.

Returns:

• (String)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

(Optional) The list of tag keys and values associated with the scraper.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-prometheusservice/types.rb', line 2628

class ScraperDescription < Struct.new(
  :alias,
  :scraper_id,
  :arn,
  :role_arn,
  :status,
  :created_at,
  :last_modified_at,
  :tags,
  :status_reason,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end