Package software.amazon.awscdk.services.cloudwatch

Class CfnMetricStreamProps.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.CfnMetricStreamProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMetricStreamProps>
Enclosing interface:
CfnMetricStreamProps
@Stability(Stable) public static final class CfnMetricStreamProps.Builder extends Object implements software.amazon.jsii.Builder<CfnMetricStreamProps>
A builder for CfnMetricStreamProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • firehoseArn

      @Stability(Stable) public CfnMetricStreamProps.Builder firehoseArn(String firehoseArn)
      Sets the value of CfnMetricStreamProps.getFirehoseArn()
      Parameters:
      firehoseArn - The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This parameter is required. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
      Returns:
      this

    • outputFormat

      @Stability(Stable) public CfnMetricStreamProps.Builder outputFormat(String outputFormat)
      Sets the value of CfnMetricStreamProps.getOutputFormat()
      Parameters:
      outputFormat - The output format for the stream. This parameter is required. Valid values are json , opentelemetry1.0 and opentelemetry0.7 For more information about metric stream output formats, see Metric streams output formats .

      This parameter is required.

      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnMetricStreamProps.Builder roleArn(String roleArn)
      Sets the value of CfnMetricStreamProps.getRoleArn()
      Parameters:
      roleArn - The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This parameter is required. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the firehose:PutRecord and firehose:PutRecordBatch permissions.
      Returns:
      this

    • excludeFilters

      @Stability(Stable) public CfnMetricStreamProps.Builder excludeFilters(IResolvable excludeFilters)
      Sets the value of CfnMetricStreamProps.getExcludeFilters()
      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 specify both IncludeFilters and ExcludeFilters in the same metric stream.

      When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

      Returns:
      this

    • excludeFilters

      @Stability(Stable) public CfnMetricStreamProps.Builder excludeFilters(List<? extends Object> excludeFilters)
      Sets the value of CfnMetricStreamProps.getExcludeFilters()
      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 specify both IncludeFilters and ExcludeFilters in the same metric stream.

      When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

      Returns:
      this

    • includeFilters

      @Stability(Stable) public CfnMetricStreamProps.Builder includeFilters(IResolvable includeFilters)
      Sets the value of CfnMetricStreamProps.getIncludeFilters()
      Parameters:
      includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

      When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

      Returns:
      this

    • includeFilters

      @Stability(Stable) public CfnMetricStreamProps.Builder includeFilters(List<? extends Object> includeFilters)
      Sets the value of CfnMetricStreamProps.getIncludeFilters()
      Parameters:
      includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

      When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

      Returns:
      this

    • includeLinkedAccountsMetrics

      @Stability(Stable) public CfnMetricStreamProps.Builder includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)
      Sets the value of CfnMetricStreamProps.getIncludeLinkedAccountsMetrics()
      Parameters:
      includeLinkedAccountsMetrics - If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false .

      For more information about linking accounts, see CloudWatch cross-account observability

      Returns:
      this

    • includeLinkedAccountsMetrics

      @Stability(Stable) public CfnMetricStreamProps.Builder includeLinkedAccountsMetrics(IResolvable includeLinkedAccountsMetrics)
      Sets the value of CfnMetricStreamProps.getIncludeLinkedAccountsMetrics()
      Parameters:
      includeLinkedAccountsMetrics - If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false .

      For more information about linking accounts, see CloudWatch cross-account observability

      Returns:
      this

    • name

      @Stability(Stable) public CfnMetricStreamProps.Builder name(String name)
      Sets the value of CfnMetricStreamProps.getName()
      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.

      Returns:
      this

    • statisticsConfigurations

      @Stability(Stable) public CfnMetricStreamProps.Builder statisticsConfigurations(IResolvable statisticsConfigurations)
      Sets the value of CfnMetricStreamProps.getStatisticsConfigurations()
      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 OpenTelemetry, you can stream percentile statistics.

      Returns:
      this

    • statisticsConfigurations

      @Stability(Stable) public CfnMetricStreamProps.Builder statisticsConfigurations(List<? extends Object> statisticsConfigurations)
      Sets the value of CfnMetricStreamProps.getStatisticsConfigurations()
      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 OpenTelemetry, you can stream percentile statistics.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnMetricStreamProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnMetricStreamProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to the metric stream. For more information, see Tag .
      Returns:
      this

    • build

      @Stability(Stable) public CfnMetricStreamProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnMetricStreamProps>
      Returns:
      a new instance of CfnMetricStreamProps
      Throws:
      NullPointerException - if any required attribute was not provided