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

eb platform

Description

This comamnd supports two different workspaces:

Platform

Use this workspace to manage custom platforms.

Environment

Use this workspace to select a default platform or show information about the current platform.

Note

Elastic Beanstalk provides the shortcut ebp for eb platform. The examples use this shortcut.

Using eb platform for custom platforms

Lists the versions of the current platform and enables you to manage custom platforms.

Syntax

eb platform create [version] [options]

eb platform delete [version] [options]

eb platform events [version] [options]

eb platform init [platform] [options]

eb platform list [options]

eb platform logs [version] [options]

eb platform status [version] [options]

eb platform use [platform] [options]

Options

Name

Description

create [version] [options]

Build a new version of the platform. Learn more.

delete version [options]

Delete a platform version. Learn more.

events [version] [options]

Display the events from a platform version. Learn more.

init [platform] [options]

Initialize a platform repository. Learn more.

list [options]

List the versions of the current platform. Learn more.

logs [version] [options]

Display logs from the builder environment for a platform version. Learn more.

status [version] [options]

Display the status of the a platform version. Learn more.

use [platform] [options]

Select a different platform from which new versions are built. Learn more.

Common options

Common Options

All ebp platform commands include the following common options.

Name

Description

-h

OR

--help

Shows a help message and exits.

--debug

Shows additional debugging output.

--quiet

Suppresses all output.

-v

OR

--verbose

Shows additional output.

--profile PROFILE

Uses the specified PROFILE from your credentials.

-r REGION

OR

--region REGION

Use the region REGION.

--no-verify-ssl

Do not verify AWS SSL certificates.

ebp create

Builds a new version of the platform and returns the ARN for the new version. If there is no builder environment running in the current region, this command launches one. The version and increment options (-M, -m, and -p) are mutually exclusive.

Options

Name

Description

version

If version isn't specified, creates a new version based on the most-recent platform with the patch version (N in n.n.N) incremented.

-M

OR

--major-increment

Increments the major version number (the N in N.n.n).

-m

OR

--minor-increment

Increments the minor version number (the N in n.N.n).

-p

OR

--patch-incremeint

Increments the patch version number (the N in n.n.N).

-i INSTANCE_TYPE

OR

--instance-type INSTANCE_TYPE

Use INSTANCE_TYPE as the instance type, such as t1.micro.

-ip INSTANCE_PROFILE

OR

--instance-profile INSTANCE_PROFILE

Use INSTANCE_PROFILE as the instance profile when creating AMIs for a custom platform.

If the -ip option isn't specified, creates the instance profile aws-elasticbeanstalk-custom-platforme-ec2-role and uses it for the custom platform.

--vpc.id VPC_ID

The ID of the VPC in which Packer builds.

--vpc.subnets VPC_SUBNETS

The VPC subnets in which Packer builds.

--vpc.publicip

Associates public IPs to EC2 instances launched.

ebp delete

Delete a platform version. The version isn't deleted if an environment is using that version.

Options

Name

Description

version

The version to delete. This value is required.

--cleanup

Remove all platform versions in the Failed state.

--all-platforms

If --cleanup is specified, remove all platform versions in the Failed state for all platforms.

--force

Do not require confirmation when deleting a version.

ebp events

Display the events from a platform version. If version is specified, display the events from that version, otherwise display the events from the current version.

Options

Name

Description

version

The version for which events are displayed. This value is required.

-f

OR

--follow

Continue to display events as they occur.

ebp init

Initialize a platform repository.

Options

Name

Description

platform

The name of the platform to initialize. This value is required, unless -i (interactive mode) is enabled.

-i

OR

--interactive

Use interactive mode.

-k KEYNAME

OR

--keyname KEYNAME

The default EC2 key name.

You can run this command in a directory that has been previously initialized, although you cannot change the workspace type if run in a directory that has been previously initialized.

To re-initialize with different options, use the -i option.

ebp list

List the versions of the platform associated with the workspace.

Options

Name

Description

-a

OR

--all-platforms

Lists the versions of all of the platforms associated with your account.

-s STATUS

OR

--status STATUS

List only the platforms matching STATUS:

  • Ready

  • Failed

  • Deleting

  • Creating

ebp logs

Display logs from the builder environment for a platform version.

Options

Name

Description

version

The version of the platform for which logs are displayed. If omitted, display logs from the current version.

--stream

Stream deployment logs that were set up with CloudWatch.

ebp status

Display the status of the a platform version.

Options

Name

Description

version

The version of the platform for which the status is retrieved. If omitted, display the status of the current version.

ebp use

Select a different platform from which new versions are built.

Options

Name

Description

platform

Specifies platform sa the active version for this workspace. This value is required.

Using eb platform for environments

Lists supported platforms and enables you to set the default platform and platform version to use when you launch an environment. Use eb platform list to view a list of all supported platforms. Use eb platform use to change the platform for your project. Use eb platform show to view your project's selected platform.

Syntax

eb platform list

eb platform select

eb platform show

Options

Name

Description

list

List the version of the current platform.

select

Select the default platform.

show

Show information about the current platform.

Example 1

The following example lists the names of all of all of the container for all platforms that Elastic Beanstalk supports.

$ ebp list
docker-1.5.0
glassfish-4.0-java-7-(preconfigured-docker)
glassfish-4.1-java-8-(preconfigured-docker)
go-1.3-(preconfigured-docker)
go-1.4-(preconfigured-docker)
iis-7.5
iis-8
iis-8.5
multi-container-docker-1.3.3-(generic)
node.js
php-5.3
php-5.4
php-5.5
python
python-2.7
python-3.4
python-3.4-(preconfigured-docker)
ruby-1.9.3
ruby-2.0-(passenger-standalone)
ruby-2.0-(puma)
ruby-2.1-(passenger-standalone)
ruby-2.1-(puma)
ruby-2.2-(passenger-standalone)
ruby-2.2-(puma)
tomcat-6
tomcat-7
tomcat-7-java-6
tomcat-7-java-7
tomcat-8-java-8

Example 2

The following example prompts you to choose from a list of platforms and the version that you want to deploy for the specified platform.

$ ebp select
Select a platform.
1) PHP
2) Node.js
3) IIS
4) Tomcat
5) Python
6) Ruby
7) Docker
8) Multi-container Docker
9) GlassFish
10) Go
(default is 1): 5

Select a platform version.
1) Python 2.7
2) Python
3) Python 3.4 (Preconfigured - Docker)

Example 3

The following example shows information about the current default platform.

$ ebp show
Current default platform: Python 2.7
New environments will be running:  64bit Amazon Linux 2014.09 v1.2.0 running Python 2.7

Platform info for environment "tmp-dev":
Current: 64bit Amazon Linux 2014.09 v1.2.0 running Python
Latest:  64bit Amazon Linux 2014.09 v1.2.0 running Python