/*******************************************************************************
* 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.BackupGateway;
using Amazon.BackupGateway.Model;
namespace Amazon.PowerShell.Cmdlets.BUGW
{
///
/// Connect to a hypervisor by importing its configuration.
///
[Cmdlet("Import", "BUGWHypervisorConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Backup Gateway ImportHypervisorConfiguration API operation.", Operation = new[] {"ImportHypervisorConfiguration"}, SelectReturnType = typeof(Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse))]
[AWSCmdletOutput("System.String or Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class ImportBUGWHypervisorConfigurationCmdlet : AmazonBackupGatewayClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter HypervisorHost
///
///
/// The server host of the hypervisor. This can be either an IP address or a fully-qualified
/// domain name (FQDN).
///
///
#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]
[Alias("Host")]
public System.String HypervisorHost { get; set; }
#endregion
#region Parameter KmsKeyArn
///
///
/// The Key Management Service for the hypervisor.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KmsKeyArn { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the hypervisor.
///
///
#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 Name { get; set; }
#endregion
#region Parameter Password
///
///
/// The password for the hypervisor.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Password { get; set; }
#endregion
#region Parameter Tag
///
///
/// The tags of the hypervisor configuration to import.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.BackupGateway.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Username
///
///
/// The username for the hypervisor.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Username { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse).
/// Specifying the name of a property of type Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse 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; } = "HypervisorArn";
#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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Import-BUGWHypervisorConfiguration (ImportHypervisorConfiguration)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.HypervisorHost = this.HypervisorHost;
#if MODULAR
if (this.HypervisorHost == null && ParameterWasBound(nameof(this.HypervisorHost)))
{
WriteWarning("You are passing $null as a value for parameter HypervisorHost 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.KmsKeyArn = this.KmsKeyArn;
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.Password = this.Password;
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.Username = this.Username;
// 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.BackupGateway.Model.ImportHypervisorConfigurationRequest();
if (cmdletContext.HypervisorHost != null)
{
request.Host = cmdletContext.HypervisorHost;
}
if (cmdletContext.KmsKeyArn != null)
{
request.KmsKeyArn = cmdletContext.KmsKeyArn;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Password != null)
{
request.Password = cmdletContext.Password;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.BackupGateway.Model.ImportHypervisorConfigurationResponse CallAWSServiceOperation(IAmazonBackupGateway client, Amazon.BackupGateway.Model.ImportHypervisorConfigurationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Backup Gateway", "ImportHypervisorConfiguration");
try
{
#if DESKTOP
return client.ImportHypervisorConfiguration(request);
#elif CORECLR
return client.ImportHypervisorConfigurationAsync(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 HypervisorHost { get; set; }
public System.String KmsKeyArn { get; set; }
public System.String Name { get; set; }
public System.String Password { get; set; }
public List Tag { get; set; }
public System.String Username { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.HypervisorArn;
}
}
}