/*******************************************************************************
* 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.ElasticBeanstalk;
using Amazon.ElasticBeanstalk.Model;
namespace Amazon.PowerShell.Cmdlets.EB
{
///
/// Launches an AWS Elastic Beanstalk environment for the specified application using
/// the specified configuration.
///
[Cmdlet("New", "EBEnvironment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse")]
[AWSCmdlet("Calls the AWS Elastic Beanstalk CreateEnvironment API operation.", Operation = new[] {"CreateEnvironment"}, SelectReturnType = typeof(Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse))]
[AWSCmdletOutput("Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse",
"This cmdlet returns an Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewEBEnvironmentCmdlet : AmazonElasticBeanstalkClientCmdlet, IExecutor
{
#region Parameter ApplicationName
///
///
/// The name of the application that is associated with this environment.
///
///
#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 ApplicationName { get; set; }
#endregion
#region Parameter CNAMEPrefix
///
///
/// If specified, the environment attempts to use this value as the prefix for the CNAME
/// in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated
/// automatically by appending a random alphanumeric string to the environment name.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CNAMEPrefix { get; set; }
#endregion
#region Parameter Description
///
///
/// Your description for this environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter EnvironmentName
///
///
/// A unique name for the environment.Constraint: Must be from 4 to 40 characters in length. The name can contain only letters,
/// numbers, and hyphens. It can't start or end with a hyphen. This name must be unique
/// within a region in your account. If the specified name already exists in the region,
/// Elastic Beanstalk returns an InvalidParameterValue
error. If you don't specify the CNAMEPrefix
parameter, the environment name
/// becomes part of the CNAME, and therefore part of the visible URL for your application.
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public System.String EnvironmentName { get; set; }
#endregion
#region Parameter GroupName
///
///
/// The name of the group to which the target environment belongs. Specify a group name
/// only if the environment's name is specified in an environment manifest and not with
/// the environment name parameter. See Environment
/// Manifest (env.yaml) for details.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String GroupName { get; set; }
#endregion
#region Parameter Tier_Name
///
///
/// The name of this environment tier.Valid values:- For Web server tier –
WebServer
- For Worker tier –
Worker
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Tier_Name { get; set; }
#endregion
#region Parameter OperationsRole
///
///
/// The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's
/// operations role. If specified, Elastic Beanstalk uses the operations role for permissions
/// to downstream services during this call and during subsequent calls acting on this
/// environment. To specify an operations role, you must have the iam:PassRole
/// permission for the role. For more information, see Operations
/// roles in the AWS Elastic Beanstalk Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OperationsRole { get; set; }
#endregion
#region Parameter OptionSetting
///
///
/// If specified, AWS Elastic Beanstalk sets the specified configuration options to the
/// requested value in the configuration set for the new environment. These override the
/// values obtained from the solution stack or the configuration template.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("OptionSettings")]
public Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[] OptionSetting { get; set; }
#endregion
#region Parameter OptionsToRemove
///
///
/// A list of custom user-defined configuration options to remove from the configuration
/// set for this new environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.ElasticBeanstalk.Model.OptionSpecification[] OptionsToRemove { get; set; }
#endregion
#region Parameter PlatformArn
///
///
/// The Amazon Resource Name (ARN) of the custom platform to use with the environment.
/// For more information, see Custom
/// Platforms in the AWS Elastic Beanstalk Developer Guide.If you specify PlatformArn
, don't specify SolutionStackName
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PlatformArn { get; set; }
#endregion
#region Parameter SolutionStackName
///
///
/// The name of an Elastic Beanstalk solution stack (platform version) to use with the
/// environment. If specified, Elastic Beanstalk sets the configuration values to the
/// default values associated with the specified solution stack. For a list of current
/// solution stacks, see Elastic
/// Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.If you specify SolutionStackName
, don't specify PlatformArn
/// or TemplateName
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String SolutionStackName { get; set; }
#endregion
#region Parameter Tag
///
///
/// Specifies the tags applied to resources in the environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.ElasticBeanstalk.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter TemplateName
///
///
/// The name of the Elastic Beanstalk configuration template to use with the environment.If you specify TemplateName
, then don't specify SolutionStackName
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TemplateName { get; set; }
#endregion
#region Parameter Tier_Type
///
///
/// The type of this environment tier.Valid values:- For Web server tier –
Standard
- For Worker tier –
SQS/HTTP
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Tier_Type { get; set; }
#endregion
#region Parameter Tier_Version
///
///
/// The version of this environment tier. When you don't set a value to it, Elastic Beanstalk
/// uses the latest compatible worker tier version.This member is deprecated. Any specific version that you set may become out of date.
/// We recommend leaving it unspecified.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Tier_Version { get; set; }
#endregion
#region Parameter VersionLabel
///
///
/// The name of the application version to deploy.Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String VersionLabel { 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.ElasticBeanstalk.Model.CreateEnvironmentResponse).
/// Specifying the name of a property of type Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse 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 ApplicationName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ApplicationName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApplicationName' 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.ApplicationName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EBEnvironment (CreateEnvironment)"))
{
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.ApplicationName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ApplicationName = this.ApplicationName;
#if MODULAR
if (this.ApplicationName == null && ParameterWasBound(nameof(this.ApplicationName)))
{
WriteWarning("You are passing $null as a value for parameter ApplicationName 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.CNAMEPrefix = this.CNAMEPrefix;
context.Description = this.Description;
context.EnvironmentName = this.EnvironmentName;
context.GroupName = this.GroupName;
context.OperationsRole = this.OperationsRole;
if (this.OptionSetting != null)
{
context.OptionSetting = new List(this.OptionSetting);
}
if (this.OptionsToRemove != null)
{
context.OptionsToRemove = new List(this.OptionsToRemove);
}
context.PlatformArn = this.PlatformArn;
context.SolutionStackName = this.SolutionStackName;
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.TemplateName = this.TemplateName;
context.Tier_Name = this.Tier_Name;
context.Tier_Type = this.Tier_Type;
context.Tier_Version = this.Tier_Version;
context.VersionLabel = this.VersionLabel;
// 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.ElasticBeanstalk.Model.CreateEnvironmentRequest();
if (cmdletContext.ApplicationName != null)
{
request.ApplicationName = cmdletContext.ApplicationName;
}
if (cmdletContext.CNAMEPrefix != null)
{
request.CNAMEPrefix = cmdletContext.CNAMEPrefix;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.EnvironmentName != null)
{
request.EnvironmentName = cmdletContext.EnvironmentName;
}
if (cmdletContext.GroupName != null)
{
request.GroupName = cmdletContext.GroupName;
}
if (cmdletContext.OperationsRole != null)
{
request.OperationsRole = cmdletContext.OperationsRole;
}
if (cmdletContext.OptionSetting != null)
{
request.OptionSettings = cmdletContext.OptionSetting;
}
if (cmdletContext.OptionsToRemove != null)
{
request.OptionsToRemove = cmdletContext.OptionsToRemove;
}
if (cmdletContext.PlatformArn != null)
{
request.PlatformArn = cmdletContext.PlatformArn;
}
if (cmdletContext.SolutionStackName != null)
{
request.SolutionStackName = cmdletContext.SolutionStackName;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.TemplateName != null)
{
request.TemplateName = cmdletContext.TemplateName;
}
// populate Tier
var requestTierIsNull = true;
request.Tier = new Amazon.ElasticBeanstalk.Model.EnvironmentTier();
System.String requestTier_tier_Name = null;
if (cmdletContext.Tier_Name != null)
{
requestTier_tier_Name = cmdletContext.Tier_Name;
}
if (requestTier_tier_Name != null)
{
request.Tier.Name = requestTier_tier_Name;
requestTierIsNull = false;
}
System.String requestTier_tier_Type = null;
if (cmdletContext.Tier_Type != null)
{
requestTier_tier_Type = cmdletContext.Tier_Type;
}
if (requestTier_tier_Type != null)
{
request.Tier.Type = requestTier_tier_Type;
requestTierIsNull = false;
}
System.String requestTier_tier_Version = null;
if (cmdletContext.Tier_Version != null)
{
requestTier_tier_Version = cmdletContext.Tier_Version;
}
if (requestTier_tier_Version != null)
{
request.Tier.Version = requestTier_tier_Version;
requestTierIsNull = false;
}
// determine if request.Tier should be set to null
if (requestTierIsNull)
{
request.Tier = null;
}
if (cmdletContext.VersionLabel != null)
{
request.VersionLabel = cmdletContext.VersionLabel;
}
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.ElasticBeanstalk.Model.CreateEnvironmentResponse CallAWSServiceOperation(IAmazonElasticBeanstalk client, Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Elastic Beanstalk", "CreateEnvironment");
try
{
#if DESKTOP
return client.CreateEnvironment(request);
#elif CORECLR
return client.CreateEnvironmentAsync(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 ApplicationName { get; set; }
public System.String CNAMEPrefix { get; set; }
public System.String Description { get; set; }
public System.String EnvironmentName { get; set; }
public System.String GroupName { get; set; }
public System.String OperationsRole { get; set; }
public List OptionSetting { get; set; }
public List OptionsToRemove { get; set; }
public System.String PlatformArn { get; set; }
public System.String SolutionStackName { get; set; }
public List Tag { get; set; }
public System.String TemplateName { get; set; }
public System.String Tier_Name { get; set; }
public System.String Tier_Type { get; set; }
public System.String Tier_Version { get; set; }
public System.String VersionLabel { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}