Package software.amazon.awscdk.services.cloudwatch

Class SearchExpressionProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.SearchExpressionProps.Jsii$Proxy
All Implemented Interfaces:
SearchExpressionOptions, SearchExpressionProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
SearchExpressionProps
@Stability(Stable) @Internal public static final class SearchExpressionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SearchExpressionProps
An implementation for SearchExpressionProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.SearchExpressionProps

    SearchExpressionProps.Builder, SearchExpressionProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(SearchExpressionProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the SearchExpressionProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getColor()
    Color for the metric produced by the search expression.
    final String
    getExpression()
    The search expression defining the metrics to be retrieved.
    final String
    getLabel()
    Label for this search expression when added to a Graph in a Dashboard.
    final Duration
    getPeriod()
    The period over which the search expression's statistics are applied.
    final String
    getSearchAccount()
    Account to evaluate search expressions within.
    final String
    getSearchRegion()
    Region to evaluate search expressions within.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(SearchExpressionProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the SearchExpressionProps.Builder.

  • Method Details

    • getExpression

      public final String getExpression()
      Description copied from interface: SearchExpressionProps
      The search expression defining the metrics to be retrieved.

      A search expression cannot be used within an Alarm.

      A search expression allows you to retrieve and graph multiple related metrics in a single statement. It can return up to 500 time series.

      Examples:

      • SEARCH('{AWS/EC2,InstanceId} CPUUtilization', 'Average', 300)
      • SEARCH('{AWS/ApplicationELB,LoadBalancer} RequestCount', 'Sum', 60)
      • SEARCH('{MyNamespace,ServiceName} Errors', 'Sum')

      For more information about search expression syntax, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html

      Specified by:
      getExpression in interface SearchExpressionProps

    • getColor

      public final String getColor()
      Description copied from interface: SearchExpressionOptions
      Color for the metric produced by the search expression.

      If the search expression produces more than one time series, the color is assigned to the first one. Other metrics are assigned colors automatically.

      Default: - Automatically assigned.

      Specified by:
      getColor in interface SearchExpressionOptions

    • getLabel

      public final String getLabel()
      Description copied from interface: SearchExpressionOptions
      Label for this search expression when added to a Graph in a Dashboard.

      If this expression evaluates to more than one time series, each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

      You can use dynamic labels to show summary information about the displayed time series in the legend. For example, if you use: 

       [max: ${MAX}] MyMetric

      As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. If the search expression produces more than one time series, the maximum will be shown for each individual time series produce by this search expression.

      Default: - No label.

      Specified by:
      getLabel in interface SearchExpressionOptions

    • getPeriod

      public final Duration getPeriod()
      Description copied from interface: SearchExpressionOptions
      The period over which the search expression's statistics are applied.

      This period overrides the period defined within the search expression.

      Default: Duration.minutes(5)

      Specified by:
      getPeriod in interface SearchExpressionOptions

    • getSearchAccount

      public final String getSearchAccount()
      Description copied from interface: SearchExpressionOptions
      Account to evaluate search expressions within.

      Default: - Deployment account.

      Specified by:
      getSearchAccount in interface SearchExpressionOptions

    • getSearchRegion

      public final String getSearchRegion()
      Description copied from interface: SearchExpressionOptions
      Region to evaluate search expressions within.

      Default: - Deployment region.

      Specified by:
      getSearchRegion in interface SearchExpressionOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object