You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::CreateApplicationVersionMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass CreateApplicationVersionMessage data as a hash:

{
  application_name: "ApplicationName", # required
  version_label: "VersionLabel", # required
  description: "Description",
  source_build_information: {
    source_type: "Git", # required, accepts Git, Zip
    source_repository: "CodeCommit", # required, accepts CodeCommit, S3
    source_location: "SourceLocation", # required
  },
  source_bundle: {
    s3_bucket: "S3Bucket",
    s3_key: "S3Key",
  },
  build_configuration: {
    artifact_name: "String",
    code_build_service_role: "NonEmptyString", # required
    compute_type: "BUILD_GENERAL1_SMALL", # accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
    image: "NonEmptyString", # required
    timeout_in_minutes: 1,
  },
  auto_create_application: false,
  process: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#auto_create_applicationBoolean

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

Returns:

  • (Boolean)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#build_configurationTypes::BuildConfiguration

Settings for an AWS CodeBuild build.



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#descriptionString

Describes this version.

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#processBoolean

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 AWS CodeBuild or AWS 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.

Returns:

  • (Boolean)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#source_build_informationTypes::SourceBuildInformation

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



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#source_bundleTypes::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.

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

Returns:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end

#version_labelString

A label identifying this version.

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

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1083

class CreateApplicationVersionMessage < Struct.new(
  :application_name,
  :version_label,
  :description,
  :source_build_information,
  :source_bundle,
  :build_configuration,
  :auto_create_application,
  :process)
  include Aws::Structure
end