/*******************************************************************************
* 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.Lightsail;
using Amazon.Lightsail.Model;
namespace Amazon.PowerShell.Cmdlets.LS
{
///
/// Creates one or more new instances from a manual or automatic snapshot of an instance.
///
///
///
/// The create instances from snapshot
operation supports tag-based access
/// control via request tags and resource tags applied to the resource identified by instance
/// snapshot name
. For more information, see the Amazon
/// Lightsail Developer Guide.
///
///
[Cmdlet("New", "LSInstancesFromSnapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Lightsail.Model.Operation")]
[AWSCmdlet("Calls the Amazon Lightsail CreateInstancesFromSnapshot API operation.", Operation = new[] {"CreateInstancesFromSnapshot"}, SelectReturnType = typeof(Amazon.Lightsail.Model.CreateInstancesFromSnapshotResponse))]
[AWSCmdletOutput("Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.CreateInstancesFromSnapshotResponse",
"This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects.",
"The service call response (type Amazon.Lightsail.Model.CreateInstancesFromSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewLSInstancesFromSnapshotCmdlet : AmazonLightsailClientCmdlet, IExecutor
{
#region Parameter AddOn
///
///
/// An array of objects representing the add-ons to enable for the new instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AddOns")]
public Amazon.Lightsail.Model.AddOnRequest[] AddOn { get; set; }
#endregion
#region Parameter AttachedDiskMapping
///
///
/// An object containing information about one or more disk mappings.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Collections.Hashtable AttachedDiskMapping { get; set; }
#endregion
#region Parameter AvailabilityZone
///
///
/// The Availability Zone where you want to create your instances. Use the following formatting:
/// us-east-2a
(case sensitive). You can get a list of Availability Zones
/// by using the get
/// regions operation. Be sure to add the include Availability Zones
/// parameter to your request.
///
///
#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 AvailabilityZone { get; set; }
#endregion
#region Parameter BundleId
///
///
/// The bundle of specification information for your virtual private server (or instance),
/// including the pricing plan (e.g., micro_1_0
).
///
///
#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 BundleId { get; set; }
#endregion
#region Parameter InstanceName
///
///
/// The names for your new instances.
///
///
#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.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("InstanceNames")]
public System.String[] InstanceName { get; set; }
#endregion
#region Parameter InstanceSnapshotName
///
///
/// The name of the instance snapshot on which you are basing your new instances. Use
/// the get instance snapshots operation to return information about your existing snapshots.Constraint:- This parameter cannot be defined together with the
source instance name
/// parameter. The instance snapshot name
and source instance name
/// parameters are mutually exclusive.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceSnapshotName { get; set; }
#endregion
#region Parameter IpAddressType
///
///
/// The IP address type for the instance.The possible values are ipv4
for IPv4 only, and dualstack
/// for IPv4 and IPv6.The default value is dualstack
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Lightsail.IpAddressType")]
public Amazon.Lightsail.IpAddressType IpAddressType { get; set; }
#endregion
#region Parameter KeyPairName
///
///
/// The name for your key pair.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KeyPairName { get; set; }
#endregion
#region Parameter RestoreDate
///
///
/// The date of the automatic snapshot to use for the new instance. Use the get
/// auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:- Must be specified in
YYYY-MM-DD
format. - This parameter cannot be defined together with the
use latest restorable auto
/// snapshot
parameter. The restore date
and use latest restorable
/// auto snapshot
parameters are mutually exclusive. - Define this parameter only when creating a new instance from an automatic snapshot.
/// For more information, see the Amazon
/// Lightsail Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RestoreDate { get; set; }
#endregion
#region Parameter SourceInstanceName
///
///
/// The name of the source instance from which the source automatic snapshot was created.Constraints:- This parameter cannot be defined together with the
instance snapshot name
/// parameter. The source instance name
and instance snapshot name
/// parameters are mutually exclusive. - Define this parameter only when creating a new instance from an automatic snapshot.
/// For more information, see the Amazon
/// Lightsail Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SourceInstanceName { get; set; }
#endregion
#region Parameter Tag
///
///
/// The tag keys and optional values to add to the resource during create.Use the TagResource
action to tag a resource after it's created.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.Lightsail.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter UseLatestRestorableAutoSnapshot
///
///
/// A Boolean value to indicate whether to use the latest available automatic snapshot.Constraints:- This parameter cannot be defined together with the
restore date
parameter.
/// The use latest restorable auto snapshot
and restore date
/// parameters are mutually exclusive. - Define this parameter only when creating a new instance from an automatic snapshot.
/// For more information, see the Amazon
/// Lightsail Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? UseLatestRestorableAutoSnapshot { get; set; }
#endregion
#region Parameter UserData
///
///
/// You can create a launch script that configures a server with additional user data.
/// For example, apt-get -y update
.Depending on the machine image you choose, the command to get software on your instance
/// varies. Amazon Linux and CentOS use yum
, Debian and Ubuntu use apt-get
,
/// and FreeBSD uses pkg
. For a complete list, see the Amazon
/// Lightsail Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String UserData { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Operations'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.CreateInstancesFromSnapshotResponse).
/// Specifying the name of a property of type Amazon.Lightsail.Model.CreateInstancesFromSnapshotResponse 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; } = "Operations";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the InstanceName parameter.
/// The -PassThru parameter is deprecated, use -Select '^InstanceName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceName' 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.InstanceName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-LSInstancesFromSnapshot (CreateInstancesFromSnapshot)"))
{
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.InstanceName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.AddOn != null)
{
context.AddOn = new List(this.AddOn);
}
if (this.AttachedDiskMapping != null)
{
context.AttachedDiskMapping = new Dictionary>(StringComparer.Ordinal);
foreach (var hashKey in this.AttachedDiskMapping.Keys)
{
object hashValue = this.AttachedDiskMapping[hashKey];
if (hashValue == null)
{
context.AttachedDiskMapping.Add((String)hashKey, null);
continue;
}
var enumerable = SafeEnumerable(hashValue);
var valueSet = new List();
foreach (var s in enumerable)
{
valueSet.Add((Amazon.Lightsail.Model.DiskMap)s);
}
context.AttachedDiskMapping.Add((String)hashKey, valueSet);
}
}
context.AvailabilityZone = this.AvailabilityZone;
#if MODULAR
if (this.AvailabilityZone == null && ParameterWasBound(nameof(this.AvailabilityZone)))
{
WriteWarning("You are passing $null as a value for parameter AvailabilityZone 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.BundleId = this.BundleId;
#if MODULAR
if (this.BundleId == null && ParameterWasBound(nameof(this.BundleId)))
{
WriteWarning("You are passing $null as a value for parameter BundleId 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
if (this.InstanceName != null)
{
context.InstanceName = new List(this.InstanceName);
}
#if MODULAR
if (this.InstanceName == null && ParameterWasBound(nameof(this.InstanceName)))
{
WriteWarning("You are passing $null as a value for parameter InstanceName 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.InstanceSnapshotName = this.InstanceSnapshotName;
context.IpAddressType = this.IpAddressType;
context.KeyPairName = this.KeyPairName;
context.RestoreDate = this.RestoreDate;
context.SourceInstanceName = this.SourceInstanceName;
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.UseLatestRestorableAutoSnapshot = this.UseLatestRestorableAutoSnapshot;
context.UserData = this.UserData;
// 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.Lightsail.Model.CreateInstancesFromSnapshotRequest();
if (cmdletContext.AddOn != null)
{
request.AddOns = cmdletContext.AddOn;
}
if (cmdletContext.AttachedDiskMapping != null)
{
request.AttachedDiskMapping = cmdletContext.AttachedDiskMapping;
}
if (cmdletContext.AvailabilityZone != null)
{
request.AvailabilityZone = cmdletContext.AvailabilityZone;
}
if (cmdletContext.BundleId != null)
{
request.BundleId = cmdletContext.BundleId;
}
if (cmdletContext.InstanceName != null)
{
request.InstanceNames = cmdletContext.InstanceName;
}
if (cmdletContext.InstanceSnapshotName != null)
{
request.InstanceSnapshotName = cmdletContext.InstanceSnapshotName;
}
if (cmdletContext.IpAddressType != null)
{
request.IpAddressType = cmdletContext.IpAddressType;
}
if (cmdletContext.KeyPairName != null)
{
request.KeyPairName = cmdletContext.KeyPairName;
}
if (cmdletContext.RestoreDate != null)
{
request.RestoreDate = cmdletContext.RestoreDate;
}
if (cmdletContext.SourceInstanceName != null)
{
request.SourceInstanceName = cmdletContext.SourceInstanceName;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.UseLatestRestorableAutoSnapshot != null)
{
request.UseLatestRestorableAutoSnapshot = cmdletContext.UseLatestRestorableAutoSnapshot.Value;
}
if (cmdletContext.UserData != null)
{
request.UserData = cmdletContext.UserData;
}
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.Lightsail.Model.CreateInstancesFromSnapshotResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.CreateInstancesFromSnapshotRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "CreateInstancesFromSnapshot");
try
{
#if DESKTOP
return client.CreateInstancesFromSnapshot(request);
#elif CORECLR
return client.CreateInstancesFromSnapshotAsync(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 List AddOn { get; set; }
public Dictionary> AttachedDiskMapping { get; set; }
public System.String AvailabilityZone { get; set; }
public System.String BundleId { get; set; }
public List InstanceName { get; set; }
public System.String InstanceSnapshotName { get; set; }
public Amazon.Lightsail.IpAddressType IpAddressType { get; set; }
public System.String KeyPairName { get; set; }
public System.String RestoreDate { get; set; }
public System.String SourceInstanceName { get; set; }
public List Tag { get; set; }
public System.Boolean? UseLatestRestorableAutoSnapshot { get; set; }
public System.String UserData { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Operations;
}
}
}