Skip to content

CreateApplicationVersionMessage

Source code in docs_src/capo_elastic_beanstalk/types/create_application_version_message.py
class CreateApplicationVersionMessage(TypedDict, closed=True):
    application_name: "capo_elastic_beanstalk.types.application_name.ApplicationName"
    """<p> The name of the application. If no application is found with this name, and <code>AutoCreateApplication</code> is <code>false</code>, returns an <code>InvalidParameterValue</code> error. </p>"""
    version_label: "capo_elastic_beanstalk.types.version_label.VersionLabel"
    """<p>A label identifying this version.</p> <p>Constraint: Must be unique per application. If an application version already exists with this label for the specified application, Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"""
    description: NotRequired["capo_elastic_beanstalk.types.description.Description"]
    """<p>A description of this application version.</p>"""
    source_build_information: NotRequired[
        "capo_elastic_beanstalk.types.source_build_information.SourceBuildInformation"
    ]
    """<p>Specify a commit in an CodeCommit Git repository to use as the source code for the application version.</p>"""
    source_bundle: NotRequired["capo_elastic_beanstalk.types.s3_location.S3Location"]
    """<p>The Amazon S3 bucket and key that identify the location of the source bundle for this version.</p> <note> <p>The Amazon S3 bucket must be in the same region as the environment.</p> <p>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 <code>Allow</code> permission to the <code>s3:Get*</code> actions on your S3 object resource, for example, <code>arn:aws:s3:::your-bucket/your-source-bundle-object</code>.</p> </note> <p>Specify a source bundle in Amazon S3 or a commit in an CodeCommit repository (with <code>SourceBuildInformation</code>), but not both. If neither <code>SourceBundle</code> nor <code>SourceBuildInformation</code> are provided, Elastic Beanstalk uses a sample application.</p>"""
    build_configuration: NotRequired[
        "capo_elastic_beanstalk.types.build_configuration.BuildConfiguration"
    ]
    """<p>Settings for an CodeBuild build.</p> <p>Don't specify <code>BuildConfiguration</code> together with <code>ImageConfiguration</code>, which configures a container image build instead.</p>"""
    auto_create_application: NotRequired[
        "capo_elastic_beanstalk.types.auto_create_application.AutoCreateApplication"
    ]
    """<p>Set to <code>true</code> to create an application with the specified name if it doesn't already exist.</p>"""
    process: NotRequired[
        "capo_elastic_beanstalk.types.application_version_proccess.ApplicationVersionProccess"
    ]
    """<p>Pre-processes and validates the environment manifest (<code>env.yaml</code>) and configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p> <p>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.</p> <note> <p>The <code>Process</code> option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.</p> </note>"""
    tags: NotRequired["capo_elastic_beanstalk.types.tags.Tags"]
    """<p>Specifies the tags applied to the application version.</p> <p>Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.</p>"""
    image_configuration: NotRequired[
        "capo_elastic_beanstalk.types.image_configuration.ImageConfiguration"
    ]
    """<p>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 <code>Source</code> and <code>Build</code> members.</p> <p>Don't specify <code>ImageConfiguration</code> together with <code>BuildConfiguration</code>, which configures an CodeBuild build instead.</p>"""

application_name instance-attribute

application_name: ApplicationName

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

auto_create_application instance-attribute

auto_create_application: NotRequired[AutoCreateApplication]

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

build_configuration instance-attribute

build_configuration: NotRequired[BuildConfiguration]

Settings for an CodeBuild build.

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

description instance-attribute

description: NotRequired[Description]

A description of this application version.

image_configuration instance-attribute

image_configuration: NotRequired[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.

process instance-attribute

process: NotRequired[ApplicationVersionProccess]

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.

source_build_information instance-attribute

source_build_information: NotRequired[SourceBuildInformation]

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

source_bundle instance-attribute

source_bundle: NotRequired[S3Location]

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.

tags instance-attribute

tags: NotRequired[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.

version_label instance-attribute

version_label: VersionLabel

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.