/*******************************************************************************
* 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.Route53RecoveryCluster;
using Amazon.Route53RecoveryCluster.Model;
namespace Amazon.PowerShell.Cmdlets.RRC
{
///
/// List routing control names and Amazon Resource Names (ARNs), as well as the routing
/// control state for each routing control, along with the control panel name and control
/// panel ARN for the routing controls. If you specify a control panel ARN, this call
/// lists the routing controls in the control panel. Otherwise, it lists all the routing
/// controls in the cluster.
///
///
///
/// A routing control is a simple on/off switch in Route 53 ARC that you can use to route
/// traffic to cells. When a routing control state is On, traffic flows to a cell. When
/// the state is Off, traffic does not flow.
///
/// Before you can create a routing control, you must first create a cluster, and then
/// host the control in a control panel on the cluster. For more information, see
/// Create routing control structures in the Amazon Route 53 Application Recovery
/// Controller Developer Guide. You access one of the endpoints for the cluster to get
/// or update the routing control state to redirect traffic for your application.
/// You must specify Regional endpoints when you work with API cluster operations
/// to use this API operation to list routing controls in Route 53 ARC.
/// Learn more about working with routing controls in the following topics in the Amazon
/// Route 53 Application Recovery Controller Developer Guide:
///
///
[Cmdlet("Get", "RRCRoutingControlList")]
[OutputType("Amazon.Route53RecoveryCluster.Model.RoutingControl")]
[AWSCmdlet("Calls the Route53 Recovery Cluster ListRoutingControls API operation.", Operation = new[] {"ListRoutingControls"}, SelectReturnType = typeof(Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse))]
[AWSCmdletOutput("Amazon.Route53RecoveryCluster.Model.RoutingControl or Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse",
"This cmdlet returns a collection of Amazon.Route53RecoveryCluster.Model.RoutingControl objects.",
"The service call response (type Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRRCRoutingControlListCmdlet : AmazonRoute53RecoveryClusterClientCmdlet, IExecutor
{
#region Parameter ControlPanelArn
///
///
/// The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String ControlPanelArn { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The number of routing controls objects that you want to return with this call. The
/// default value is 500.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The token for the next set of results. You receive this token from a previous call.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'RoutingControls'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse).
/// Specifying the name of a property of type Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse 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; } = "RoutingControls";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ControlPanelArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^ControlPanelArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ControlPanelArn' 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.ControlPanelArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ControlPanelArn = this.ControlPanelArn;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
// 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.Route53RecoveryCluster.Model.ListRoutingControlsRequest();
if (cmdletContext.ControlPanelArn != null)
{
request.ControlPanelArn = cmdletContext.ControlPanelArn;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
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.Route53RecoveryCluster.Model.ListRoutingControlsResponse CallAWSServiceOperation(IAmazonRoute53RecoveryCluster client, Amazon.Route53RecoveryCluster.Model.ListRoutingControlsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Route53 Recovery Cluster", "ListRoutingControls");
try
{
#if DESKTOP
return client.ListRoutingControls(request);
#elif CORECLR
return client.ListRoutingControlsAsync(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.String ControlPanelArn { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.RoutingControls;
}
}
}