/*******************************************************************************
* 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.IdentityManagement;
using Amazon.IdentityManagement.Model;
namespace Amazon.PowerShell.Cmdlets.IAM
{
///
/// Uploads an SSH public key and associates it with the specified IAM user.
///
///
///
/// The SSH public key uploaded by this operation can be used only for authenticating
/// the associated IAM user to an CodeCommit repository. For more information about using
/// SSH keys to authenticate to an CodeCommit repository, see Set
/// up CodeCommit for SSH connections in the CodeCommit User Guide.
///
///
[Cmdlet("Publish", "IAMSSHPublicKey", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.IdentityManagement.Model.SSHPublicKey")]
[AWSCmdlet("Calls the AWS Identity and Access Management UploadSSHPublicKey API operation.", Operation = new[] {"UploadSSHPublicKey"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.UploadSSHPublicKeyResponse))]
[AWSCmdletOutput("Amazon.IdentityManagement.Model.SSHPublicKey or Amazon.IdentityManagement.Model.UploadSSHPublicKeyResponse",
"This cmdlet returns an Amazon.IdentityManagement.Model.SSHPublicKey object.",
"The service call response (type Amazon.IdentityManagement.Model.UploadSSHPublicKeyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class PublishIAMSSHPublicKeyCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor
{
#region Parameter SSHPublicKeyBody
///
///
/// The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.
/// The minimum bit-length of the public key is 2048 bits. For example, you can generate
/// a 2048-bit key, and the resulting PEM file is 1679 bytes long.The regex pattern used to validate this
/// parameter is a string of characters consisting of the following:- Any printable ASCII character ranging from the space character (
\u0020
)
/// through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement character set (through
///
\u00FF
) - The special characters tab (
\u0009
), line feed (\u000A
),
/// and carriage return (\u000D
)
///
///
#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 SSHPublicKeyBody { get; set; }
#endregion
#region Parameter UserName
///
///
/// The name of the IAM user to associate the SSH public key with.This parameter allows (through its regex
/// pattern) a string of characters consisting of upper and lowercase alphanumeric
/// characters with no spaces. You can also include any of the following characters: _+=,.@-
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String UserName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'SSHPublicKey'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IdentityManagement.Model.UploadSSHPublicKeyResponse).
/// Specifying the name of a property of type Amazon.IdentityManagement.Model.UploadSSHPublicKeyResponse 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; } = "SSHPublicKey";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the SSHPublicKeyBody parameter.
/// The -PassThru parameter is deprecated, use -Select '^SSHPublicKeyBody' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SSHPublicKeyBody' 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.UserName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Publish-IAMSSHPublicKey (UploadSSHPublicKey)"))
{
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.SSHPublicKeyBody;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.SSHPublicKeyBody = this.SSHPublicKeyBody;
#if MODULAR
if (this.SSHPublicKeyBody == null && ParameterWasBound(nameof(this.SSHPublicKeyBody)))
{
WriteWarning("You are passing $null as a value for parameter SSHPublicKeyBody 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.UserName = this.UserName;
#if MODULAR
if (this.UserName == null && ParameterWasBound(nameof(this.UserName)))
{
WriteWarning("You are passing $null as a value for parameter UserName 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.IdentityManagement.Model.UploadSSHPublicKeyRequest();
if (cmdletContext.SSHPublicKeyBody != null)
{
request.SSHPublicKeyBody = cmdletContext.SSHPublicKeyBody;
}
if (cmdletContext.UserName != null)
{
request.UserName = cmdletContext.UserName;
}
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.IdentityManagement.Model.UploadSSHPublicKeyResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.UploadSSHPublicKeyRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "UploadSSHPublicKey");
try
{
#if DESKTOP
return client.UploadSSHPublicKey(request);
#elif CORECLR
return client.UploadSSHPublicKeyAsync(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 SSHPublicKeyBody { get; set; }
public System.String UserName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.SSHPublicKey;
}
}
}