/******************************************************************************* * 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.EC2; using Amazon.EC2.Model; namespace Amazon.PowerShell.Cmdlets.EC2 { /// /// Download an Amazon Web Services-provided sample configuration file to be used with /// the customer gateway device specified for your Site-to-Site VPN connection. /// [Cmdlet("Get", "EC2VpnConnectionDeviceSampleConfiguration")] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) GetVpnConnectionDeviceSampleConfiguration API operation.", Operation = new[] {"GetVpnConnectionDeviceSampleConfiguration"}, SelectReturnType = typeof(Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse))] [AWSCmdletOutput("System.String or Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEC2VpnConnectionDeviceSampleConfigurationCmdlet : AmazonEC2ClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter InternetKeyExchangeVersion /// /// /// The IKE version to be used in the sample configuration file for your customer gateway /// device. You can specify one of the following versions: ikev1 or ikev2. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InternetKeyExchangeVersion { get; set; } #endregion #region Parameter VpnConnectionDeviceTypeId /// /// /// Device identifier provided by the GetVpnConnectionDeviceTypes API. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String VpnConnectionDeviceTypeId { get; set; } #endregion #region Parameter VpnConnectionId /// /// /// The VpnConnectionId specifies the Site-to-Site VPN connection used for /// the sample configuration. /// /// #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 VpnConnectionId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'VpnConnectionDeviceSampleConfiguration'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse). /// Specifying the name of a property of type Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse 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; } = "VpnConnectionDeviceSampleConfiguration"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the VpnConnectionId parameter. /// The -PassThru parameter is deprecated, use -Select '^VpnConnectionId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VpnConnectionId' 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.VpnConnectionId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.InternetKeyExchangeVersion = this.InternetKeyExchangeVersion; context.VpnConnectionDeviceTypeId = this.VpnConnectionDeviceTypeId; #if MODULAR if (this.VpnConnectionDeviceTypeId == null && ParameterWasBound(nameof(this.VpnConnectionDeviceTypeId))) { WriteWarning("You are passing $null as a value for parameter VpnConnectionDeviceTypeId 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.VpnConnectionId = this.VpnConnectionId; #if MODULAR if (this.VpnConnectionId == null && ParameterWasBound(nameof(this.VpnConnectionId))) { WriteWarning("You are passing $null as a value for parameter VpnConnectionId 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.EC2.Model.GetVpnConnectionDeviceSampleConfigurationRequest(); if (cmdletContext.InternetKeyExchangeVersion != null) { request.InternetKeyExchangeVersion = cmdletContext.InternetKeyExchangeVersion; } if (cmdletContext.VpnConnectionDeviceTypeId != null) { request.VpnConnectionDeviceTypeId = cmdletContext.VpnConnectionDeviceTypeId; } if (cmdletContext.VpnConnectionId != null) { request.VpnConnectionId = cmdletContext.VpnConnectionId; } 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.EC2.Model.GetVpnConnectionDeviceSampleConfigurationResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.GetVpnConnectionDeviceSampleConfigurationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "GetVpnConnectionDeviceSampleConfiguration"); try { #if DESKTOP return client.GetVpnConnectionDeviceSampleConfiguration(request); #elif CORECLR return client.GetVpnConnectionDeviceSampleConfigurationAsync(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 InternetKeyExchangeVersion { get; set; } public System.String VpnConnectionDeviceTypeId { get; set; } public System.String VpnConnectionId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.VpnConnectionDeviceSampleConfiguration; } } }