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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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, specifytrue
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(String outputFormat)
The output format for the stream.PutMetricStreamRequest.Builder
outputFormat(MetricStreamOutputFormat outputFormat)
The output format for the stream.PutMetricStreamRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutMetricStreamRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
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 theMAX
,MIN
,SUM
, andSAMPLECOUNT
statistics for each metric that is streamed.PutMetricStreamRequest.Builder
statisticsConfigurations(Consumer<MetricStreamStatisticsConfiguration.Builder>... statisticsConfigurations)
By default, a metric stream always sends theMAX
,MIN
,SUM
, andSAMPLECOUNT
statistics for each metric that is streamed.PutMetricStreamRequest.Builder
statisticsConfigurations(MetricStreamStatisticsConfiguration... statisticsConfigurations)
By default, a metric stream always sends theMAX
,MIN
,SUM
, andSAMPLECOUNT
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.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
-
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, sdkFields
-
-
-
-
Method Detail
-
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
andExcludeFilters
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
andExcludeFilters
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
andExcludeFilters
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
andExcludeFilters
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
This is a convenience method that creates an instance of theIncludeFilters
andExcludeFilters
in the same operation.MetricStreamFilter.Builder
avoiding the need to create one manually viaMetricStreamFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#includeFilters(List
.) - Parameters:
includeFilters
- a consumer that will call methods onMetricStreamFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#includeFilters(java.util.Collection
)
-
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
andIncludeFilters
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
andIncludeFilters
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
andIncludeFilters
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
andIncludeFilters
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
This is a convenience method that creates an instance of theExcludeFilters
andIncludeFilters
in the same operation.MetricStreamFilter.Builder
avoiding the need to create one manually viaMetricStreamFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#excludeFilters(List
.) - Parameters:
excludeFilters
- a consumer that will call methods onMetricStreamFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#excludeFilters(java.util.Collection
)
-
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
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.- Parameters:
outputFormat
- The output format for the stream. Valid values arejson
,opentelemetry1.0
, andopentelemetry0.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:
MetricStreamOutputFormat
,MetricStreamOutputFormat
-
outputFormat
PutMetricStreamRequest.Builder outputFormat(MetricStreamOutputFormat outputFormat)
The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.- Parameters:
outputFormat
- The output format for the stream. Valid values arejson
,opentelemetry1.0
, andopentelemetry0.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:
MetricStreamOutputFormat
,MetricStreamOutputFormat
-
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
statisticsConfigurations
PutMetricStreamRequest.Builder statisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> statisticsConfigurations)
By default, a metric stream always sends the
MAX
,MIN
,SUM
, andSAMPLECOUNT
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 theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If theOutputFormat
isopentelemetry1.0
oropentelemetry0.7
, you can stream percentile statistics such as p95, p99.9, and so on.- Parameters:
statisticsConfigurations
- By default, a metric stream always sends theMAX
,MIN
,SUM
, andSAMPLECOUNT
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 theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If theOutputFormat
isopentelemetry1.0
oropentelemetry0.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
, andSAMPLECOUNT
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 theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If theOutputFormat
isopentelemetry1.0
oropentelemetry0.7
, you can stream percentile statistics such as p95, p99.9, and so on.- Parameters:
statisticsConfigurations
- By default, a metric stream always sends theMAX
,MIN
,SUM
, andSAMPLECOUNT
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 theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If theOutputFormat
isopentelemetry1.0
oropentelemetry0.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
, andSAMPLECOUNT
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
This is a convenience method that creates an instance of theOutputFormat
. If theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If theOutputFormat
isopentelemetry1.0
oropentelemetry0.7
, you can stream percentile statistics such as p95, p99.9, and so on.MetricStreamStatisticsConfiguration.Builder
avoiding the need to create one manually viaMetricStreamStatisticsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#statisticsConfigurations(List
.) - Parameters:
statisticsConfigurations
- a consumer that will call methods onMetricStreamStatisticsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#statisticsConfigurations(java.util.Collection
)
-
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, specifytrue
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)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
PutMetricStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-