Package software.amazon.awssdk.services.cloudwatch.model

Interface PutMetricStreamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchRequest.Builder, CopyableBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>, SdkBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutMetricStreamRequest
public static interface PutMetricStreamRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>

  • Method Details

    • name

      PutMetricStreamRequest.Builder name(String name)

      If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

      If you are updating a metric stream, specify the name of that stream here.

      Valid characters are A-Z, a-z, 0-9, "-" and "_".

      Parameters:
      name - If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

      If you are updating a metric stream, specify the name of that stream here.

      Valid characters are A-Z, a-z, 0-9, "-" and "_".

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

    • includeFilters

      PutMetricStreamRequest.Builder includeFilters(Collection<MetricStreamFilter> includeFilters)

      If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

      Parameters:
      includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

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

    • includeFilters

      PutMetricStreamRequest.Builder includeFilters(MetricStreamFilter... includeFilters)

      If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

      Parameters:
      includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

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

    • includeFilters

      PutMetricStreamRequest.Builder includeFilters(Consumer<MetricStreamFilter.Builder>... includeFilters)

      If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

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

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

      Parameters:
      includeFilters - a consumer that will call methods on MetricStreamFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • excludeFilters

      PutMetricStreamRequest.Builder excludeFilters(Collection<MetricStreamFilter> excludeFilters)

      If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

      Parameters:
      excludeFilters - If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

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

    • excludeFilters

      PutMetricStreamRequest.Builder excludeFilters(MetricStreamFilter... excludeFilters)

      If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

      Parameters:
      excludeFilters - If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

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

    • excludeFilters

      PutMetricStreamRequest.Builder excludeFilters(Consumer<MetricStreamFilter.Builder>... excludeFilters)

      If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

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

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

      Parameters:
      excludeFilters - a consumer that will call methods on MetricStreamFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firehoseArn

      PutMetricStreamRequest.Builder firehoseArn(String firehoseArn)

      The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

      Parameters:
      firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      PutMetricStreamRequest.Builder roleArn(String roleArn)

      The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

      • firehose:PutRecord

      • firehose:PutRecordBatch

      Parameters:
      roleArn - The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

      • firehose:PutRecord

      • firehose:PutRecordBatch

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

    • outputFormat

      PutMetricStreamRequest.Builder outputFormat(String outputFormat)

      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      Parameters:
      outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7 . For more information about metric stream output formats, see Metric streams output formats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputFormat

      PutMetricStreamRequest.Builder outputFormat(MetricStreamOutputFormat outputFormat)

      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      Parameters:
      outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7 . For more information about metric stream output formats, see Metric streams output formats.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      PutMetricStreamRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

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

    • tags

      PutMetricStreamRequest.Builder tags(Tag... tags)

      A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

      Parameters:
      tags - A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

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

    • tags

      PutMetricStreamRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

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

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

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statisticsConfigurations

      PutMetricStreamRequest.Builder statisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> statisticsConfigurations)

      By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

      Parameters:
      statisticsConfigurations - By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

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

    • statisticsConfigurations

      PutMetricStreamRequest.Builder statisticsConfigurations(MetricStreamStatisticsConfiguration... statisticsConfigurations)

      By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

      Parameters:
      statisticsConfigurations - By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

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

    • statisticsConfigurations

      PutMetricStreamRequest.Builder statisticsConfigurations(Consumer<MetricStreamStatisticsConfiguration.Builder>... statisticsConfigurations)

      By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

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

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

      Parameters:
      statisticsConfigurations - a consumer that will call methods on MetricStreamStatisticsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeLinkedAccountsMetrics

      PutMetricStreamRequest.Builder includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)

      If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.

      Parameters:
      includeLinkedAccountsMetrics - If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutMetricStreamRequest.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

      PutMetricStreamRequest.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.