Syntax Properties Return values Examples See also

AWS::ElasticBeanstalk::ApplicationVersion

The AWS::ElasticBeanstalk::ApplicationVersion resource is an AWS Elastic Beanstalk resource type that specifies an application version, an iteration of deployable code, for an Elastic Beanstalk application.

Note

After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, an attempt to launch an environment from the application version will fail.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::ElasticBeanstalk::ApplicationVersion",
  "Properties" : {
      "ApplicationName" : String,
      "BuildConfiguration" : BuildConfiguration,
      "Description" : String,
      "ImageConfiguration" : ImageConfiguration,
      "Process" : Boolean,
      "SourceBundle" : SourceBundle
    }
}

YAML


Type: AWS::ElasticBeanstalk::ApplicationVersion
Properties:
  ApplicationName: String
  BuildConfiguration: 
    BuildConfiguration
  Description: String
  ImageConfiguration: 
    ImageConfiguration
  Process: Boolean
  SourceBundle: 
    SourceBundle

Properties

ApplicationName

The name of the Elastic Beanstalk application that is associated with this application version.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: Replacement

BuildConfiguration

Settings for an AWS CodeBuild build.

Don't specify BuildConfiguration together with ImageConfiguration, which configures a container image build instead.

Required: No

Type: BuildConfiguration

Update requires: Replacement

Description

A description of this application version.

Required: No

Type: String

Maximum: 200

Update requires: No interruption

ImageConfiguration

The source of the container image for this application version. You can specify an image that you built and pushed to a container registry yourself, or settings for Elastic Beanstalk to build one from your source bundle. Specify exactly one of the Source and Build members.

Don't specify ImageConfiguration together with BuildConfiguration, which configures an AWS CodeBuild build instead.

Required: No

Type: ImageConfiguration

Update requires: Replacement

Process

Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.

Note

The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.

Required: No

Type: Boolean

Update requires: Replacement

SourceBundle

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

Note

The Amazon S3 bucket must be in the same region as the environment.

Required: No

Type: SourceBundle

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Examples

JSON


"myAppVersion": { 
  "Type" : "AWS::ElasticBeanstalk::ApplicationVersion",
  "Properties" : {
    "ApplicationName" : {"Ref" : "myApp"},
    "Description" : "my sample version",
    "SourceBundle" : {
      "S3Bucket" : { "Fn::Join" :
        ["-", [ "elasticbeanstalk-samples", { "Ref" : "AWS::Region" } ] ] },
      "S3Key" : "php-newsample-app.zip"
    } 
  }
}

YAML


myAppVersion: 
  Type: AWS::ElasticBeanstalk::ApplicationVersion
  Properties: 
    ApplicationName: 
      Ref: "myApp"
    Description: "my sample version"
    SourceBundle: 
      S3Bucket: 
        Fn::Join: 
          - "-"
          - 
            - "elasticbeanstalk-samples"
            - Ref: "AWS::Region"
      S3Key: "php-newsample-app.zip"