/*******************************************************************************
* 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 information about health metrics for your Lightsail load balancer.
///
///
///
/// 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", "LSLoadBalancerMetricData")]
[OutputType("Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse")]
[AWSCmdlet("Calls the Amazon Lightsail GetLoadBalancerMetricData API operation.", Operation = new[] {"GetLoadBalancerMetricData"}, SelectReturnType = typeof(Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse",
"This cmdlet returns an Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetLSLoadBalancerMetricDataCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter EndTime
///
///
/// The end time of the 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 LoadBalancerName
///
///
/// The name of the load balancer.
///
///
#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 LoadBalancerName { get; set; }
#endregion
#region Parameter MetricName
///
///
/// The metric for which you want to return information.Valid load balancer metric names are listed below, along with the most useful statistics
/// to include in your request, and the published unit
value.ClientTLSNegotiationErrorCount
- The number of TLS connections
/// initiated by the client that did not establish a session with the load balancer due
/// to a TLS error generated by the load balancer. Possible causes include a mismatch
/// of ciphers or protocols.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.HealthyHostCount
- The number of target instances that are
/// considered healthy.Statistics
: The most useful statistic are Average
, Minimum
,
/// and Maximum
.Unit
: The published unit is Count
.HTTPCode_Instance_2XX_Count
- The number of HTTP 2XX response
/// codes generated by the target instances. This does not include any response codes
/// generated by the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.HTTPCode_Instance_3XX_Count
- The number of HTTP 3XX response
/// codes generated by the target instances. This does not include any response codes
/// generated by the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.HTTPCode_Instance_4XX_Count
- The number of HTTP 4XX response
/// codes generated by the target instances. This does not include any response codes
/// generated by the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.HTTPCode_Instance_5XX_Count
- The number of HTTP 5XX response
/// codes generated by the target instances. This does not include any response codes
/// generated by the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.HTTPCode_LB_4XX_Count
- The number of HTTP 4XX client error
/// codes that originated from the load balancer. Client errors are generated when requests
/// are malformed or incomplete. These requests were not received by the target instance.
/// This count does not include response codes generated by the target instances.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.HTTPCode_LB_5XX_Count
- The number of HTTP 5XX server error
/// codes that originated from the load balancer. This does not include any response codes
/// generated by the target instance. This metric is reported if there are no healthy
/// instances attached to the load balancer, or if the request rate exceeds the capacity
/// of the instances (spillover) or the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.InstanceResponseTime
- The time elapsed, in seconds, after
/// the request leaves the load balancer until a response from the target instance is
/// received.Statistics
: The most useful statistic is Average
.Unit
: The published unit is Seconds
.RejectedConnectionCount
- The number of connections that were
/// rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic is Sum
.Unit
: The published unit is Count
.RequestCount
- The number of requests processed over IPv4.
/// This count includes only the requests with a response generated by a target instance
/// of the load balancer.Statistics
: The most useful statistic is Sum
. Note that
/// Minimum
, Maximum
, and Average
all return 1
.Unit
: The published unit is Count
.UnhealthyHostCount
- The number of target instances that are
/// considered unhealthy.Statistics
: The most useful statistic are Average
, Minimum
,
/// and Maximum
.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.LoadBalancerMetricName")]
public Amazon.Lightsail.LoadBalancerMetricName MetricName { get; set; }
#endregion
#region Parameter Period
///
///
/// The granularity, in seconds, of the returned data points.
///
///
#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 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 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.GetLoadBalancerMetricDataResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.GetLoadBalancerMetricDataResponse 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 LoadBalancerName parameter.
/// The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' 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.LoadBalancerName;
}
#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.LoadBalancerName = this.LoadBalancerName;
#if MODULAR
if (this.LoadBalancerName == null && ParameterWasBound(nameof(this.LoadBalancerName)))
{
WriteWarning("You are passing $null as a value for parameter LoadBalancerName 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.GetLoadBalancerMetricDataRequest();
if (cmdletContext.EndTime != null)
{
request.EndTime = cmdletContext.EndTime.Value;
}
if (cmdletContext.LoadBalancerName != null)
{
request.LoadBalancerName = cmdletContext.LoadBalancerName;
}
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.GetLoadBalancerMetricDataResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.GetLoadBalancerMetricDataRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "GetLoadBalancerMetricData");
try
{
#if DESKTOP
return client.GetLoadBalancerMetricData(request);
#elif CORECLR
return client.GetLoadBalancerMetricDataAsync(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 LoadBalancerName { get; set; }
public Amazon.Lightsail.LoadBalancerMetricName 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;
}
}
}