AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Elastic Beanstalk CreateApplicationVersion API operation.

Syntax

New-EBApplicationVersion
-ApplicationName <String>
-VersionLabel <String>
-Description <String>
-ImageConfiguration_Build_Architecture <ArchitectureType>
-BuildConfiguration_ArtifactName <String>
-AutoCreateApplication <Boolean>
-ImageConfiguration_Build_Buildpack <String>
-BuildConfiguration_CodeBuildServiceRole <String>
-ImageConfiguration_Build_CodeBuildServiceRole <String>
-BuildConfiguration_ComputeType <ComputeType>
-ImageConfiguration_Build_ComputeType <ComputeType>
-ImageConfiguration_Build_DockerfileLocation <String>
-BuildConfiguration_Image <String>
-Process <Boolean>
-SourceBundle_S3Bucket <String>
-SourceBundle_S3Key <String>
-SourceBuildInformation_SourceLocation <String>
-SourceBuildInformation_SourceRepository <SourceRepository>
-SourceBuildInformation_SourceType <SourceType>
-Tag <Tag[]>
-BuildConfiguration_TimeoutInMinute <Int32>
-ImageConfiguration_Build_TimeoutInMinute <Int32>
-ImageConfiguration_Build_Type <ImageBuildType>
-ImageConfiguration_Source_Uri <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticBeanstalkConfig>

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.

Parameters

-ApplicationName <String>
The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AutoCreateApplication <Boolean>
Set to true to create an application with the specified name if it doesn't already exist.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildConfiguration_CodeBuildServiceRole <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildConfiguration_ComputeType <ComputeType>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildConfiguration_Image <String>
The ID of the Docker image to use for this build project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuildConfiguration_TimeoutInMinute <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBuildConfiguration_TimeoutInMinutes
-ClientConfig <AmazonElasticBeanstalkConfig>
Amazon.PowerShell.Cmdlets.EB.AmazonElasticBeanstalkClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of this application version.
Required?False
Position?3
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_Architecture <ArchitectureType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_ComputeType <ComputeType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Build_TimeoutInMinute <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesImageConfiguration_Build_TimeoutInMinutes
-ImageConfiguration_Build_Type <ImageBuildType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImageConfiguration_Source_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse). Specifying the name of a property of type Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBuildInformation_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBuildInformation_SourceRepository <SourceRepository>
Location where the repository is stored.
  • CodeCommit
  • S3
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBuildInformation_SourceType <SourceType>
The type of repository.
  • Git
  • Zip
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBundle_S3Bucket <String>
The Amazon S3 bucket where the data is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBundle_S3Key <String>
The Amazon S3 key where the data is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VersionLabel <String>
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.
Required?True
Position?2
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription or Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse
This cmdlet returns an Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription object. The service call response (type Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z