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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationsignals/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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dependency_config ⇒ Types::DependencyConfig

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

Returns:



2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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>) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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:



2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

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

#metric_name ⇒ String

The name of the CloudWatch metric used as a service level indicator (SLI) for measuring service performance.

Returns:

  • (String) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

class ServiceLevelIndicatorMetricConfig < Struct.new(
  :key_attributes,
  :operation_name,
  :metric_type,
  :metric_name,
  :statistic,
  :period_seconds,
  :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.

Returns:

  • (String) 


2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 2884

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