Class: AWSCDK::ApplicationSignals::CfnServiceLevelObjective::MetricProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ApplicationSignals::CfnServiceLevelObjective::MetricProperty

Defined in:

application_signals/cfn_service_level_objective.rb

Overview

This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html

Instance Attribute Summary

• #dimensions ⇒ AWSCDK::IResolvable, ... readonly

  An array of one or more dimensions to use to define the metric that you want to use.

• #metric_name ⇒ String^? readonly

  The name of the metric to use.

• #namespace ⇒ String^? readonly

  The namespace of the metric.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(dimensions: nil, metric_name: nil, namespace: nil) ⇒ MetricProperty constructor

  A new instance of MetricProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(dimensions: nil, metric_name: nil, namespace: nil) ⇒ MetricProperty

Returns a new instance of MetricProperty.

Parameters:

• dimensions (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ApplicationSignals::CfnServiceLevelObjective::DimensionProperty>, nil) (defaults to: nil) —

  An array of one or more dimensions to use to define the metric that you want to use.

• metric_name (String, nil) (defaults to: nil) —

  The name of the metric to use.

• namespace (String, nil) (defaults to: nil) —

  The namespace of the metric.

# File 'application_signals/cfn_service_level_objective.rb', line 1212

def initialize(dimensions: nil, metric_name: nil, namespace: nil)
  @dimensions = dimensions
  Jsii::Type.check_type(@dimensions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbGljYXRpb25zaWduYWxzLkNmblNlcnZpY2VMZXZlbE9iamVjdGl2ZS5EaW1lbnNpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dimensions") unless @dimensions.nil?
  @metric_name = metric_name
  Jsii::Type.check_type(@metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName") unless @metric_name.nil?
  @namespace = namespace
  Jsii::Type.check_type(@namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespace") unless @namespace.nil?
end

Instance Attribute Details

#dimensions ⇒ AWSCDK::IResolvable, ... (readonly)

An array of one or more dimensions to use to define the metric that you want to use.

For more information, see Dimensions .

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ApplicationSignals::CfnServiceLevelObjective::DimensionProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-dimensions

# File 'application_signals/cfn_service_level_objective.rb', line 1227

def dimensions
  @dimensions
end

#metric_name ⇒ String^? (readonly)

The name of the metric to use.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-metricname

# File 'application_signals/cfn_service_level_objective.rb', line 1232

def metric_name
  @metric_name
end

#namespace ⇒ String^? (readonly)

The namespace of the metric.

For more information, see Namespaces .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-servicelevelobjective-metric.html#cfn-applicationsignals-servicelevelobjective-metric-namespace

# File 'application_signals/cfn_service_level_objective.rb', line 1239

def namespace
  @namespace
end

Class Method Details

.jsii_properties ⇒ Object

# File 'application_signals/cfn_service_level_objective.rb', line 1241

def self.jsii_properties
  {
    :dimensions => "dimensions",
    :metric_name => "metricName",
    :namespace => "namespace",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'application_signals/cfn_service_level_objective.rb', line 1249

def to_jsii
  result = {}
  result.merge!({
    "dimensions" => @dimensions,
    "metricName" => @metric_name,
    "namespace" => @namespace,
  })
  result.compact
end