com.amazonaws.services.elasticbeanstalk.model

Class CreateEnvironmentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest

All Implemented Interfaces:

Serializable

public class CreateEnvironmentRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateEnvironment operation.

Launches an environment for the specified application using the specified configuration.

See Also:

AWSElasticBeanstalk.createEnvironment(CreateEnvironmentRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateEnvironmentRequest() Default constructor for a new CreateEnvironmentRequest object.
CreateEnvironmentRequest(String applicationName, String environmentName) Constructs a new CreateEnvironmentRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() The name of the application that contains the version to be deployed.
String	getCNAMEPrefix() If specified, the environment attempts to use this value as the prefix for the CNAME.
String	getDescription() Describes this environment.
String	getEnvironmentName() A unique name for the deployment environment.
List<ConfigurationOptionSetting>	getOptionSettings() If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
List<OptionSpecification>	getOptionsToRemove() A list of custom user-defined configuration options to remove from the configuration set for this new environment.
String	getSolutionStackName() This is an alternative to specifying a configuration name.
String	getTemplateName() The name of the configuration template to use in deployment.
EnvironmentTier	getTier() This specifies the tier to use for creating this environment.
String	getVersionLabel() The name of the application version to deploy.
int	hashCode()
void	setApplicationName(String applicationName) The name of the application that contains the version to be deployed.
void	setCNAMEPrefix(String cNAMEPrefix) If specified, the environment attempts to use this value as the prefix for the CNAME.
void	setDescription(String description) Describes this environment.
void	setEnvironmentName(String environmentName) A unique name for the deployment environment.
void	setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
void	setOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this new environment.
void	setSolutionStackName(String solutionStackName) This is an alternative to specifying a configuration name.
void	setTemplateName(String templateName) The name of the configuration template to use in deployment.
void	setTier(EnvironmentTier tier) This specifies the tier to use for creating this environment.
void	setVersionLabel(String versionLabel) The name of the application version to deploy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateEnvironmentRequest	withApplicationName(String applicationName) The name of the application that contains the version to be deployed.
CreateEnvironmentRequest	withCNAMEPrefix(String cNAMEPrefix) If specified, the environment attempts to use this value as the prefix for the CNAME.
CreateEnvironmentRequest	withDescription(String description) Describes this environment.
CreateEnvironmentRequest	withEnvironmentName(String environmentName) A unique name for the deployment environment.
CreateEnvironmentRequest	withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
CreateEnvironmentRequest	withOptionSettings(ConfigurationOptionSetting... optionSettings) If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.
CreateEnvironmentRequest	withOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this new environment.
CreateEnvironmentRequest	withOptionsToRemove(OptionSpecification... optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this new environment.
CreateEnvironmentRequest	withSolutionStackName(String solutionStackName) This is an alternative to specifying a configuration name.
CreateEnvironmentRequest	withTemplateName(String templateName) The name of the configuration template to use in deployment.
CreateEnvironmentRequest	withTier(EnvironmentTier tier) This specifies the tier to use for creating this environment.
CreateEnvironmentRequest	withVersionLabel(String versionLabel) The name of the application version to deploy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateEnvironmentRequest

public CreateEnvironmentRequest()

Default constructor for a new CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateEnvironmentRequest

public CreateEnvironmentRequest(String applicationName,
                        String environmentName)

Constructs a new CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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.

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

Constraint: Must be from 4 to 23 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.

Method Detail

getApplicationName

public String getApplicationName()

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.

Constraints:
Length: 1 - 100

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.

setApplicationName

public void setApplicationName(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.

Constraints:
Length: 1 - 100

Parameters:

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.

withApplicationName

public CreateEnvironmentRequest withApplicationName(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getEnvironmentName

public String getEnvironmentName()

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

Constraint: Must be from 4 to 23 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.

Constraints:
Length: 4 - 23

Returns:

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

Constraint: Must be from 4 to 23 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.

setEnvironmentName

public void setEnvironmentName(String environmentName)

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

Constraint: Must be from 4 to 23 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.

Constraints:
Length: 4 - 23

Parameters:

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

Constraint: Must be from 4 to 23 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.

withEnvironmentName

public CreateEnvironmentRequest withEnvironmentName(String environmentName)

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

Constraint: Must be from 4 to 23 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 reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 23

Parameters:

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

Constraint: Must be from 4 to 23 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 reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

Describes this environment.

Constraints:
Length: 0 - 200

Returns:

Describes this environment.

setDescription

public void setDescription(String description)

Describes this environment.

Constraints:
Length: 0 - 200

Parameters:

description - Describes this environment.

withDescription

public CreateEnvironmentRequest withDescription(String description)

Describes this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 200

Parameters:

description - Describes this environment.

Returns:

A reference to this updated object so that method calls can be chained together.

getCNAMEPrefix

public String getCNAMEPrefix()

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.

Constraints:
Length: 4 - 63

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.

setCNAMEPrefix

public void setCNAMEPrefix(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.

Constraints:
Length: 4 - 63

Parameters:

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.

withCNAMEPrefix

public CreateEnvironmentRequest withCNAMEPrefix(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 63

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getTier

public EnvironmentTier getTier()

This specifies the tier to use for creating this environment.

Returns:

This specifies the tier to use for creating this environment.

setTier

public void setTier(EnvironmentTier tier)

This specifies the tier to use for creating this environment.

Parameters:

tier - This specifies the tier to use for creating this environment.

withTier

public CreateEnvironmentRequest withTier(EnvironmentTier tier)

This specifies the tier to use for creating this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tier - This specifies the tier to use for creating this environment.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersionLabel

public String getVersionLabel()

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.

Constraints:
Length: 1 - 100

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.

setVersionLabel

public void setVersionLabel(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.

Constraints:
Length: 1 - 100

Parameters:

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.

withVersionLabel

public CreateEnvironmentRequest withVersionLabel(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()

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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

setTemplateName

public void setTemplateName(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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 1 - 100

Parameters:

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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

withTemplateName

public CreateEnvironmentRequest withTemplateName(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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns:

A reference to this updated object so that method calls can be chained together.

getSolutionStackName

public String getSolutionStackName()

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 0 - 100

Returns:

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

setSolutionStackName

public void setSolutionStackName(String solutionStackName)

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Constraints:
Length: 0 - 100

Parameters:

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

withSolutionStackName

public CreateEnvironmentRequest withSolutionStackName(String solutionStackName)

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 100

Parameters:

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

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns:

A reference to this updated object so that method calls can be chained together.

getOptionSettings

public List<ConfigurationOptionSetting> getOptionSettings()

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.

setOptionSettings

public void setOptionSettings(Collection<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.

Parameters:

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.

withOptionSettings

public CreateEnvironmentRequest withOptionSettings(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

withOptionSettings

public CreateEnvironmentRequest withOptionSettings(Collection<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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getOptionsToRemove

public List<OptionSpecification> getOptionsToRemove()

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.

setOptionsToRemove

public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

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

Parameters:

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

withOptionsToRemove

public CreateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withOptionsToRemove

public CreateEnvironmentRequest withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object