/******************************************************************************* * 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 { /// /// Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified /// PEM or PPK format. Amazon EC2 stores the public key and displays the private key for /// you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 /// private key or an unencrypted PPK formatted private key for use with PuTTY. If a key /// with the specified name already exists, Amazon EC2 returns an error. /// /// /// /// The key pair returned to you is available only in the Amazon Web Services Region in /// which you create it. If you prefer, you can create your own key pair using a third-party /// tool and upload it to any Region using ImportKeyPair. /// /// You can have up to 5,000 key pairs per Amazon Web Services Region. /// /// For more information, see Amazon /// EC2 key pairs in the Amazon Elastic Compute Cloud User Guide. /// /// [Cmdlet("New", "EC2KeyPair", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.KeyPair")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateKeyPair API operation.", Operation = new[] {"CreateKeyPair"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateKeyPairResponse))] [AWSCmdletOutput("Amazon.EC2.Model.KeyPair or Amazon.EC2.Model.CreateKeyPairResponse", "This cmdlet returns an Amazon.EC2.Model.KeyPair object.", "The service call response (type Amazon.EC2.Model.CreateKeyPairResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2KeyPairCmdlet : AmazonEC2ClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter KeyFormat /// /// /// The format of the key pair.Default: pem /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.KeyFormat")] public Amazon.EC2.KeyFormat KeyFormat { get; set; } #endregion #region Parameter KeyName /// /// /// A unique name for the key pair.Constraints: Up to 255 ASCII characters /// /// #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 KeyName { get; set; } #endregion #region Parameter KeyType /// /// /// The type of key pair. Note that ED25519 keys are not supported for Windows instances.Default: rsa /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.KeyType")] public Amazon.EC2.KeyType KeyType { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to apply to the new key pair. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'KeyPair'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateKeyPairResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CreateKeyPairResponse 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; } = "KeyPair"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the KeyName parameter. /// The -PassThru parameter is deprecated, use -Select '^KeyName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.KeyName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2KeyPair (CreateKeyPair)")) { return; } 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.KeyName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.KeyFormat = this.KeyFormat; context.KeyName = this.KeyName; #if MODULAR if (this.KeyName == null && ParameterWasBound(nameof(this.KeyName))) { WriteWarning("You are passing $null as a value for parameter KeyName 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.KeyType = this.KeyType; if (this.TagSpecification != null) { context.TagSpecification = new List(this.TagSpecification); } // 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.CreateKeyPairRequest(); if (cmdletContext.KeyFormat != null) { request.KeyFormat = cmdletContext.KeyFormat; } if (cmdletContext.KeyName != null) { request.KeyName = cmdletContext.KeyName; } if (cmdletContext.KeyType != null) { request.KeyType = cmdletContext.KeyType; } if (cmdletContext.TagSpecification != null) { request.TagSpecifications = cmdletContext.TagSpecification; } 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.CreateKeyPairResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateKeyPairRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateKeyPair"); try { #if DESKTOP return client.CreateKeyPair(request); #elif CORECLR return client.CreateKeyPairAsync(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 Amazon.EC2.KeyFormat KeyFormat { get; set; } public System.String KeyName { get; set; } public Amazon.EC2.KeyType KeyType { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.KeyPair; } } }