/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Lightsail::GetContainerServiceMetricData

NAME

Paws::Lightsail::GetContainerServiceMetricData - Arguments for method GetContainerServiceMetricData on Paws::Lightsail

DESCRIPTION

This class represents the parameters used for calling the method GetContainerServiceMetricData on the Amazon Lightsail service. Use the attributes of this class as arguments to method GetContainerServiceMetricData.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetContainerServiceMetricData.

SYNOPSIS

my $lightsail = Paws->service('Lightsail');
my $GetContainerServiceMetricDataResult =
  $lightsail->GetContainerServiceMetricData(
  EndTime     => '1970-01-01T01:00:00',
  MetricName  => 'CPUUtilization',
  Period      => 1,
  ServiceName => 'MyContainerServiceName',
  StartTime   => '1970-01-01T01:00:00',
  Statistics  => [
    'Minimum', ...    # values: Minimum, Maximum, Sum, Average, SampleCount
  ],

  );

# Results:
my $MetricData = $GetContainerServiceMetricDataResult->MetricData;
my $MetricName = $GetContainerServiceMetricDataResult->MetricName;

# Returns a L<Paws::Lightsail::GetContainerServiceMetricDataResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetContainerServiceMetricData

ATTRIBUTES

REQUIRED EndTime => Str

The end time of the time period.

REQUIRED MetricName => Str

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

  • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

    Statistics: The most useful statistics are Maximum and Average.

    Unit: The published unit is Percent.

Valid values are: "CPUUtilization", "MemoryUtilization"

REQUIRED Period => Int

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

REQUIRED ServiceName => Str

The name of the container service for which to get metric data.

REQUIRED StartTime => Str

The start time of the time period.

REQUIRED Statistics => ArrayRef[Str|Undef]

The statistic for the metric.

The following statistics are available:

  • Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

  • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

  • SampleCount - The count, or number, of data points used for the statistical calculation.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetContainerServiceMetricData in Paws::Lightsail

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues