[ aws . elasticbeanstalk ]
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.
See also: AWS API Documentation
create-application-version
--application-name <value>
--version-label <value>
[--description <value>]
[--source-build-information <value>]
[--source-bundle <value>]
[--build-configuration <value>]
[--auto-create-application | --no-auto-create-application]
[--process | --no-process]
[--tags <value>]
[--image-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
--application-name (string) [required]
The name of the application. If no application is found with this name, and
AutoCreateApplicationisfalse, returns anInvalidParameterValueerror.Constraints:
- min:
1- max:
100
--version-label (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
InvalidParameterValueerror.Constraints:
- min:
1- max:
100
--description (string)
A description of this application version.
Constraints:
- max:
200
--source-build-information (structure)
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.
GitZipPossible values:
GitZipSourceRepository -> (string) [required]
Location where the repository is stored.
CodeCommitS3Possible values:
CodeCommitS3SourceLocation -> (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.Constraints:
- min:
3- max:
255- pattern:
.+/.+
Shorthand Syntax:
SourceType=string,SourceRepository=string,SourceLocation=string
JSON Syntax:
{
"SourceType": "Git"|"Zip",
"SourceRepository": "CodeCommit"|"S3",
"SourceLocation": "string"
}
--source-bundle (structure)
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
Allowpermission to thes3: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 neitherSourceBundlenorSourceBuildInformationare provided, Elastic Beanstalk uses a sample application.S3Bucket -> (string)
The Amazon S3 bucket where the data is located.
Constraints:
- max:
255S3Key -> (string)
The Amazon S3 key where the data is located.
Constraints:
- max:
1024
Shorthand Syntax:
S3Bucket=string,S3Key=string
JSON Syntax:
{
"S3Bucket": "string",
"S3Key": "string"
}
--build-configuration (structure)
Settings for an CodeBuild build.
Don’t specify
BuildConfigurationtogether withImageConfiguration, 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.
Constraints:
- pattern:
.*\S.*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 buildsBUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for buildsBUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for buildsPossible values:
BUILD_GENERAL1_SMALLBUILD_GENERAL1_MEDIUMBUILD_GENERAL1_LARGEImage -> (string) [required]
The ID of the Docker image to use for this build project.
Constraints:
- pattern:
.*\S.*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.
Shorthand Syntax:
ArtifactName=string,CodeBuildServiceRole=string,ComputeType=string,Image=string,TimeoutInMinutes=integer
JSON Syntax:
{
"ArtifactName": "string",
"CodeBuildServiceRole": "string",
"ComputeType": "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE",
"Image": "string",
"TimeoutInMinutes": integer
}
--auto-create-application | --no-auto-create-application (boolean)
Set totrueto create an application with the specified name if it doesn’t already exist.
--process | --no-process (boolean)
Pre-processes and validates the environment manifest (
env.yaml) and configuration files (*.configfiles in the.ebextensionsfolder) 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
TheProcessoption 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.
(structure)
Describes a tag applied to a resource in an environment.
Key -> (string)
The key of the tag.
Constraints:
- min:
1- max:
128Value -> (string)
The value of the tag.
Constraints:
- min:
1- max:
256
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--image-configuration (structure)
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
SourceandBuildmembers.Don’t specify
ImageConfigurationtogether withBuildConfiguration, which configures an CodeBuild build instead.Source -> (structure)
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 specifyBuildor the request’sSourceBundleparameter.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 -> (structure)
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’sSourceBundleparameter, and don’t specifySource.Type -> (string)
How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a
Buildthat doesn’t specify it.Valid values:
docker– Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile withDockerfileLocation.buildpack– Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder withBuildpack.Possible values:
dockerbuildpackDockerfileLocation -> (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
Typeisdocker. 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
Typeisbuildpack. 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.Possible values:
amd64arm64CodeBuildServiceRole -> (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
Buildthat doesn’t specify this role.Constraints:
- pattern:
.*\S.*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.Possible values:
BUILD_GENERAL1_SMALLBUILD_GENERAL1_MEDIUMBUILD_GENERAL1_LARGETimeoutInMinutes -> (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.
Shorthand Syntax:
Source={Uri=string},Build={Type=string,DockerfileLocation=string,Buildpack=string,Architecture=string,CodeBuildServiceRole=string,ComputeType=string,TimeoutInMinutes=integer}
JSON Syntax:
{
"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": integer
}
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a new application version
The following command creates a new version, “v1” of an application named “MyApp”:
aws elasticbeanstalk create-application-version --application-name MyApp --version-label v1 --description MyAppv1 --source-bundle S3Bucket="amzn-s3-demo-bucket",S3Key="sample.war" --auto-create-application
The application will be created automatically if it does not already exist, due to the auto-create-application option. The source bundle is a .war file stored in an s3 bucket named “amzn-s3-demo-bucket” that contains the Apache Tomcat sample application.
Output:
{
"ApplicationVersion": {
"ApplicationName": "MyApp",
"VersionLabel": "v1",
"Description": "MyAppv1",
"DateCreated": "2015-02-03T23:01:25.412Z",
"DateUpdated": "2015-02-03T23:01:25.412Z",
"SourceBundle": {
"S3Bucket": "amzn-s3-demo-bucket",
"S3Key": "sample.war"
}
}
}
ApplicationVersion -> (structure)
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.
Constraints:
- min:
1- max:
100Description -> (string)
The description of the application version.
Constraints:
- max:
200VersionLabel -> (string)
A unique identifier for the application version.
Constraints:
- min:
1- max:
100SourceBuildInformation -> (structure)
If the version’s source code was retrieved from CodeCommit, the location of the source code for the application version.
SourceType -> (string) [required]
The type of repository.
GitZipPossible values:
GitZipSourceRepository -> (string) [required]
Location where the repository is stored.
CodeCommitS3Possible values:
CodeCommitS3SourceLocation -> (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.Constraints:
- min:
3- max:
255- pattern:
.+/.+BuildArn -> (string)
Reference to the artifact from the CodeBuild build.SourceBundle -> (structure)
The storage location of the application version’s source bundle in Amazon S3.
S3Bucket -> (string)
The Amazon S3 bucket where the data is located.
Constraints:
- max:
255S3Key -> (string)
The Amazon S3 key where the data is located.
Constraints:
- max:
1024ImageSource -> (structure)
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 -> (structure)
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
Buildthat doesn’t specify it.Valid values:
docker– Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile withDockerfileLocation.buildpack– Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder withBuildpack.Possible values:
dockerbuildpackDockerfileLocation -> (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
Typeisdocker. 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
Typeisbuildpack. 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.Possible values:
amd64arm64CodeBuildServiceRole -> (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
Buildthat doesn’t specify this role.Constraints:
- pattern:
.*\S.*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.Possible values:
BUILD_GENERAL1_SMALLBUILD_GENERAL1_MEDIUMBUILD_GENERAL1_LARGETimeoutInMinutes -> (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 (*.configfiles in the.ebextensionsfolder) in the source bundle of the application version.DateCreated -> (timestamp)
The creation date of the application version.DateUpdated -> (timestamp)
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
Truefor theProcessparameter of theCreateApplicationVersionaction. 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.Possible values:
ProcessedUnprocessedFailedProcessingBuilding