/*******************************************************************************
* 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
{
///
/// When you enable faster launching for a Windows AMI, images are pre-provisioned, using
/// snapshots to launch instances up to 65% faster. To create the optimized Windows image,
/// Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required.
/// Then it creates a set of reserved snapshots that are used for subsequent launches.
/// The reserved snapshots are automatically replenished as they are used, depending on
/// your settings for launch frequency.
///
///
/// To change these settings, you must own the AMI.
///
///
[Cmdlet("Enable", "EC2FastLaunch", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.EC2.Model.EnableFastLaunchResponse")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) EnableFastLaunch API operation.", Operation = new[] {"EnableFastLaunch"}, SelectReturnType = typeof(Amazon.EC2.Model.EnableFastLaunchResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.EnableFastLaunchResponse",
"This cmdlet returns an Amazon.EC2.Model.EnableFastLaunchResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EnableEC2FastLaunchCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter ImageId
///
///
/// The ID of the image for which you’re enabling faster launching.
///
///
#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 ImageId { get; set; }
#endregion
#region Parameter LaunchTemplate_LaunchTemplateId
///
///
/// The ID of the launch template to use for faster launching for a Windows AMI.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LaunchTemplate_LaunchTemplateId { get; set; }
#endregion
#region Parameter LaunchTemplate_LaunchTemplateName
///
///
/// The name of the launch template to use for faster launching for a Windows AMI.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LaunchTemplate_LaunchTemplateName { get; set; }
#endregion
#region Parameter MaxParallelLaunch
///
///
/// The maximum number of instances that Amazon EC2 can launch at the same time to create
/// pre-provisioned snapshots for Windows faster launching. Value must be 6
/// or greater.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxParallelLaunches")]
public System.Int32? MaxParallelLaunch { get; set; }
#endregion
#region Parameter ResourceType
///
///
/// The type of resource to use for pre-provisioning the Windows AMI for faster launching.
/// Supported values include: snapshot
, which is the default value.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ResourceType { get; set; }
#endregion
#region Parameter SnapshotConfiguration_TargetResourceCount
///
///
/// The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled
/// Windows AMI.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? SnapshotConfiguration_TargetResourceCount { get; set; }
#endregion
#region Parameter LaunchTemplate_Version
///
///
/// The version of the launch template to use for faster launching for a Windows AMI.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LaunchTemplate_Version { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.EnableFastLaunchResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.EnableFastLaunchResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ImageId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ImageId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ImageId' 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.ImageId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Enable-EC2FastLaunch (EnableFastLaunch)"))
{
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.ImageId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ImageId = this.ImageId;
#if MODULAR
if (this.ImageId == null && ParameterWasBound(nameof(this.ImageId)))
{
WriteWarning("You are passing $null as a value for parameter ImageId 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.LaunchTemplate_LaunchTemplateId = this.LaunchTemplate_LaunchTemplateId;
context.LaunchTemplate_LaunchTemplateName = this.LaunchTemplate_LaunchTemplateName;
context.LaunchTemplate_Version = this.LaunchTemplate_Version;
context.MaxParallelLaunch = this.MaxParallelLaunch;
context.ResourceType = this.ResourceType;
context.SnapshotConfiguration_TargetResourceCount = this.SnapshotConfiguration_TargetResourceCount;
// 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.EnableFastLaunchRequest();
if (cmdletContext.ImageId != null)
{
request.ImageId = cmdletContext.ImageId;
}
// populate LaunchTemplate
var requestLaunchTemplateIsNull = true;
request.LaunchTemplate = new Amazon.EC2.Model.FastLaunchLaunchTemplateSpecificationRequest();
System.String requestLaunchTemplate_launchTemplate_LaunchTemplateId = null;
if (cmdletContext.LaunchTemplate_LaunchTemplateId != null)
{
requestLaunchTemplate_launchTemplate_LaunchTemplateId = cmdletContext.LaunchTemplate_LaunchTemplateId;
}
if (requestLaunchTemplate_launchTemplate_LaunchTemplateId != null)
{
request.LaunchTemplate.LaunchTemplateId = requestLaunchTemplate_launchTemplate_LaunchTemplateId;
requestLaunchTemplateIsNull = false;
}
System.String requestLaunchTemplate_launchTemplate_LaunchTemplateName = null;
if (cmdletContext.LaunchTemplate_LaunchTemplateName != null)
{
requestLaunchTemplate_launchTemplate_LaunchTemplateName = cmdletContext.LaunchTemplate_LaunchTemplateName;
}
if (requestLaunchTemplate_launchTemplate_LaunchTemplateName != null)
{
request.LaunchTemplate.LaunchTemplateName = requestLaunchTemplate_launchTemplate_LaunchTemplateName;
requestLaunchTemplateIsNull = false;
}
System.String requestLaunchTemplate_launchTemplate_Version = null;
if (cmdletContext.LaunchTemplate_Version != null)
{
requestLaunchTemplate_launchTemplate_Version = cmdletContext.LaunchTemplate_Version;
}
if (requestLaunchTemplate_launchTemplate_Version != null)
{
request.LaunchTemplate.Version = requestLaunchTemplate_launchTemplate_Version;
requestLaunchTemplateIsNull = false;
}
// determine if request.LaunchTemplate should be set to null
if (requestLaunchTemplateIsNull)
{
request.LaunchTemplate = null;
}
if (cmdletContext.MaxParallelLaunch != null)
{
request.MaxParallelLaunches = cmdletContext.MaxParallelLaunch.Value;
}
if (cmdletContext.ResourceType != null)
{
request.ResourceType = cmdletContext.ResourceType;
}
// populate SnapshotConfiguration
var requestSnapshotConfigurationIsNull = true;
request.SnapshotConfiguration = new Amazon.EC2.Model.FastLaunchSnapshotConfigurationRequest();
System.Int32? requestSnapshotConfiguration_snapshotConfiguration_TargetResourceCount = null;
if (cmdletContext.SnapshotConfiguration_TargetResourceCount != null)
{
requestSnapshotConfiguration_snapshotConfiguration_TargetResourceCount = cmdletContext.SnapshotConfiguration_TargetResourceCount.Value;
}
if (requestSnapshotConfiguration_snapshotConfiguration_TargetResourceCount != null)
{
request.SnapshotConfiguration.TargetResourceCount = requestSnapshotConfiguration_snapshotConfiguration_TargetResourceCount.Value;
requestSnapshotConfigurationIsNull = false;
}
// determine if request.SnapshotConfiguration should be set to null
if (requestSnapshotConfigurationIsNull)
{
request.SnapshotConfiguration = null;
}
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.EnableFastLaunchResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.EnableFastLaunchRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "EnableFastLaunch");
try
{
#if DESKTOP
return client.EnableFastLaunch(request);
#elif CORECLR
return client.EnableFastLaunchAsync(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 ImageId { get; set; }
public System.String LaunchTemplate_LaunchTemplateId { get; set; }
public System.String LaunchTemplate_LaunchTemplateName { get; set; }
public System.String LaunchTemplate_Version { get; set; }
public System.Int32? MaxParallelLaunch { get; set; }
public System.String ResourceType { get; set; }
public System.Int32? SnapshotConfiguration_TargetResourceCount { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}