<a id="cli-aws-elasticbeanstalk-create-environment"></a>

# create-environment

## Description

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

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateEnvironment)

## Synopsis

```
  create-environment
--application-name <value>
[--environment-name <value>]
[--group-name <value>]
[--description <value>]
[--cname-prefix <value>]
[--tier <value>]
[--tags <value>]
[--version-label <value>]
[--template-name <value>]
[--solution-stack-name <value>]
[--platform-arn <value>]
[--option-settings <value>]
[--options-to-remove <value>]
[--operations-role <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--application-name` (string) [required]

> The name of the application that is associated with this environment.

> Constraints:

> * min: `1`
> * max: `100`

`--environment-name` (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.

> Constraints:

> * min: `4`
> * max: `40`

`--group-name` (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)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.

> Constraints:

> * min: `1`
> * max: `19`

`--description` (string)

> Your description for this environment.

> Constraints:

> * max: `200`

`--cname-prefix` (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.

> Constraints:

> * min: `4`
> * max: `63`

`--tier` (structure)

> Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources on Amazon EC2 instances or on an Amazon EKS cluster, and, for Amazon EC2, whether the environment serves HTTP(S) requests or processes background tasks from a queue.

> Name -> (string)

> > The name of this environment tier.

> > Valid values:

> > * For *Standard-mode EC2-based web server* – `WebServer`
> > * For *Standard-mode EC2-based backend application with Amazon SQS* – `Worker`
> > * For *Cluster-mode Amazon EKS-based applications* – `Cluster`

> Type -> (string)

> > The type of this environment tier.

> > Valid values:

> > * For *Web server tier* – `Standard`
> > * For *Worker tier* – `SQS/HTTP`
> > * For *Cluster tier* – `EKS`

> 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.

> > #### NOTE
> > This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

Shorthand Syntax:

```
Name=string,Type=string,Version=string
```

JSON Syntax:

```json
{
  "Name": "string",
  "Type": "string",
  "Version": "string"
}
```

`--tags` (list)

> Specifies the tags applied to resources in the environment.

> (structure)

> > Describes a tag applied to a resource in an environment.

> > Key -> (string)

> > > The key of the tag.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > Value -> (string)

> > > The value of the tag.

> > > Constraints:

> > > * min: `1`
> > > * max: `256`

Shorthand Syntax:

```
Key=string,Value=string ...
```

JSON Syntax:

```json
[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]
```

`--version-label` (string)

> The name of the application version to deploy.

> Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

> Constraints:

> * min: `1`
> * max: `100`

`--template-name` (string)

> The name of the Elastic Beanstalk configuration template to use with the environment.

> #### NOTE
> If you specify `TemplateName` , then don’t specify `SolutionStackName` .

> Constraints:

> * min: `1`
> * max: `100`

`--solution-stack-name` (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](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html) in the *Elastic Beanstalk Platforms* guide.

> #### NOTE
> If you specify `SolutionStackName` , don’t specify `PlatformArn` or `TemplateName` .

`--platform-arn` (string)

> The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the *Elastic Beanstalk Developer Guide* .

> #### NOTE
> If you specify `PlatformArn` , don’t specify `SolutionStackName` .

`--option-settings` (list)

> If specified, 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.

> (structure)

> > A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *Elastic Beanstalk Developer Guide* .

> > ResourceName -> (string)

> > > A unique resource name for the option setting. Use it for a time–based scaling configuration option.

> > > Constraints:

> > > * min: `1`
> > > * max: `256`

> > Namespace -> (string)

> > > A unique namespace that identifies the option’s associated Amazon Web Services resource.

> > OptionName -> (string)

> > > The name of the configuration option.

> > Value -> (string)

> > > The current value for the configuration option.

Shorthand Syntax:

```
ResourceName=string,Namespace=string,OptionName=string,Value=string ...
```

JSON Syntax:

```json
[
  {
    "ResourceName": "string",
    "Namespace": "string",
    "OptionName": "string",
    "Value": "string"
  }
  ...
]
```

`--options-to-remove` (list)

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

> (structure)

> > A specification identifying an individual configuration option.

> > ResourceName -> (string)

> > > A unique resource name for a time-based scaling configuration option.

> > > Constraints:

> > > * min: `1`
> > > * max: `256`

> > Namespace -> (string)

> > > A unique namespace identifying the option’s associated Amazon Web Services resource.

> > OptionName -> (string)

> > > The name of the configuration option.

Shorthand Syntax:

```
ResourceName=string,Namespace=string,OptionName=string ...
```

JSON Syntax:

```json
[
  {
    "ResourceName": "string",
    "Namespace": "string",
    "OptionName": "string"
  }
  ...
]
```

`--operations-role` (string)

> #### WARNING
> The operations role feature of Elastic Beanstalk is in beta release and is subject to change.

> 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.

> Constraints:

> * min: `1`
> * max: `256`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To create a new environment for an application**

The following `create-environment` example creates a new environment for version “v1” of a java application named “my-app”.

```bash
aws elasticbeanstalk create-environment \
    --application-name my-app \
    --environment-name my-env \
    --cname-prefix my-app \
    --version-label v1 \
    --solution-stack-name "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
```

Output:

```json
{
    "ApplicationName": "my-app",
    "EnvironmentName": "my-env",
    "VersionLabel": "v1",
    "Status": "Launching",
    "EnvironmentId": "e-izqpassy4h",
    "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
    "CNAME": "my-app.elasticbeanstalk.com",
    "Health": "Grey",
    "Tier": {
        "Type": "Standard",
        "Name": "WebServer",
        "Version": " "
    },
    "DateUpdated": "2015-02-03T23:04:54.479Z",
    "DateCreated": "2015-02-03T23:04:54.479Z"
}
```

`v1` is the label of an application version previously uploaded with [create-application-version](https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/create-application-version.html).

For more information, see [Creating an Elastic Beanstalk environment](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.environments.html) in the *AWS Elastic Beanstalk Developer Guide*.

**Example 2: To specify a JSON file to define environment configuration options**

The following `create-environment` example specifies that a JSON file with the name `myoptions.json` should be used to override values obtained from the solution stack or the configuration template.

```bash
aws elasticbeanstalk create-environment \
    --environment-name sample-env \
    --application-name sampleapp \
    --option-settings file://myoptions.json
```

`myoptions.json` is a JSON object defining several settings.

Contents of `myoptions.json`:

```json
[
    {
        "Namespace": "aws:elb:healthcheck",
        "OptionName": "Interval",
        "Value": "15"
    },
    {
        "Namespace": "aws:elb:healthcheck",
        "OptionName": "Timeout",
        "Value": "8"
    },
    {
        "Namespace": "aws:elb:healthcheck",
        "OptionName": "HealthyThreshold",
        "Value": "2"
    },
    {
        "Namespace": "aws:elb:healthcheck",
        "OptionName": "UnhealthyThreshold",
        "Value": "3"
    }
]
```

Output:

```json
{
    "ApplicationName": "sampleapp",
    "EnvironmentName": "sample-env",
    "Status": "Launching",
    "EnvironmentId": "e-a1b2c3d4e5",
    "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8",
    "Health": "Grey",
    "Tier": {
        "Type": "Standard",
        "Name": "WebServer",
        "Version": " "
    },
    "DateUpdated": "2015-02-03T23:04:54.479Z",
    "DateCreated": "2015-02-03T23:04:54.479Z"
}
```

For more information, see [Configuration options](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the *AWS Elastic Beanstalk Developer Guide*.

## Output

EnvironmentName -> (string)

> The name of this environment.

> Constraints:

> * min: `4`
> * max: `40`

EnvironmentId -> (string)

> The ID of this environment.

ApplicationName -> (string)

> The name of the application associated with this environment.

> Constraints:

> * min: `1`
> * max: `100`

VersionLabel -> (string)

> The application version deployed in this environment.

> Constraints:

> * min: `1`
> * max: `100`

SolutionStackName -> (string)

> The name of the `SolutionStack` deployed with this environment.

PlatformArn -> (string)

> The ARN of the platform version.

TemplateName -> (string)

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

> Constraints:

> * min: `1`
> * max: `100`

Description -> (string)

> Describes this environment.

> Constraints:

> * max: `200`

EndpointURL -> (string)

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

CNAME -> (string)

> The URL to the CNAME for this environment.

> Constraints:

> * min: `1`
> * max: `255`

DateCreated -> (timestamp)

> The creation date for this environment.

DateUpdated -> (timestamp)

> The last modified date for this environment.

Status -> (string)

> The current operational status of the environment:

> * `Aborting` : Environment is in the process of aborting a deployment.
> * `Launching` : Environment is in the process of initial deployment.
> * `LinkingFrom` : Environment is in the process of being linked to by another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
> * `LinkingTo` : Environment is in the process of linking to another environment. See [Environment links](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html) for details.
> * `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.

> Possible values:

> * `Aborting`
> * `Launching`
> * `Updating`
> * `LinkingFrom`
> * `LinkingTo`
> * `Ready`
> * `Terminating`
> * `Terminated`

AbortableOperationInProgress -> (boolean)

> 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.

Health -> (string)

> Describes the health status of the environment. 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 `RestartEnvironment` request.

> Default: `Grey`

> Possible values:

> * `Green`
> * `Yellow`
> * `Red`
> * `Grey`

HealthStatus -> (string)

> Returns the health status of the application running in your environment. For more information, see [Health Colors and Statuses](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) .

> Possible values:

> * `NoData`
> * `Unknown`
> * `Pending`
> * `Ok`
> * `Info`
> * `Warning`
> * `Degraded`
> * `Severe`
> * `Suspended`

Resources -> (structure)

> The description of the Amazon Web Services resources used by this environment.

> LoadBalancer -> (structure)

> > Describes the LoadBalancer.

> > LoadBalancerName -> (string)

> > > The name of the LoadBalancer.

> > Domain -> (string)

> > > The domain name of the LoadBalancer.

> > Listeners -> (list)

> > > A list of Listeners used by the LoadBalancer.

> > > (structure)

> > > > Describes the properties of a Listener for the LoadBalancer.

> > > > Protocol -> (string)

> > > > > The protocol that is used by the Listener.

> > > > Port -> (integer)

> > > > > The port that is used by the Listener.

Tier -> (structure)

> Describes the current tier of this environment.

> Name -> (string)

> > The name of this environment tier.

> > Valid values:

> > * For *Standard-mode EC2-based web server* – `WebServer`
> > * For *Standard-mode EC2-based backend application with Amazon SQS* – `Worker`
> > * For *Cluster-mode Amazon EKS-based applications* – `Cluster`

> Type -> (string)

> > The type of this environment tier.

> > Valid values:

> > * For *Web server tier* – `Standard`
> > * For *Worker tier* – `SQS/HTTP`
> > * For *Cluster tier* – `EKS`

> 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.

> > #### NOTE
> > This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

EnvironmentLinks -> (list)

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

> (structure)

> > A link to another environment, defined in the environment’s manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See [Environment Manifest (env.yaml)](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.

> > LinkName -> (string)

> > > The name of the link.

> > EnvironmentName -> (string)

> > > The name of the linked environment (the dependency).

EnvironmentArn -> (string)

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

OperationsRole -> (string)

> #### WARNING
> The operations role feature of Elastic Beanstalk is in beta release and is subject to change.

> The Amazon Resource Name (ARN) of the environment’s operations role.

> Constraints:

> * min: `1`
> * max: `256`