/*******************************************************************************
* 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.Cloud9;
using Amazon.Cloud9.Model;
namespace Amazon.PowerShell.Cmdlets.C9
{
///
/// Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud
/// (Amazon EC2) instance, and then connects from the instance to the environment.
///
[Cmdlet("New", "C9EnvironmentEC2", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Cloud9 CreateEnvironmentEC2 API operation.", Operation = new[] {"CreateEnvironmentEC2"}, SelectReturnType = typeof(Amazon.Cloud9.Model.CreateEnvironmentEC2Response))]
[AWSCmdletOutput("System.String or Amazon.Cloud9.Model.CreateEnvironmentEC2Response",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.Cloud9.Model.CreateEnvironmentEC2Response) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewC9EnvironmentEC2Cmdlet : AmazonCloud9ClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter AutomaticStopTimeMinute
///
///
/// The number of minutes until the running instance is shut down after the environment
/// has last been used.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("AutomaticStopTimeMinutes")]
public System.Int32? AutomaticStopTimeMinute { get; set; }
#endregion
#region Parameter ClientRequestToken
///
///
/// A unique, case-sensitive string that helps Cloud9 to ensure this operation completes
/// no more than one time.For more information, see Client
/// Tokens in the Amazon EC2 API Reference.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientRequestToken { get; set; }
#endregion
#region Parameter ConnectionType
///
///
/// The connection type used for connecting to an Amazon EC2 environment. Valid values
/// are CONNECT_SSH
(default) and CONNECT_SSM
(connected through
/// Amazon EC2 Systems Manager).For more information, see Accessing
/// no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User
/// Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Cloud9.ConnectionType")]
public Amazon.Cloud9.ConnectionType ConnectionType { get; set; }
#endregion
#region Parameter Description
///
///
/// The description of the environment to create.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter DryRun
///
///
/// Checks whether you have the required permissions for the action, without actually
/// making the request, and provides an error response. If you have the required permissions,
/// the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? DryRun { get; set; }
#endregion
#region Parameter ImageId
///
///
/// The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
/// To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon
/// EC2 Systems Manager (SSM) path.The default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned
/// a value in the request. In the future the parameter for Amazon Linux will no longer be available when you
/// specify an AMI for your instance. Amazon Linux 2 will then become the default AMI,
/// which is used to launch your instance if no parameter is explicitly defined.AMI aliases - Amazon Linux (default):
amazonlinux-1-x86_64
- Amazon Linux 2:
amazonlinux-2-x86_64
- Ubuntu 18.04:
ubuntu-18.04-x86_64
SSM paths- Amazon Linux (default):
resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64
- Amazon Linux 2:
resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
- Ubuntu 18.04:
resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ImageId { get; set; }
#endregion
#region Parameter InstanceType
///
///
/// The type of instance to connect to the environment (for example, t2.micro
).
///
///
#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 InstanceType { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the environment to create.This name is visible to other IAM users in the same Amazon Web Services account.
///
///
#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 Name { get; set; }
#endregion
#region Parameter OwnerArn
///
///
/// The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of
/// any IAM principal. If this value is not specified, the ARN defaults to this environment's
/// creator.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OwnerArn { get; set; }
#endregion
#region Parameter SubnetId
///
///
/// The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon
/// EC2 instance.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SubnetId { get; set; }
#endregion
#region Parameter Tag
///
///
/// An array of key-value pairs that will be associated with the new Cloud9 development
/// environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.Cloud9.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Cloud9.Model.CreateEnvironmentEC2Response).
/// Specifying the name of a property of type Amazon.Cloud9.Model.CreateEnvironmentEC2Response 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; } = "EnvironmentId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Name parameter.
/// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-C9EnvironmentEC2 (CreateEnvironmentEC2)"))
{
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.Name;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AutomaticStopTimeMinute = this.AutomaticStopTimeMinute;
context.ClientRequestToken = this.ClientRequestToken;
context.ConnectionType = this.ConnectionType;
context.Description = this.Description;
context.DryRun = this.DryRun;
context.ImageId = this.ImageId;
context.InstanceType = this.InstanceType;
#if MODULAR
if (this.InstanceType == null && ParameterWasBound(nameof(this.InstanceType)))
{
WriteWarning("You are passing $null as a value for parameter InstanceType 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.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.OwnerArn = this.OwnerArn;
context.SubnetId = this.SubnetId;
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.Cloud9.Model.CreateEnvironmentEC2Request();
if (cmdletContext.AutomaticStopTimeMinute != null)
{
request.AutomaticStopTimeMinutes = cmdletContext.AutomaticStopTimeMinute.Value;
}
if (cmdletContext.ClientRequestToken != null)
{
request.ClientRequestToken = cmdletContext.ClientRequestToken;
}
if (cmdletContext.ConnectionType != null)
{
request.ConnectionType = cmdletContext.ConnectionType;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.DryRun != null)
{
request.DryRun = cmdletContext.DryRun.Value;
}
if (cmdletContext.ImageId != null)
{
request.ImageId = cmdletContext.ImageId;
}
if (cmdletContext.InstanceType != null)
{
request.InstanceType = cmdletContext.InstanceType;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.OwnerArn != null)
{
request.OwnerArn = cmdletContext.OwnerArn;
}
if (cmdletContext.SubnetId != null)
{
request.SubnetId = cmdletContext.SubnetId;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.Cloud9.Model.CreateEnvironmentEC2Response CallAWSServiceOperation(IAmazonCloud9 client, Amazon.Cloud9.Model.CreateEnvironmentEC2Request request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Cloud9", "CreateEnvironmentEC2");
try
{
#if DESKTOP
return client.CreateEnvironmentEC2(request);
#elif CORECLR
return client.CreateEnvironmentEC2Async(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.Int32? AutomaticStopTimeMinute { get; set; }
public System.String ClientRequestToken { get; set; }
public Amazon.Cloud9.ConnectionType ConnectionType { get; set; }
public System.String Description { get; set; }
public System.Boolean? DryRun { get; set; }
public System.String ImageId { get; set; }
public System.String InstanceType { get; set; }
public System.String Name { get; set; }
public System.String OwnerArn { get; set; }
public System.String SubnetId { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.EnvironmentId;
}
}
}