AWS Elastic Beanstalk Deploy Application task - AWS Toolkit for Microsoft Azure DevOps
SynopsisDescriptionParametersTask Permissions

AWS Elastic Beanstalk Deploy Application task

Synopsis

Deploys a new version of an application to an Elastic Beanstalk environment associated with the application.

Description

With Elastic Beanstalk, you can quickly deploy and manage applications in the AWS Cloud without worrying about the infrastructure that runs those applications. Elastic Beanstalk reduces management complexity without restricting choice or control. You simply upload your application, and Elastic Beanstalk automatically handles the details of capacity provisioning, load balancing, scaling, and application health monitoring.

This task can deploy ASP.NET applications (as Web Deploy archives), ASP.NET Core applications, an existing built application or a previously registered application version using the Elastic Beanstalk Create Version task.

Parameters

You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional.

Display name*

The default name of the task instance, which can be modified: Deploy to Elastic Beanstalk

AWS Credentials

Specifies the AWS credentials to be used by the task in the build agent environment.

You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order:

  • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken.

  • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN.

  • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances.

AWS Region

The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

If a Region is not specified in the task configuration, the task will attempt to obtain the Region to be used by using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region by using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable.

Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed can still be used by entering the region code of the Region (for example, us_west_2).

Application Name*

The name of the Elastic Beanstalk application.

Environment Name*

The name of the Elastic Beanstalk environment that will run the application.

An environment represents the AWS resources (e.g., load balancer, Auto Scaling group, and Amazon EC2 instances) created specifically to run your application.

Deployment Bundle Type*

The type of application bundle to deploy. You can select from

  • ASP.NET: the deployment bundle is expected to be a Web Deploy archive, built previously, which the task will upload.

  • ASP.NET Core: the deployment bundle will be created by the task (using the dotnet publish command line tool) and uploaded.

  • Existing deployment bundle: choose to deploy a bundle that has been built and uploaded previously to Amazon S3.

  • Existing application version: choose to deploy a revision previously registered with Elastic Beanstalk.

Web Deploy Archive

Required if Deployment Bundle Type is set to ASP.NET. The path to the web deploy archive containing the application to deploy to Elastic Beanstalk.

Published Application Path

Required if Deployment Bundle Type is set to ASP.NET Core. The output location where the dotnet publish command in your previous build steps placed the deployment artifacts to be published. Configure using either:

  • The path to the output folder containing the artifacts. Use this if the dotnet publish command in your build was configured to not create a .zip file of the published application.

  • The path and filename of the .zip file containing the artifacts. Use this if the dotnet publish command in your build was configured to create a .zip file of the application artifacts.

Deployment Bundle Bucket

Required if Deployment Bundle Type is set to Existing deployment bundle. The name of the Amazon S3 bucket containing the revision bundle to deploy.

Deployment Bundle Object Key

Required if Deployment Bundle Type is set to Existing deployment bundle. The Amazon S3 object key of the revision bundle file to be deployed.

Version Label

Version label for the new application revision. If not specified the task will construct a version label based on the current date and time, expressed in milliseconds (for example v20171120222623).

Version Label Output Variable

Optional variable name to which the version label for the revision will be stored on conclusion of the task. This is useful when Version Label is not specified and the task generates a version label for the revision. You can refer to this variable in subsequent build steps to obtain the deployed version label.

Task Permissions

This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used):

  • elasticbeanstalk:CreateApplicationVersion

  • elasticbeanstalk:CreateStorageLocation

  • elasticbeanstalk:DescribeApplications

  • elasticbeanstalk:DescribeEnvironments

  • elasticbeanstalk:DescribeEvents

  • elasticbeanstalk:UpdateEnvironment

The task also requires permissions to upload your application content to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used.