Interface ServiceLevelIndicatorMetricConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ServiceLevelIndicatorMetricConfig.Builder,ServiceLevelIndicatorMetricConfig>, SdkBuilder<ServiceLevelIndicatorMetricConfig.Builder,ServiceLevelIndicatorMetricConfig>, SdkPojo
Enclosing class:
ServiceLevelIndicatorMetricConfig
@Mutable @NotThreadSafe public static interface ServiceLevelIndicatorMetricConfig.Builder extends SdkPojo, CopyableBuilder<ServiceLevelIndicatorMetricConfig.Builder,ServiceLevelIndicatorMetricConfig>

  • Method Details

    • keyAttributes

      ServiceLevelIndicatorMetricConfig.Builder keyAttributes(Map<String,String> keyAttributes)

      If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      Parameters:
      keyAttributes - If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationName

      ServiceLevelIndicatorMetricConfig.Builder operationName(String operationName)

      If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

      Parameters:
      operationName - If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricType

      ServiceLevelIndicatorMetricConfig.Builder metricType(String metricType)

      If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

      Parameters:
      metricType - If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricType

      ServiceLevelIndicatorMetricConfig.Builder metricType(ServiceLevelIndicatorMetricType metricType)

      If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

      Parameters:
      metricType - If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statistic

      ServiceLevelIndicatorMetricConfig.Builder statistic(String statistic)

      The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.

      Parameters:
      statistic - The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • periodSeconds

      ServiceLevelIndicatorMetricConfig.Builder periodSeconds(Integer periodSeconds)

      The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

      Parameters:
      periodSeconds - The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricDataQueries

      ServiceLevelIndicatorMetricConfig.Builder metricDataQueries(Collection<MetricDataQuery> metricDataQueries)

      If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

      Parameters:
      metricDataQueries - If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricDataQueries

      ServiceLevelIndicatorMetricConfig.Builder metricDataQueries(MetricDataQuery... metricDataQueries)

      If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

      Parameters:
      metricDataQueries - If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricDataQueries

      ServiceLevelIndicatorMetricConfig.Builder metricDataQueries(Consumer<MetricDataQuery.Builder>... metricDataQueries)

      If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.

      This is a convenience method that creates an instance of the MetricDataQuery.Builder avoiding the need to create one manually via MetricDataQuery.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricDataQueries(List<MetricDataQuery>).

      Parameters:
      metricDataQueries - a consumer that will call methods on MetricDataQuery.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dependencyConfig

      ServiceLevelIndicatorMetricConfig.Builder dependencyConfig(DependencyConfig dependencyConfig)

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

      Parameters:
      dependencyConfig - Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencyConfig

      default ServiceLevelIndicatorMetricConfig.Builder dependencyConfig(Consumer<DependencyConfig.Builder> dependencyConfig)

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

      This is a convenience method that creates an instance of the DependencyConfig.Builder avoiding the need to create one manually via DependencyConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dependencyConfig(DependencyConfig).

      Parameters:
      dependencyConfig - a consumer that will call methods on DependencyConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: