ElasticBeanstalk / Client / create_application_version

create_application_version¶

ElasticBeanstalk.Client.create_application_version(**kwargs)¶

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.

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

Request Syntax

response = client.create_application_version(
    ApplicationName='string',
    VersionLabel='string',
    Description='string',
    SourceBuildInformation={
        'SourceType': 'Git'|'Zip',
        'SourceRepository': 'CodeCommit'|'S3',
        'SourceLocation': 'string'
    },
    SourceBundle={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    BuildConfiguration={
        '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=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ImageConfiguration={
        'Source': {
            'Uri': 'string'
        },
        'Build': {
            'Type': 'docker'|'buildpack',
            'DockerfileLocation': 'string',
            'Buildpack': 'string',
            'Architecture': 'amd64'|'arm64',
            'CodeBuildServiceRole': 'string',
            'ComputeType': 'BUILD_GENERAL1_SMALL'|'BUILD_GENERAL1_MEDIUM'|'BUILD_GENERAL1_LARGE',
            'TimeoutInMinutes': 123
        }
    }
)

Parameters:

ApplicationName (string) –
[REQUIRED]

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
VersionLabel (string) –
[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 (string) – A description of this application version.
SourceBuildInformation (dict) –
Specify a commit in an CodeCommit Git repository to use as the source code for the application version.
- SourceType (string) – [REQUIRED]
  
  The type of repository.
  - Git
  - Zip
- SourceRepository (string) – [REQUIRED]
  
  Location where the repository is stored.
  - CodeCommit
  - S3
- SourceLocation (string) – [REQUIRED]
  
  The location of the source code, as a formatted string, depending on the value of SourceRepository
  - For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.
  - For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.
SourceBundle (dict) –
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.

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.
- S3Bucket (string) –
  
  The Amazon S3 bucket where the data is located.
- S3Key (string) –
  
  The Amazon S3 key where the data is located.
BuildConfiguration (dict) –
Settings for an CodeBuild build.

Don’t specify BuildConfiguration together with ImageConfiguration, which configures a container image build instead.
- ArtifactName (string) –
  
  The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
- CodeBuildServiceRole (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that enables CodeBuild to interact with dependent Amazon Web Services service on behalf of the Amazon Web Services account.
- ComputeType (string) –
  
  Information about the compute resources the build project will use.
  - BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
  - BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
  - BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
- Image (string) – [REQUIRED]
  
  The ID of the Docker image to use for this build project.
- TimeoutInMinutes (integer) –
  
  How long in minutes, from 5 to 480 (8 hours), for CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
AutoCreateApplication (boolean) – Set to true to create an application with the specified name if it doesn’t already exist.
Process (boolean) –
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.

Note
The Process option validates Elastic Beanstalk configuration files. It doesn’t validate your application’s configuration files, like proxy server or Docker configuration.
Tags (list) –
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.
- (dict) –
  
  Describes a tag applied to a resource in an environment.
  - Key (string) –
    
    The key of the tag.
  - Value (string) –
    
    The value of the tag.
ImageConfiguration (dict) –
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.
- Source (dict) –
  
  The location of a container image that you built and pushed to a container registry yourself. Elastic Beanstalk deploys the image without a build step.
  
  If you specify Source, don’t specify Build or the request’s SourceBundle parameter.
  - Uri (string) –
    
    The URI of the container image, including the registry, the repository, and the image tag or digest. For example, 111122223333.dkr.ecr.us-east-1.amazonaws.com/my-repository:latest.
- Build (dict) –
  
  Settings that Elastic Beanstalk uses to build a container image from the source bundle of the application version.
  
  If you specify Build, also specify the request’s SourceBundle parameter, and don’t specify Source.
  - Type (string) –
    
    How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a Build that doesn’t specify it.
    
    Valid values:
    - docker – Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile with DockerfileLocation.
    - buildpack – Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder with Buildpack.
  - DockerfileLocation (string) –
    
    The path to the Dockerfile within the source bundle, relative to the root of the source bundle. For example, backend/Dockerfile.
    
    Elastic Beanstalk uses this member only when Type is docker. If you don’t specify it, Elastic Beanstalk uses the Dockerfile at the root of the source bundle.
  - Buildpack (string) –
    
    The Cloud Native Buildpacks builder image that Elastic Beanstalk uses to build the container image. For example, paketobuildpacks/builder-jammy-base.
    
    This member is required when Type is buildpack. Elastic Beanstalk doesn’t provide a default builder.
  - Architecture (string) –
    
    The processor architecture that Elastic Beanstalk builds the container image for. The architecture must match the architecture of the instances in the environment that you deploy the application version to.
    
    Valid values:
    - amd64 – x86-64 instances. This is the default.
    - arm64 – Amazon Web Services Graviton instances.
  - CodeBuildServiceRole (string) –
    
    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that CodeBuild assumes to run the build in your Amazon Web Services account. Elastic Beanstalk rejects a Build that doesn’t specify this role.
  - ComputeType (string) –
    
    The size of the compute resources that run the build. If you don’t specify it, Elastic Beanstalk uses BUILD_GENERAL1_MEDIUM.
    
    Valid values:
    - BUILD_GENERAL1_SMALL – Use up to 3 GB memory and 2 vCPUs for builds.
    - BUILD_GENERAL1_MEDIUM – Use up to 7 GB memory and 4 vCPUs for builds.
    - BUILD_GENERAL1_LARGE – Use up to 15 GB memory and 8 vCPUs for builds.
  - TimeoutInMinutes (integer) –
    
    How long, in minutes from 5 to 480 (8 hours), Elastic Beanstalk waits before stopping a build that hasn’t completed. The default is 60 minutes.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationVersion': {
        'ApplicationVersionArn': 'string',
        'ApplicationName': 'string',
        'Description': 'string',
        'VersionLabel': 'string',
        'SourceBuildInformation': {
            'SourceType': 'Git'|'Zip',
            'SourceRepository': 'CodeCommit'|'S3',
            'SourceLocation': 'string'
        },
        'BuildArn': 'string',
        'SourceBundle': {
            'S3Bucket': 'string',
            'S3Key': 'string'
        },
        'ImageSource': {
            'Uri': 'string'
        },
        'ImageBuildConfiguration': {
            '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': datetime(2015, 1, 1),
        'DateUpdated': datetime(2015, 1, 1),
        'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'|'Building'
    }
}

Response Structure

(dict) –

Result message wrapping a single description of an application version.
- ApplicationVersion (dict) –
  
  The ApplicationVersionDescription of the application version.
  - ApplicationVersionArn (string) –
    
    The Amazon Resource Name (ARN) of the application version.
  - ApplicationName (string) –
    
    The name of the application to which the application version belongs.
  - Description (string) –
    
    The description of the application version.
  - VersionLabel (string) –
    
    A unique identifier for the application version.
  - SourceBuildInformation (dict) –
    
    If the version’s source code was retrieved from CodeCommit, the location of the source code for the application version.
    - SourceType (string) –
      
      The type of repository.
      - Git
      - Zip
    - SourceRepository (string) –
      
      Location where the repository is stored.
      - CodeCommit
      - S3
    - SourceLocation (string) –
      
      The location of the source code, as a formatted string, depending on the value of SourceRepository
      - For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.
      - For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.
  - BuildArn (string) –
    
    Reference to the artifact from the CodeBuild build.
  - SourceBundle (dict) –
    
    The storage location of the application version’s source bundle in Amazon S3.
    - S3Bucket (string) –
      
      The Amazon S3 bucket where the data is located.
    - S3Key (string) –
      
      The Amazon S3 key where the data is located.
  - ImageSource (dict) –
    
    The location of the container image for the application version.
    
    For an application version created from an image you provide, this is that image. For one that Elastic Beanstalk builds from your source bundle, Elastic Beanstalk fills this in with the image it pushed after the build succeeds.
    - Uri (string) –
      
      The URI of the container image, including the registry, the repository, and the image tag or digest. For example, 111122223333.dkr.ecr.us-east-1.amazonaws.com/my-repository:latest.
  - ImageBuildConfiguration (dict) –
    
    The settings that Elastic Beanstalk uses to build a container image from the source bundle of the application version. Not present for an application version created from an image you provide.
    - Type (string) –
      
      How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a Build that doesn’t specify it.
      
      Valid values:
      - docker – Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile with DockerfileLocation.
      - buildpack – Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder with Buildpack.
    - DockerfileLocation (string) –
      
      The path to the Dockerfile within the source bundle, relative to the root of the source bundle. For example, backend/Dockerfile.
      
      Elastic Beanstalk uses this member only when Type is docker. If you don’t specify it, Elastic Beanstalk uses the Dockerfile at the root of the source bundle.
    - Buildpack (string) –
      
      The Cloud Native Buildpacks builder image that Elastic Beanstalk uses to build the container image. For example, paketobuildpacks/builder-jammy-base.
      
      This member is required when Type is buildpack. Elastic Beanstalk doesn’t provide a default builder.
    - Architecture (string) –
      
      The processor architecture that Elastic Beanstalk builds the container image for. The architecture must match the architecture of the instances in the environment that you deploy the application version to.
      
      Valid values:
      - amd64 – x86-64 instances. This is the default.
      - arm64 – Amazon Web Services Graviton instances.
    - CodeBuildServiceRole (string) –
      
      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that CodeBuild assumes to run the build in your Amazon Web Services account. Elastic Beanstalk rejects a Build that doesn’t specify this role.
    - ComputeType (string) –
      
      The size of the compute resources that run the build. If you don’t specify it, Elastic Beanstalk uses BUILD_GENERAL1_MEDIUM.
      
      Valid values:
      - BUILD_GENERAL1_SMALL – Use up to 3 GB memory and 2 vCPUs for builds.
      - BUILD_GENERAL1_MEDIUM – Use up to 7 GB memory and 4 vCPUs for builds.
      - BUILD_GENERAL1_LARGE – Use up to 15 GB memory and 8 vCPUs for builds.
    - TimeoutInMinutes (integer) –
      
      How long, in minutes from 5 to 480 (8 hours), Elastic Beanstalk waits before stopping a build that hasn’t completed. The default is 60 minutes.
  - Process (boolean) –
    
    Indicates whether Elastic Beanstalk pre-processed and validated the environment manifest ( env.yaml) and configuration files ( *.config files in the .ebextensions folder) in the source bundle of the application version.
  - DateCreated (datetime) –
    
    The creation date of the application version.
  - DateUpdated (datetime) –
    
    The last modified date of the application version.
  - Status (string) –
    
    The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.
    - Unprocessed – Application version wasn’t pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.
    - Processing – Elastic Beanstalk is currently processing the application version.
    - Building – Application version is currently undergoing an CodeBuild build.
    - Processed – Elastic Beanstalk was successfully pre-processed and validated.
    - Failed – Either the CodeBuild build failed or configuration files didn’t pass validation. This application version isn’t usable.

Exceptions

Examples

The following operation creates a new version (v1) of an application named my-app:

response = client.create_application_version(
    ApplicationName='my-app',
    AutoCreateApplication=True,
    Description='my-app-v1',
    Process=True,
    SourceBundle={
        'S3Bucket': 'my-bucket',
        'S3Key': 'sample.war',
    },
    VersionLabel='v1',
)

print(response)

Expected Output:

{
    'ApplicationVersion': {
        'ApplicationName': 'my-app',
        'DateCreated': datetime(2015, 2, 3, 23, 1, 25, 1, 34, 0),
        'DateUpdated': datetime(2015, 2, 3, 23, 1, 25, 1, 34, 0),
        'Description': 'my-app-v1',
        'SourceBundle': {
            'S3Bucket': 'my-bucket',
            'S3Key': 'sample.war',
        },
        'VersionLabel': 'v1',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}