Class: Aws::PrometheusService::Types::UpdateScraperRequest

Inherits:

Struct

• Object
• Struct
• Aws::PrometheusService::Types::UpdateScraperRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias ⇒ String

  The new alias of the scraper.

• #client_token ⇒ String

  A unique identifier that you can provide to ensure the idempotency of the request.

• #destination ⇒ Types::Destination

  The new destination where the scraper sends metrics.

• #exporters ⇒ Array<Types::ExporterConfiguration>

  The exporter configurations for the scraper.

• #role_configuration ⇒ Types::RoleConfiguration

  Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

• #scrape_configuration ⇒ Types::ScrapeConfiguration

  Contains the base-64 encoded YAML configuration for the scraper.

• #scraper_id ⇒ String

  The ID of the scraper to update.

Instance Attribute Details

#alias ⇒ String

The new alias of the scraper.

Returns:

• (String)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::Destination

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

Returns:

• (Types::Destination)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#exporters ⇒ Array<Types::ExporterConfiguration>

The exporter configurations for the scraper. You can configure at most one exporter, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster. If you don't specify a value, the existing exporter configuration remains unchanged. Specify an empty list to remove the exporter.

Returns:

• (Array<Types::ExporterConfiguration>)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#role_configuration ⇒ Types::RoleConfiguration

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

Returns:

• (Types::RoleConfiguration)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#scrape_configuration ⇒ Types::ScrapeConfiguration

Contains the base-64 encoded YAML configuration for the scraper.

For more information about configuring a scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.

Returns:

• (Types::ScrapeConfiguration)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end

#scraper_id ⇒ String

The ID of the scraper to update.

Returns:

• (String)

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

class UpdateScraperRequest < Struct.new(
  :scraper_id,
  :alias,
  :scrape_configuration,
  :destination,
  :role_configuration,
  :client_token,
  :exporters)
  SENSITIVE = []
  include Aws::Structure
end