Interface CreateScraperRequest.Builder

All Superinterfaces:

AmpRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateScraperRequest.Builder,CreateScraperRequest>, SdkBuilder<CreateScraperRequest.Builder,CreateScraperRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateScraperRequest

@Mutable
@NotThreadSafe
public static interface CreateScraperRequest.Builder
extends AmpRequest.Builder, SdkPojo, CopyableBuilder<CreateScraperRequest.Builder,CreateScraperRequest>

Method Summary

Modifier and Type	Method	Description
CreateScraperRequest.Builder	alias(String alias)	(optional) An alias to associate with the scraper.
CreateScraperRequest.Builder	clientToken(String clientToken)	(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
default CreateScraperRequest.Builder	destination(Consumer<Destination.Builder> destination)	The destination where the scraper sends the collected metrics.
CreateScraperRequest.Builder	destination(Destination destination)	The destination where the scraper sends the collected metrics.
CreateScraperRequest.Builder	exporters(Collection<ExporterConfiguration> exporters)	The exporter configurations for the scraper.
CreateScraperRequest.Builder	exporters(Consumer<ExporterConfiguration.Builder>... exporters)	The exporter configurations for the scraper.
CreateScraperRequest.Builder	exporters(ExporterConfiguration... exporters)	The exporter configurations for the scraper.
CreateScraperRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateScraperRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateScraperRequest.Builder	roleConfiguration(Consumer<RoleConfiguration.Builder> roleConfiguration)	Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
CreateScraperRequest.Builder	roleConfiguration(RoleConfiguration roleConfiguration)	Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
default CreateScraperRequest.Builder	scrapeConfiguration(Consumer<ScrapeConfiguration.Builder> scrapeConfiguration)	The configuration file to use in the new scraper.
CreateScraperRequest.Builder	scrapeConfiguration(ScrapeConfiguration scrapeConfiguration)	The configuration file to use in the new scraper.
default CreateScraperRequest.Builder	source(Consumer<Source.Builder> source)	The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.
CreateScraperRequest.Builder	source(Source source)	The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.
CreateScraperRequest.Builder	tags(Map<String,String> tags)	(Optional) The list of tag keys and values to associate with the scraper.

Methods inherited from interface software.amazon.awssdk.services.amp.model.AmpRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

alias

CreateScraperRequest.Builder alias(String alias)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

scrapeConfiguration

CreateScraperRequest.Builder scrapeConfiguration(ScrapeConfiguration 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

scrapeConfiguration

default CreateScraperRequest.Builder scrapeConfiguration(Consumer<ScrapeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the ScrapeConfiguration.Builder avoiding the need to create one manually via ScrapeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scrapeConfiguration(ScrapeConfiguration).

Parameters:

scrapeConfiguration - a consumer that will call methods on ScrapeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• scrapeConfiguration(ScrapeConfiguration)

source

CreateScraperRequest.Builder source(Source source)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

source

default CreateScraperRequest.Builder source(Consumer<Source.Builder> source)

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

This is a convenience method that creates an instance of the Source.Builder avoiding the need to create one manually via Source.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(Source).

Parameters:

source - a consumer that will call methods on Source.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• source(Source)

destination

CreateScraperRequest.Builder destination(Destination destination)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

destination

default CreateScraperRequest.Builder destination(Consumer<Destination.Builder> destination)

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

This is a convenience method that creates an instance of the Destination.Builder avoiding the need to create one manually via Destination.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(Destination).

Parameters:

destination - a consumer that will call methods on Destination.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• destination(Destination)

roleConfiguration

CreateScraperRequest.Builder roleConfiguration(RoleConfiguration roleConfiguration)

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

roleConfiguration

default CreateScraperRequest.Builder roleConfiguration(Consumer<RoleConfiguration.Builder> roleConfiguration)

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

This is a convenience method that creates an instance of the RoleConfiguration.Builder avoiding the need to create one manually via RoleConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to roleConfiguration(RoleConfiguration).

Parameters:

roleConfiguration - a consumer that will call methods on RoleConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• roleConfiguration(RoleConfiguration)

clientToken

CreateScraperRequest.Builder clientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateScraperRequest.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

exporters

CreateScraperRequest.Builder exporters(Collection<ExporterConfiguration> exporters)

The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

Parameters:

exporters - The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

exporters

CreateScraperRequest.Builder exporters(ExporterConfiguration... exporters)

The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

Parameters:

exporters - The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

exporters

CreateScraperRequest.Builder exporters(Consumer<ExporterConfiguration.Builder>... exporters)

The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

This is a convenience method that creates an instance of the ExporterConfiguration.Builder avoiding the need to create one manually via ExporterConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exporters(List<ExporterConfiguration>).

Parameters:

exporters - a consumer that will call methods on ExporterConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• exporters(java.util.Collection<ExporterConfiguration>)

overrideConfiguration

CreateScraperRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateScraperRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.