Class: Aws::ApplicationSignals::Types::ServiceLevelIndicatorMetricConfig

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationSignals::Types::ServiceLevelIndicatorMetricConfig

Includes:

Structure

Defined in:

lib/aws-sdk-applicationsignals/types.rb

Overview

Use this structure to specify the information for the metric that a period-based SLO will monitor.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dependency_config ⇒ Types::DependencyConfig

  Identifies the dependency using the ‘DependencyKeyAttributes` and `DependencyOperationName`.

• #key_attributes ⇒ Hash<String,String>

  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.

• #metric_data_queries ⇒ Array<Types::MetricDataQuery>

  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.

• #metric_name ⇒ String

  The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.

• #metric_source ⇒ Types::MetricSource

  Identifies the metric source for SLOs on resources other than Application Signals services.

• #metric_type ⇒ String

  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.

• #operation_name ⇒ String

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

• #period_seconds ⇒ Integer

  The number of seconds to use as the period for SLO evaluation.

• #statistic ⇒ String

  The statistic to use for comparison to the threshold.

Instance Attribute Details

#dependency_config ⇒ Types::DependencyConfig

Identifies the dependency using the ‘DependencyKeyAttributes` and `DependencyOperationName`.

Returns:

• (Types::DependencyConfig)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#key_attributes ⇒ Hash<String,String>

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:

• (Hash<String,String>)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#metric_data_queries ⇒ Array<Types::MetricDataQuery>

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:

• (Array<Types::MetricDataQuery>)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.

Returns:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#metric_source ⇒ Types::MetricSource

Identifies the metric source for SLOs on resources other than Application Signals services.

Returns:

• (Types::MetricSource)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#metric_type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#operation_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#period_seconds ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ String

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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html

Returns:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 3180

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :metric_source,
  :metric_data_queries,
  :dependency_config)
  SENSITIVE = []
  include Aws::Structure
end