software.amazon.awssdk.services.elasticbeanstalk.model

Class CreateApplicationVersionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.CreateApplicationVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateApplicationVersionRequest.Builder,CreateApplicationVersionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateApplicationVersionRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<CreateApplicationVersionRequest.Builder,CreateApplicationVersionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateApplicationVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationName() The name of the application.
Boolean	autoCreateApplication() Set to true to create an application with the specified name if it doesn't already exist.
BuildConfiguration	buildConfiguration() Settings for an AWS CodeBuild build.
static CreateApplicationVersionRequest.Builder	builder()
String	description() A description of this application version.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Boolean	process() Pre-processes and validates the environment manifest (env.yaml) and configuration files ( *.config files in the .ebextensions folder) in the source bundle.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateApplicationVersionRequest.Builder>	serializableBuilderClass()
SourceBuildInformation	sourceBuildInformation() Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
S3Location	sourceBundle() The Amazon S3 bucket and key that identify the location of the source bundle for this version.
List<Tag>	tags() Specifies the tags applied to the application version.
CreateApplicationVersionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionLabel() A label identifying this version.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationName

public final String applicationName()

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

Returns:

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

versionLabel

public final String 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, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

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.

description

public final String description()

A description of this application version.

Returns:

A description of this application version.

sourceBuildInformation

public final SourceBuildInformation sourceBuildInformation()

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

Returns:

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

sourceBundle

public final S3Location sourceBundle()

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:

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.

buildConfiguration

public final BuildConfiguration buildConfiguration()

Settings for an AWS CodeBuild build.

Returns:

Settings for an AWS CodeBuild build.

autoCreateApplication

public final Boolean autoCreateApplication()

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

Returns:

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

process

public final Boolean process()

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:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateApplicationVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateApplicationVersionRequest.Builder,CreateApplicationVersionRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static CreateApplicationVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateApplicationVersionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo