Class: Aws::PrometheusService::Types::CreateScraperRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb

Overview

Represents the input of a CreateScraper operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias ⇒ String

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

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

Returns:

  • (String) 


700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::Destination

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

Returns:



700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  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:



700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scrape_configuration ⇒ Types::ScrapeConfiguration

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

Returns:



700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::Source

The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.

Returns:



700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


700
701
702
703
704
705
706
707
708
709
710
 
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 700

class CreateScraperRequest < Struct.new(
  :alias,
  :scrape_configuration,
  :source,
  :destination,
  :role_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end