Sign In to the Console
AWS Elastic Beanstalk
Developer Guide
AWS Documentation » AWS Elastic Beanstalk » Developer Guide » The Elastic Beanstalk Command Line Interface (EB CLI) » EB CLI Command Reference » eb create
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon AWS.

eb create

Description

Creates a new environment and deploys an application version to it.

Note

You can deploy the application version from a few sources:

  • By default: from the application source code in the local project directory.

  • Using the --version option: from an application version that already exists in your application.

  • When your project directory doesn't have application code, or when using the --sample option: from a sample application, specific to your environment's platform.

Syntax

eb create

eb create environment-name

An environment name must be between 4 and 40 characters in length, and can only contain letters, numbers, and hyphens. An environment name can't begin or end with a hyphen.

If you include an environment name in the command, the EB CLI doesn't prompt you to make any selections or create a service role.

If you run the command without an environment name argument, it runs in an interactive flow, and prompts you to enter or select values for some settings. In this interactive flow, in case you are deploying a sample application, the EB CLI also asks you if you want to download this sample application to your local project directory. This enables you to use the EB CLI with the new environment later to run operations that require the application's code, like eb deploy.

Options

None of these options are required. If you run eb create without any options, the EB CLI prompts you to enter or select a value for each setting.

Name

Description

-d

or

--branch_default

Set the environment as the default environment for the current repository.

--cfg config-name

Use platform settings from a saved configuration in .elasticbeanstalk/saved_configs/ or your Amazon S3 bucket. Specify the name of the file only, without the .cfg.yml extension.

-c subdomain-name

or

--cname subdomain-name

The subdomain name to prefix the CNAME DNS entry that routes to your website.

Type: String

Default: The environment name

-db

or

--database

Attaches a database to the environment. If you run eb create with the --database option, but without the --database.username and --database.password options, EB CLI prompts you for the master database user name and password.

-db.engine engine

or

--database.engine engine

The database engine type. If you run eb create with this option, then EB CLI launches the environment with a database attached even if you didn't run the command with the --database option.

Type: String

Valid values: mysql, oracle-se1, postgres, sqlserver-ex, sqlserver-web, sqlserver-se

-db.i instance_type

or

--database.instance instance_type

The type of Amazon EC2 instance to use for the database. If you run eb create with this option, then EB CLI launches the environment with a database attached even if you didn't run the command with the --database option.

Type: String

Valid values: See Option Values.

-db.pass password

or

--database.password password

The password for the database. If you run eb create with this option, then EB CLI launches the environment with a database attached even if you didn't run the command with the --database option.

-db.size number_of_gigabytes

or

--database.size number_of_gigabytes

The number of gigabytes (GB) to allocate for database storage. If you run eb create with this option, then EB CLI launches the environment with a database attached even if you didn't run the command with the --database option.

Type: Number

Valid values:

  • MySQL – 5 to 1024. The default is 5.

  • Postgres – 5 to 1024. The default is 5.

  • Oracle – 10 to 1024. The default is 10.

  • Microsoft SQL Server Express Edition – 30.

  • Microsoft SQL Server Web Edition – 30.

  • Microsoft SQL Server Standard Edition – 200.

-db.user username

or

--database.username username

The user name for the database. If you run eb create with this option, then EB CLI launches the environment with a database attached even if you didn't run the command with the --database option. If you run eb create with the --database option, but without the --database.username and --database.password options, then EB CLI prompts you for the master database user name and password.

-db.version version

or

--database.version version

Allows you to specify the database engine version. If this flag is present, the environment will launch with a database with the specified version number, even if the --database flag is not present.

--elb-type type

The load balancer type.

Type: String

Valid values: classic, application, network

Default: application
--env-group-suffix groupname Group name to append to the environment name. Only for use with Compose Environments.

--envvars

Environment properties in a comma-separated list with the format name=value. See Configuring Environment Properties for limits.

-ip profile_name

or

--instance_profile profile_name

The instance profile with the IAM role with the temporary security credentials that your application needs to access AWS resources.

-i

or

--instance_type

The type of Amazon EC2 instance to use in the environment.

Valid values: See Option Values.

-k key_name

or

--keyname key_name

The name of the Amazon EC2 key pair to use with the Secure Shell (SSH) client to securely log in to the Amazon EC2 instances running your Elastic Beanstalk application. If you include this option with the eb create command, the value you provide overwrites any key name that you might have specified with eb init.

Valid values: An existing key name that is registered with Amazon EC2

--modules component-a component-b

 List of component environments to create. Only for use with Compose Environments.

-p platform-configuration

or

--platform platform-configuration

The platform version (configuration) to use. You can specify a platform name, a platform name and version, a solution stack name, or a solution stack ARN. For example:

  • php, PHP, node.js—The latest platform version for the specified platform

  • php-7.1, "PHP 7.1"—The latest PHP 7.1 platform version

  • "64bit Amazon Linux 2017.09 v2.6.3 running PHP 7.1"—The PHP platform version specified by this solution stack name

  • "arn:aws:elasticbeanstalk:us-west-2::platform/PHP 7.1 running on 64bit Amazon Linux/2.6.3"—The PHP platform version specified by this solution stack ARN

Use eb platform list to get a list of available configurations.

If you specify the --platform option, it overrides the value that was provided during eb init.

-pr

or

--process

Preprocess and validate the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

-r region

or

--region region

The AWS Region in which you want to deploy the application.

For the list of values you can specify for this option, see AWS Elastic Beanstalk in the Regions and Endpoints topic in the Amazon Web Services General Reference.

