Package software.amazon.awssdk.services.elasticbeanstalk.model

Class CreateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticbeanstalk.model.CreateEnvironmentRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateEnvironmentRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateEnvironmentRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of the application that contains the version to be deployed.
static CreateEnvironmentRequest.Builder	builder()
String	cnamePrefix()	If specified, the environment attempts to use this value as the prefix for the CNAME.
String	description()	Describes this environment.
String	environmentName()	A unique name for the deployment environment.
boolean	equals(Object obj)
String	groupName()	The name of the group to which the target environment belongs.
int	hashCode()
List<ConfigurationOptionSetting>	optionSettings()	If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
List<OptionSpecification>	optionsToRemove()	A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String	platformArn()	The ARN of the custom platform.
static Class<? extends CreateEnvironmentRequest.Builder>	serializableBuilderClass()
String	solutionStackName()	This is an alternative to specifying a template name.
List<Tag>	tags()	This specifies the tags applied to resources in the environment.
String	templateName()	The name of the configuration template to use in deployment.
EnvironmentTier	tier()	This specifies the tier to use for creating this environment.
CreateEnvironmentRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionLabel()	The name of the application version to deploy.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

applicationName

public String applicationName()

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

Returns:

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

environmentName

public String environmentName()

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

Returns:

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

groupName

public String groupName()

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

Returns:

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

description

public String description()

Describes this environment.

Returns:

Describes this environment.

cnamePrefix

public String cnamePrefix()

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

Returns:

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

tier

public EnvironmentTier tier()

This specifies the tier to use for creating this environment.

Returns:

This specifies the tier to use for creating this environment.

tags

public List<Tag> tags()

This specifies the tags applied to resources in the environment.

Returns:

This specifies the tags applied to resources in the environment.

versionLabel

public String versionLabel()

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

Returns:

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

templateName

public String templateName()

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

solutionStackName

public String solutionStackName()

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Returns:

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

platformArn

public String platformArn()

The ARN of the custom platform.

Returns:

The ARN of the custom platform.

optionSettings

public List<ConfigurationOptionSetting> optionSettings()

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

Returns:

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

optionsToRemove

public List<OptionSpecification> optionsToRemove()

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

Returns:

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

toBuilder

public CreateEnvironmentRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Returns:

a builder for type T

builder

public static CreateEnvironmentRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object