You can use the Elastic Beanstalk Environment task to create, update, rebuild, restart, swap or terminate an AWS Elastic Beanstalk environment (see Deploying to AWS Elastic Beanstalk for an overview of the Elastic Beanstalk component lifecycle and deployment workflow).
Configuration
The required Version Label stems from an Application Version previously provisioned - assuming an Application already exists, the typical deployment cycle is as follows:
- upload a source bundle via the S3 Object task's Upload action
- create a version via the Elastic Beanstalk Application Version task's Create action
- deploy that version via the Elastic Beanstalk Environment task's Update action
To configure an AWS Elastic Beanstalk Environment task:
- Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
- Click the name of an existing AWS Elastic Beanstalk Environment task, or click Add Task and then AWS Elastic Beanstalk Environment to create a new task.
Complete the following settings:
Common to all tasks
Actions supported by this task:
Create
Application Name Specify the name of the application that contains the version to be deployed
Environment Name Specify an environment name.
Must be unique within your account. If the name already exists, the task will fail.
Environment Tier Select a Web Server or Worker environment tier.
- Refer to the Architectural Overview for the differences between these environment tier types.
Version Label (Optional) Specify the label of the application version to deploy.
- If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
CNAME Prefix (Optional) Specify the prefix for the CNAME that the environment should attempt to use.
- Must be unique across all Elastic Beanstalk environments. If the name already exists, the task will fail.
If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
Configuration Source Select a predefined solution stack or saved named template.
- There might be more recent solution stacks available, see Supported Platforms – you can enter an updated version manually.
Advanced Options Await Health Status Timeout Specify how long to await the environments health status reaching a non grey state (seconds, 0 to skip). Verify Green Health Status Period Specify how long to verify the environments health status being green (seconds, 0 to skip)? Configuration Option Settings (Optional) Configure the environment.
- Refer to Option Values for available configuration options and values.
Tags (Optional) Tag the environment.
Refer to Tagging Your Amazon EC2 Resources and Listing and Filtering Your Resources for details. For example:
- Single Instance – Uses single-instance environment type instead of load-balanced.
- Instance type – Sets the configurations instance type to the desired size/type.
- Auto Scaling range – Sets the Auto Scaling group instance number min and max sizes.
- Worker Tier IAM Profile – Defines the IAM instance profile to use for a worker tier configuration.
- General Purpose (SSD) storage volume – Defines the root storage volume for the Amazon EC2 instances in the environment as general purpose SSD.
Environment Description (Optional) Describe the environment. Update
Environment Name or Id or CNAME Specify the target environment. You can use its name, id or the associated CNAME.
- CNAME needs to be the fully qualified domain name, e.g. "someEnv.elasticbeanstalk.com"
Version Label see Create above
Advanced Options Await Health Status Timeout see Create above Verify Green Health Status Period see Create above Configuration Option Settings see Create above
Tags see Create above Environment Description see Create above Rebuild
Environment Name or Id or CNAME see Update above Advanced Options Await Health Status Timeout see Create above Verify Green Health Status Period see Create above Restart
Environment Name or Id or CNAME see Update above Advanced Options Await Health Status Timeout see Create above Verify Green Health Status Period see Create above Swap
The Swap action enables Deploying Versions with Zero Downtime by swapping the URLs between two environments - this concept is also referred to as a Blue-Green deployments.
Source Environment Name or Id or CNAME Specify the source environment. You can use its name, id or the associated CNAME.
- CNAME needs to be the fully qualified domain name, e.g. "someEnv.elasticbeanstalk.com"
Destination Environment Name or Id Specify the target environment. You can use its name, id. Terminate
Environment Name or Id or CNAME see Update above
Terminate Resources Check to also terminate the associated AWS resources. Clear to remove the associated AWS resources from Elastic Beanstalk, but continue to operate them.