/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Lightsail;
using Amazon.Lightsail.Model;
namespace Amazon.PowerShell.Cmdlets.LS
{
///
/// Returns the data points for the specified Amazon Lightsail instance metric, given
/// an instance name.
///
///
///
/// Metrics report the utilization of your resources, and the error counts generated by
/// them. Monitor and collect metric data regularly to maintain the reliability, availability,
/// and performance of your resources.
///
///
[Cmdlet("Get", "LSInstanceMetricData")]
[OutputType("Amazon.Lightsail.Model.GetInstanceMetricDataResponse")]
[AWSCmdlet("Calls the Amazon Lightsail GetInstanceMetricData API operation.", Operation = new[] {"GetInstanceMetricData"}, SelectReturnType = typeof(Amazon.Lightsail.Model.GetInstanceMetricDataResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.GetInstanceMetricDataResponse",
"This cmdlet returns an Amazon.Lightsail.Model.GetInstanceMetricDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetLSInstanceMetricDataCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter EndTime
///
///
/// The end time of the time period.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? EndTime { get; set; }
#endregion
#region Parameter InstanceName
///
///
/// The name of the instance for which you want to get metrics data.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String InstanceName { get; set; }
#endregion
#region Parameter MetricName
///
///
/// The metric for which you want to return information.Valid instance metric names are listed below, along with the most useful statistics
/// to include in your request, and the published unit
value.BurstCapacityPercentage
- The percentage of CPU performance
/// available for your instance to burst above its baseline. Your instance continuously
/// accrues and consumes burst capacity. Burst capacity stops accruing when your instance's
/// BurstCapacityPercentage
reaches 100%. For more information, see Viewing
/// instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics are Maximum
and
/// Average
.Unit
: The published unit is Percent
.BurstCapacityTime
- The available amount of time for your instance
/// to burst at 100% CPU utilization. Your instance continuously accrues and consumes
/// burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage
/// metric reaches 100%.Burst capacity time is consumed at the full rate only when your instance operates
/// at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization
/// in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes
/// at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU
/// burst capacity minutes in the 5-minute period. For more information, see Viewing
/// instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics are Maximum
and
/// Average
.Unit
: The published unit is Seconds
.CPUUtilization
- The percentage of allocated compute units
/// that are currently in use on the instance. This metric identifies the processing power
/// to run the applications on the instance. Tools in your operating system can show a
/// lower percentage than Lightsail when the instance is not allocated a full processor
/// core.Statistics
: The most useful statistics are Maximum
and
/// Average
.Unit
: The published unit is Percent
.NetworkIn
- The number of bytes received on all network interfaces
/// by the instance. This metric identifies the volume of incoming network traffic to
/// the instance. The number reported is the number of bytes received during the period.
/// Because this metric is reported in 5-minute intervals, divide the reported number
/// by 300 to find Bytes/second.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Bytes
.NetworkOut
- The number of bytes sent out on all network interfaces
/// by the instance. This metric identifies the volume of outgoing network traffic from
/// the instance. The number reported is the number of bytes sent during the period. Because
/// this metric is reported in 5-minute intervals, divide the reported number by 300 to
/// find Bytes/second.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Bytes
.StatusCheckFailed
- Reports whether the instance passed or
/// failed both the instance status check and the system status check. This metric can
/// be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60
/// seconds) granularity.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.StatusCheckFailed_Instance
- Reports whether the instance passed
/// or failed the instance status check. This metric can be either 0 (passed) or 1 (failed).
/// This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.StatusCheckFailed_System
- Reports whether the instance passed
/// or failed the system status check. This metric can be either 0 (passed) or 1 (failed).
/// This metric data is available in 1-minute (60 seconds) granularity.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.MetadataNoToken
- Reports the number of times that the instance
/// metadata service was successfully accessed without a token. This metric determines
/// if there are any processes accessing instance metadata by using Instance Metadata
/// Service Version 1, which doesn't use a token. If all requests use token-backed sessions,
/// such as Instance Metadata Service Version 2, then the value is 0.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.Lightsail.InstanceMetricName")]
public Amazon.Lightsail.InstanceMetricName MetricName { get; set; }
#endregion
#region Parameter Period
///
///
/// The granularity, in seconds, of the returned data points.The StatusCheckFailed
, StatusCheckFailed_Instance
, and StatusCheckFailed_System
/// instance metric data is available in 1-minute (60 seconds) granularity. All other
/// instance metric data is available in 5-minute (300 seconds) granularity.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.Int32? Period { get; set; }
#endregion
#region Parameter StartTime
///
///
/// The start time of the time period.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? StartTime { get; set; }
#endregion
#region Parameter Statistic
///
///
/// 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.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("Statistics")]
public System.String[] Statistic { get; set; }
#endregion
#region Parameter Unit
///
///
/// The unit for the metric data request. Valid units depend on the metric data being
/// requested. For the valid units to specify with each available metric, see the metricName
/// parameter.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.Lightsail.MetricUnit")]
public Amazon.Lightsail.MetricUnit Unit { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.GetInstanceMetricDataResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.GetInstanceMetricDataResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the InstanceName parameter.
/// The -PassThru parameter is deprecated, use -Select '^InstanceName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.InstanceName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EndTime = this.EndTime;
#if MODULAR
if (this.EndTime == null && ParameterWasBound(nameof(this.EndTime)))
{
WriteWarning("You are passing $null as a value for parameter EndTime which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.InstanceName = this.InstanceName;
#if MODULAR
if (this.InstanceName == null && ParameterWasBound(nameof(this.InstanceName)))
{
WriteWarning("You are passing $null as a value for parameter InstanceName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.MetricName = this.MetricName;
#if MODULAR
if (this.MetricName == null && ParameterWasBound(nameof(this.MetricName)))
{
WriteWarning("You are passing $null as a value for parameter MetricName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.Period = this.Period;
#if MODULAR
if (this.Period == null && ParameterWasBound(nameof(this.Period)))
{
WriteWarning("You are passing $null as a value for parameter Period which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.StartTime = this.StartTime;
#if MODULAR
if (this.StartTime == null && ParameterWasBound(nameof(this.StartTime)))
{
WriteWarning("You are passing $null as a value for parameter StartTime which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.Statistic != null)
{
context.Statistic = new List(this.Statistic);
}
#if MODULAR
if (this.Statistic == null && ParameterWasBound(nameof(this.Statistic)))
{
WriteWarning("You are passing $null as a value for parameter Statistic which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.Unit = this.Unit;
#if MODULAR
if (this.Unit == null && ParameterWasBound(nameof(this.Unit)))
{
WriteWarning("You are passing $null as a value for parameter Unit which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.Lightsail.Model.GetInstanceMetricDataRequest();
if (cmdletContext.EndTime != null)
{
request.EndTime = cmdletContext.EndTime.Value;
}
if (cmdletContext.InstanceName != null)
{
request.InstanceName = cmdletContext.InstanceName;
}
if (cmdletContext.MetricName != null)
{
request.MetricName = cmdletContext.MetricName;
}
if (cmdletContext.Period != null)
{
request.Period = cmdletContext.Period.Value;
}
if (cmdletContext.StartTime != null)
{
request.StartTime = cmdletContext.StartTime.Value;
}
if (cmdletContext.Statistic != null)
{
request.Statistics = cmdletContext.Statistic;
}
if (cmdletContext.Unit != null)
{
request.Unit = cmdletContext.Unit;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Lightsail.Model.GetInstanceMetricDataResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.GetInstanceMetricDataRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "GetInstanceMetricData");
try
{
#if DESKTOP
return client.GetInstanceMetricData(request);
#elif CORECLR
return client.GetInstanceMetricDataAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.DateTime? EndTime { get; set; }
public System.String InstanceName { get; set; }
public Amazon.Lightsail.InstanceMetricName MetricName { get; set; }
public System.Int32? Period { get; set; }
public System.DateTime? StartTime { get; set; }
public List Statistic { get; set; }
public Amazon.Lightsail.MetricUnit Unit { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}