AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Elastic Beanstalk CreateEnvironment API operation.

Syntax

New-EBEnvironment
-ApplicationName <String>
-EnvironmentName <String>
-CNAMEPrefix <String>
-Description <String>
-GroupName <String>
-Tier_Name <String>
-OperationsRole <String>
-OptionSetting <ConfigurationOptionSetting[]>
-OptionsToRemove <OptionSpecification[]>
-PlatformArn <String>
-SolutionStackName <String>
-Tag <Tag[]>
-TemplateName <String>
-Tier_Type <String>
-Tier_Version <String>
-VersionLabel <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticBeanstalkConfig>

Description

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Parameters

-ApplicationName <String>
The name of the application that is associated with this environment.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonElasticBeanstalkConfig>
Amazon.PowerShell.Cmdlets.EB.AmazonElasticBeanstalkClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CNAMEPrefix <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
Your description for this environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentName <String>
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.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OperationsRole <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OptionSetting <ConfigurationOptionSetting[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOptionSettings
-OptionsToRemove <OptionSpecification[]>
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PlatformArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SolutionStackName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Specifies the tags applied to resources in the environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TemplateName <String>
The name of the Elastic Beanstalk configuration template to use with the environment.If you specify TemplateName, then don't specify SolutionStackName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tier_Name <String>
The name of this environment tier.Valid values:
  • For Web server tier – WebServer
  • For Worker tier – Worker
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tier_Type <String>
The type of this environment tier.Valid values:
  • For Web server tier – Standard
  • For Worker tier – SQS/HTTP
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tier_Version <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VersionLabel <String>
The name of the application version to deploy.Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

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.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z