--sample

Deploy the sample application to the new environment instead of the code in your repository.

--scale number-of-instances

Launch with the specified number of instances
--service-role servicerole Assign a non-default service role to the environment.

Note

Do not enter an ARN, just the role name. Elastic Beanstalk prefixes the role name with the correct values to create the resulting ARN internally.

--single

Create the environment with a single Amazon EC2 instance and without a load balancer.

Warning

A single-instance environment isn't production ready. If the instance becomes unstable during deployment, or Elastic Beanstalk terminates and restarts the instance during a configuration update, your application can be unavailable for a period of time. Use single-instance environments for development, testing, or staging. Use load-balanced environments for production.

--tags key1=value1[,key2=value2 ...]

Tag the resources in your environment. Tags are specified as a comma-separated list of key=value pairs.

For valid values and more details, see Tag an Environment.

-t worker

or

--tier worker

 Create a worker environment. Omit this option to create a web server environment.

--timeout minutes

Set number of minutes before the command times out.

--version version_label

Specifies the application version that you want deployed to the environment instead of the application source code in the local project directory.

Type: String

Valid values: An existing application version label

--vpc

Configure a VPC for your environment. When you include this option, the EB CLI prompts you to enter all required settings prior to launching the environment.

--vpc.dbsubnets subnet1,subnet2

Specifies subnets for database instances in a VPC. Required when --vpc.id is specified.

--vpc.ec2subnets subnet1,subnet2

Specifies subnets for Amazon EC2 instances in a VPC. Required when --vpc.id is specified.

--vpc.elbpublic

Launches your Elastic Load Balancing load balancer in a public subnet in your VPC.

You can't specify this option with the --tier worker or --single options.

--vpc.elbsubnets subnet1,subnet2

Specifies subnets for the Elastic Load Balancing load balancer in a VPC.

You can't specify this option with the --tier worker or --single options.

--vpc.id ID

Launches your environment in the specified VPC.

--vpc.publicip

Launches your Amazon EC2 instances in a public subnet in your VPC.

You can't specify this option with the --tier worker option.

--vpc.securitygroups securitygroup1,securitygroup2

Specifies the security group ID or security group name. Required when --vpc.id is specified.

Common options

Output

If successful, the command prompts you with questions and then returns the status of the create operation. If there were problems during the launch, you can use the eb events operation to get more details.

If you enabled CodeBuild support in your application, eb create displays information from CodeBuild as your code is built. For information about CodeBuild support in Elastic Beanstalk, see Using the EB CLI with AWS CodeBuild.

Examples

The following example creates an environment in interactive mode.

$ eb create
Enter Environment Name
(default is tmp-dev): ENTER
Enter DNS CNAME prefix
(default is tmp-dev): ENTER
Select a load balancer type
1) classic
2) application
3) network
(default is 2): ENTER
Environment details for: tmp-dev
  Application name: tmp
  Region: us-west-2
  Deployed Version: app-141029_145448
  Environment ID: e-um3yfrzq22
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev.elasticbeanstalk.com
  Updated: 2014-10-29 21:54:51.063000+00:00
Printing Status:
...

The following example also creates an environment in interactive mode. In this example, your project directory doesn't have application code. The command deploys a sample application and downloads it to your local project directory. 

$ eb create
Enter Environment Name
(default is tmp-dev): ENTER
Enter DNS CNAME prefix
(default is tmp-dev): ENTER
Select a load balancer type
1) classic
2) application
3) network
(default is 2): ENTER
NOTE: The current directory does not contain any source code. Elastic Beanstalk is launching the sample application instead.
Do you want to download the sample application into the current directory?
(Y/n): ENTER
INFO: Downloading sample application to the current directory.
INFO: Download complete.
Environment details for: tmp-dev
  Application name: tmp
  Region: us-west-2
  Deployed Version: Sample Application
  Environment ID: e-um3yfrzq22
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev.elasticbeanstalk.com
  Updated: 2017-11-08 21:54:51.063000+00:00
Printing Status:
...

The following command creates an environment without displaying any prompts.

$ eb create dev-env
Creating application version archive "app-160312_014028".
Uploading test/app-160312_014028.zip to S3. This may take a while.
Upload Complete.
Application test has been created.
Environment details for: dev-env
  Application name: test
  Region: us-west-2
  Deployed Version: app-160312_014028
  Environment ID: e-6fgpkjxyyi
  Platform: 64bit Amazon Linux 2015.09 v2.0.8 running PHP 5.6
  Tier: WebServer-Standard
  CNAME: UNKNOWN
  Updated: 2016-03-12 01:40:33.614000+00:00
Printing Status:
...

The following command creates an environment in a custom VPC.

$ eb create dev-vpc --vpc.id vpc-0ce8dd99 --vpc.elbsubnets subnet-b356d7c6,subnet-02f74b0c --vpc.ec2subnets subnet-0bb7f0cd,subnet-3b6697c1 --vpc.securitygroup sg-70cff265
Creating application version archive "app-160312_014309".
Uploading test/app-160312_014309.zip to S3. This may take a while.
Upload Complete.
Environment details for: dev-vpc
  Application name: test
  Region: us-west-2
  Deployed Version: app-160312_014309
  Environment ID: e-pqkcip3mns
  Platform: 64bit Amazon Linux 2015.09 v2.0.8 running Java 8
  Tier: WebServer-Standard
  CNAME: UNKNOWN
  Updated: 2016-03-12 01:43:14.057000+00:00
Printing Status:
...