Struct aws_sdk_cloudwatch::client::fluent_builders::PutMetricStream [−][src]
pub struct PutMetricStream<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to PutMetricStream
.
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions.
For more information, see Using Metric Streams.
To create a metric stream,
you must be logged on to an account that has the iam:PassRole
permission
and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
-
Stream metrics from all metric namespaces in the account.
-
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
ExcludeFilters
. -
Stream metrics from only the metric namespaces that you list in
IncludeFilters
.
When you use PutMetricStream
to create a new metric stream, the stream
is created in the running
state. If you use it to update an existing stream,
the state of the stream is not changed.
Implementations
impl<C, M, R> PutMetricStream<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> PutMetricStream<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<PutMetricStreamOutput, SdkError<PutMetricStreamError>> where
R::Policy: SmithyRetryPolicy<PutMetricStreamInputOperationOutputAlias, PutMetricStreamOutput, PutMetricStreamError, PutMetricStreamInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<PutMetricStreamOutput, SdkError<PutMetricStreamError>> where
R::Policy: SmithyRetryPolicy<PutMetricStreamInputOperationOutputAlias, PutMetricStreamOutput, PutMetricStreamError, PutMetricStreamInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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 "_".
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 "_".
Appends an item to IncludeFilters
.
To override the contents of this collection use set_include_filters
.
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.
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.
Appends an item to ExcludeFilters
.
To override the contents of this collection use set_exclude_filters
.
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.
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.
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis 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
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis 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
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.
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.
Appends an item to Tags
.
To override the contents of this collection use set_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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for PutMetricStream<C, M, R>
impl<C, M, R> Send for PutMetricStream<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for PutMetricStream<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for PutMetricStream<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for PutMetricStream<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more