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

Class PutMetricStreamRequest

    • Method Detail

      • name

        public final 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 "_".

        Returns:
        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 "_".

      • hasIncludeFilters

        public final boolean hasIncludeFilters()
        For responses, this returns true if the service returned a value for the IncludeFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • includeFilters

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeFilters() method.

        Returns:
        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.

      • hasExcludeFilters

        public final boolean hasExcludeFilters()
        For responses, this returns true if the service returned a value for the ExcludeFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • excludeFilters

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeFilters() method.

        Returns:
        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.

      • firehoseArn

        public final 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.

        Returns:
        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.

      • roleArn

        public final 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

        Returns:
        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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • hasStatisticsConfigurations

        public final boolean hasStatisticsConfigurations()
        For responses, this returns true if the service returned a value for the StatisticsConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • statisticsConfigurations

        public final List<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 opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatisticsConfigurations() method.

        Returns:
        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 opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

      • includeLinkedAccountsMetrics

        public final 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.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object