public static interface PutMetricStreamRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutMetricStreamRequest.Builder,PutMetricStreamRequest>
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
PutMetricStreamRequest.Builder |
firehoseArn(String firehoseArn)
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.
|
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.
|
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.
|
PutMetricStreamRequest.Builder |
includeFilters(MetricStreamFilter... includeFilters)
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify
here.
|
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. |
PutMetricStreamRequest.Builder |
name(String name)
If you are creating a new metric stream, this is the name for the new stream.
|
PutMetricStreamRequest.Builder |
outputFormat(MetricStreamOutputFormat outputFormat)
The output format for the stream.
|
PutMetricStreamRequest.Builder |
outputFormat(String outputFormat)
The output format for the stream.
|
PutMetricStreamRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutMetricStreamRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutMetricStreamRequest.Builder |
roleArn(String roleArn)
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources.
|
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. |
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. |
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. |
PutMetricStreamRequest.Builder |
tags(Collection<Tag> tags)
A list of key-value pairs to associate with the metric stream.
|
PutMetricStreamRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to associate with the metric stream.
|
PutMetricStreamRequest.Builder |
tags(Tag... tags)
A list of key-value pairs to associate with the metric stream.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
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 "_".
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 "_".
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.
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.
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.
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.
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.
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
.
includeFilters
- a consumer that will call methods on
MetricStreamFilter.Builder
#includeFilters(java.util.Collection)
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.
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.
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.
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.
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.
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
.
excludeFilters
- a consumer that will call methods on
MetricStreamFilter.Builder
#excludeFilters(java.util.Collection)
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.
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.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
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
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.
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.MetricStreamOutputFormat
,
MetricStreamOutputFormat
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.
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.MetricStreamOutputFormat
,
MetricStreamOutputFormat
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.
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.
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.
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.
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 theTag.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
.
tags
- a consumer that will call methods on
Tag.Builder
#tags(java.util.Collection)
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.
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.
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.
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.
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.
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
.
statisticsConfigurations
- a consumer that will call methods on
MetricStreamStatisticsConfiguration.Builder
#statisticsConfigurations(java.util.Collection)
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.
includeLinkedAccountsMetrics
- If you are creating a metric stream in a monitoring account, specify true
to include
metrics from source accounts in the metric stream.PutMetricStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutMetricStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.