/*******************************************************************************
* 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
{
/// <summary>
/// Get the state for a routing control. A routing control is a simple on/off switch 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.
///
///
/// <para>
/// 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 <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
/// Create routing control structures</a> 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.
/// </para><para><i>You must specify Regional endpoints when you work with API cluster operations
/// to get or update routing control states in Route 53 ARC.</i></para><para>
/// To see a code example for getting a routing control state, including accessing Regional
/// cluster endpoints in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API
/// examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
/// </para><para>
/// Learn more about working with routing controls in the following topics in the Amazon
/// Route 53 Application Recovery Controller Developer Guide:
/// </para><ul><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
/// Viewing and updating routing control states</a></para></li><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working
/// with routing controls in Route 53 ARC</a></para></li></ul>
/// </summary>
[Cmdlet("Get", "RRCRoutingControlState")]
[OutputType("Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse")]
[AWSCmdlet("Calls the Route53 Recovery Cluster GetRoutingControlState API operation.", Operation = new[] {"GetRoutingControlState"}, SelectReturnType = typeof(Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse))]
[AWSCmdletOutput("Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse",
"This cmdlet returns an Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetRRCRoutingControlStateCmdlet : AmazonRoute53RecoveryClusterClientCmdlet, IExecutor
{
#region Parameter RoutingControlArn
/// <summary>
/// <para>
/// <para>The Amazon Resource Name (ARN) for the routing control that you want to get the state
/// for.</para>
/// </para>
/// </summary>
#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 RoutingControlArn { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// 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.Route53RecoveryCluster.Model.GetRoutingControlStateResponse).
/// Specifying the name of a property of type Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the RoutingControlArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^RoutingControlArn' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RoutingControlArn' 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<Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse, GetRRCRoutingControlStateCmdlet>(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.RoutingControlArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.RoutingControlArn = this.RoutingControlArn;
#if MODULAR
if (this.RoutingControlArn == null && ParameterWasBound(nameof(this.RoutingControlArn)))
{
WriteWarning("You are passing $null as a value for parameter RoutingControlArn 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.Route53RecoveryCluster.Model.GetRoutingControlStateRequest();
if (cmdletContext.RoutingControlArn != null)
{
request.RoutingControlArn = cmdletContext.RoutingControlArn;
}
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.GetRoutingControlStateResponse CallAWSServiceOperation(IAmazonRoute53RecoveryCluster client, Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Route53 Recovery Cluster", "GetRoutingControlState");
try
{
#if DESKTOP
return client.GetRoutingControlState(request);
#elif CORECLR
return client.GetRoutingControlStateAsync(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 RoutingControlArn { get; set; }
public System.Func<Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse, GetRRCRoutingControlStateCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}