Menu
AWS Elastic Beanstalk
API Reference (API Version 2010-12-01)

CreateEnvironment

Launches an environment for the specified application using the specified configuration.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ApplicationName

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

CNAMEPrefix

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 63.

Required: No

Description

Describes this environment.

Type: String

Length Constraints: Maximum length of 200.

Required: No

EnvironmentName

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot 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, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 19.

Required: No

OptionSettings.member.N

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.

Type: Array of ConfigurationOptionSetting objects

Required: No

OptionsToRemove.member.N

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Type: Array of OptionSpecification objects

Required: No

PlatformArn

The ARN of the platform.

Type: String

Required: No

SolutionStackName

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Type: String

Required: No

Tags.member.N

This specifies the tags applied to resources in the environment.

Type: Array of Tag objects

Required: No

TemplateName

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

Tier

This specifies the tier to use for creating this environment.

Type: EnvironmentTier object

Required: No

VersionLabel

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

Response Elements

The following elements are returned by the service.

AbortableOperationInProgress

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

Type: Boolean

ApplicationName

The name of the application associated with this environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

CNAME

The URL to the CNAME for this environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

DateCreated

The creation date for this environment.

Type: Timestamp

DateUpdated

The last modified date for this environment.

Type: Timestamp

Description

Describes this environment.

Type: String

Length Constraints: Maximum length of 200.

EndpointURL

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

Type: String

EnvironmentArn

The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.

Type: String

EnvironmentId

The ID of this environment.

Type: String

EnvironmentLinks.member.N

A list of links to other environments in the same group.

Type: Array of EnvironmentLink objects

EnvironmentName

The name of this environment.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

  • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

  • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

  • Green: Indicates the environment is healthy and fully functional.

  • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

Type: String

Valid Values: Green | Yellow | Red | Grey

HealthStatus

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

Type: String

Valid Values: NoData | Unknown | Pending | Ok | Info | Warning | Degraded | Severe

PlatformArn

The ARN of the platform.

Type: String

Resources

The description of the AWS resources used by this environment.

Type: EnvironmentResourcesDescription object

SolutionStackName

The name of the SolutionStack deployed with this environment.

Type: String

Status

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • Updating: Environment is in the process of updating its configuration settings or application version.

  • Ready: Environment is available to have an action performed on it, such as update or terminate.

  • Terminating: Environment is in the shut-down process.

  • Terminated: Environment is not running.

Type: String

Valid Values: Launching | Updating | Ready | Terminating | Terminated

TemplateName

The name of the configuration template used to originally launch this environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Tier

Describes the current tier of this environment.

Type: EnvironmentTier object

VersionLabel

The application version deployed in this environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Errors

For information about the errors that are common to all actions, see Common Errors.

InsufficientPrivileges

The specified account does not have sufficient privileges for one of more AWS services.

HTTP Status Code: 403

TooManyEnvironments

The specified account has reached its limit of environments.

HTTP Status Code: 400

Example

Sample Request

Copy
https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp &EnvironmentName=SampleApp &SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207 &Description=EnvDescrip &Operation=CreateEnvironment &AuthParams

Sample Response

Copy
<CreateEnvironmentResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/"> <CreateEnvironmentResult> <VersionLabel>Version1</VersionLabel> <Status>Deploying</Status> <ApplicationName>SampleApp</ApplicationName> <Health>Grey</Health> <EnvironmentId>e-icsgecu3wf</EnvironmentId> <DateUpdated>2010-11-17T03:59:33.520Z</DateUpdated> <SolutionStackName>32bit Amazon Linux running Tomcat 7</SolutionStackName> <Description>EnvDescrip</Description> <EnvironmentName>SampleApp</EnvironmentName> <DateCreated>2010-11-17T03:59:33.520Z</DateCreated> </CreateEnvironmentResult> <ResponseMetadata> <RequestId>15db925e-f1ff-11df-8a78-9f77047e0d0c</RequestId> </ResponseMetadata> </CreateEnvironmentResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: