public class CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
CreateEnvironment operation
.
Launches an environment for the specified application using the specified configuration.
NOOP
Constructor and Description |
---|
CreateEnvironmentRequest()
Default constructor for a new CreateEnvironmentRequest object.
|
CreateEnvironmentRequest(String applicationName,
String environmentName)
Constructs a new CreateEnvironmentRequest object.
|
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.
|
List<Tag> |
getTags()
This specifies the tags applied to resources in the environment.
|
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 |
setTags(Collection<Tag> tags)
This specifies the tags applied to resources in the environment.
|
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 |
withTags(Collection<Tag> tags)
This specifies the tags applied to resources in the environment.
|
CreateEnvironmentRequest |
withTags(Tag... tags)
This specifies the tags applied to resources in the environment.
|
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.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public CreateEnvironmentRequest()
public CreateEnvironmentRequest(String applicationName, String environmentName)
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.
public String getApplicationName()
If no application is found with this name,
CreateEnvironment
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
If no application is found with this name,
CreateEnvironment
returns an
InvalidParameterValue
error.
public void setApplicationName(String applicationName)
If no application is found with this name,
CreateEnvironment
returns an
InvalidParameterValue
error.
Constraints:
Length: 1 - 100
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.
public CreateEnvironmentRequest withApplicationName(String applicationName)
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
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.
public String getEnvironmentName()
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
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.
public void setEnvironmentName(String environmentName)
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
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.
public CreateEnvironmentRequest withEnvironmentName(String environmentName)
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
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.
public String getDescription()
Constraints:
Length: 0 - 200
public void setDescription(String description)
Constraints:
Length: 0 - 200
description
- Describes this environment.public CreateEnvironmentRequest withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 200
description
- Describes this environment.public String getCNAMEPrefix()
Constraints:
Length: 4 - 63
public void setCNAMEPrefix(String cNAMEPrefix)
Constraints:
Length: 4 - 63
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.public CreateEnvironmentRequest withCNAMEPrefix(String cNAMEPrefix)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 4 - 63
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.public EnvironmentTier getTier()
public void setTier(EnvironmentTier tier)
tier
- This specifies the tier to use for creating this environment.public CreateEnvironmentRequest withTier(EnvironmentTier tier)
Returns a reference to this object so that method calls can be chained together.
tier
- This specifies the tier to use for creating this environment.public List<Tag> getTags()
public void setTags(Collection<Tag> tags)
tags
- This specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Tag... tags)
Returns a reference to this object so that method calls can be chained together.
tags
- This specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- This specifies the tags applied to resources in the environment.public String getVersionLabel()
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
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.
public void setVersionLabel(String versionLabel)
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
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.
public CreateEnvironmentRequest withVersionLabel(String versionLabel)
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
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.
public String getTemplateName()
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
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.
public void setTemplateName(String templateName)
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
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.
public CreateEnvironmentRequest withTemplateName(String templateName)
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
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.
public String getSolutionStackName()
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
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.
public void setSolutionStackName(String solutionStackName)
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
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.
public CreateEnvironmentRequest withSolutionStackName(String solutionStackName)
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
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.
public List<ConfigurationOptionSetting> getOptionSettings()
public void setOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)
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.public CreateEnvironmentRequest withOptionSettings(ConfigurationOptionSetting... optionSettings)
Returns a reference to this object so that method calls can be chained together.
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.public CreateEnvironmentRequest withOptionSettings(Collection<ConfigurationOptionSetting> optionSettings)
Returns a reference to this object so that method calls can be chained together.
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.public List<OptionSpecification> getOptionsToRemove()
public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
optionsToRemove
- A list of custom user-defined configuration options to remove from the
configuration set for this new environment.public CreateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove)
Returns a reference to this object so that method calls can be chained together.
optionsToRemove
- A list of custom user-defined configuration options to remove from the
configuration set for this new environment.public CreateEnvironmentRequest withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
Returns a reference to this object so that method calls can be chained together.
optionsToRemove
- A list of custom user-defined configuration options to remove from the
configuration set for this new environment.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.