Skip to content

Creates an application version for the specified application

Description

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in CodeCommit, or the output of an CodeBuild build as follows:

Specify a commit in an CodeCommit repository with SourceBuildInformation.

Specify a build in an CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in Amazon S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

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, you receive an exception when you attempt to launch an environment from the application version.

Usage

elasticbeanstalk_create_application_version(ApplicationName,
  VersionLabel, Description, SourceBuildInformation, SourceBundle,
  BuildConfiguration, AutoCreateApplication, Process, Tags,
  ImageConfiguration)

Arguments

  • ApplicationName

[required] The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

  • VersionLabel

[required] A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, Elastic Beanstalk returns an InvalidParameterValue error.

  • Description

A description of this application version.

  • SourceBuildInformation

Specify a commit in an CodeCommit Git repository to use as the source code for the application version.

  • SourceBundle

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

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

Unless you're specifying a source bundle in the bucket that Elastic Beanstalk manages in your account, you must assign a custom policy to your user, and grant Allow permission to the s3:Get* actions on your S3 object resource, for example, arn:aws:s3:::your-bucket/your-source-bundle-object.

Specify a source bundle in Amazon S3 or a commit in an CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.

  • BuildConfiguration

Settings for an CodeBuild build.

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

  • AutoCreateApplication

Set to true to create an application with the specified name if it doesn't already exist.

  • 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 CodeBuild or CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.

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

  • Tags

Specifies the tags applied to the application version.

Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.

  • 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 CodeBuild build instead.

Value

A list with the following syntax:

list(
  ApplicationVersion = list(
    ApplicationVersionArn = "string",
    ApplicationName = "string",
    Description = "string",
    VersionLabel = "string",
    SourceBuildInformation = list(
      SourceType = "Git"|"Zip",
      SourceRepository = "CodeCommit"|"S3",
      SourceLocation = "string"
    ),
    BuildArn = "string",
    SourceBundle = list(
      S3Bucket = "string",
      S3Key = "string"
    ),
    ImageSource = list(
      Uri = "string"
    ),
    ImageBuildConfiguration = list(
      Type = "docker"|"buildpack",
      DockerfileLocation = "string",
      Buildpack = "string",
      Architecture = "amd64"|"arm64",
      CodeBuildServiceRole = "string",
      ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE",
      TimeoutInMinutes = 123
    ),
    Process = TRUE|FALSE,
    DateCreated = as.POSIXct(
      "2015-01-01"
    ),
    DateUpdated = as.POSIXct(
      "2015-01-01"
    ),
    Status = "Processed"|"Unprocessed"|"Failed"|"Processing"|"Building"
  )
)

Request syntax

svc$create_application_version(
  ApplicationName = "string",
  VersionLabel = "string",
  Description = "string",
  SourceBuildInformation = list(
    SourceType = "Git"|"Zip",
    SourceRepository = "CodeCommit"|"S3",
    SourceLocation = "string"
  ),
  SourceBundle = list(
    S3Bucket = "string",
    S3Key = "string"
  ),
  BuildConfiguration = list(
    ArtifactName = "string",
    CodeBuildServiceRole = "string",
    ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE",
    Image = "string",
    TimeoutInMinutes = 123
  ),
  AutoCreateApplication = TRUE|FALSE,
  Process = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ImageConfiguration = list(
    Source = list(
      Uri = "string"
    ),
    Build = list(
      Type = "docker"|"buildpack",
      DockerfileLocation = "string",
      Buildpack = "string",
      Architecture = "amd64"|"arm64",
      CodeBuildServiceRole = "string",
      ComputeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE",
      TimeoutInMinutes = 123
    )
  )
)

Examples

# The following operation creates a new version (v1) of an application
# named my-app:
svc$create_application_version(
  ApplicationName = "my-app",
  AutoCreateApplication = TRUE,
  Description = "my-app-v1",
  Process = TRUE,
  SourceBundle = list(
    S3Bucket = "my-bucket",
    S3Key = "sample.war"
  ),
  VersionLabel = "v1"
)