Struct aws_sdk_lightsail::client::fluent_builders::GetContainerServiceMetricData

pub struct GetContainerServiceMetricData<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetContainerServiceMetricData.

Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

Implementations

impl<C, M, R> GetContainerServiceMetricData<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetContainerServiceMetricDataOutput, SdkError<GetContainerServiceMetricDataError>> where
    R::Policy: SmithyRetryPolicy<GetContainerServiceMetricDataInputOperationOutputAlias, GetContainerServiceMetricDataOutput, GetContainerServiceMetricDataError, GetContainerServiceMetricDataInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn service_name(self, inp: impl Into<String>) -> Self

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

pub fn set_service_name(self, input: Option<String>) -> Self

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

pub fn metric_name(self, inp: ContainerServiceMetricName) -> Self

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.

pub fn set_metric_name(self, input: Option<ContainerServiceMetricName>) -> Self

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.

pub fn start_time(self, inp: DateTime) -> Self

The start time of the time period.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The start time of the time period.

pub fn end_time(self, inp: DateTime) -> Self

The end time of the time period.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end time of the time period.

pub fn period(self, inp: i32) -> Self

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

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

pub fn set_period(self, input: Option<i32>) -> Self

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

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

pub fn statistics(self, inp: impl Into<MetricStatistic>) -> Self

Appends an item to statistics.

To override the contents of this collection use set_statistics.

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.

pub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetContainerServiceMetricData<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.