Class CreateEnvironmentRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for CreateEnvironmentRequest object.CreateEnvironmentRequest
(String applicationName, String environmentName) Constructs a new CreateEnvironmentRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the application that contains the version to be deployed.If specified, the environment attempts to use this value as the prefix for the CNAME.Describes this environment.A unique name for the deployment environment.The name of the group to which the target environment belongs.If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment.A list of custom user-defined configuration options to remove from the configuration set for this new environment.This is an alternative to specifying a template name.getTags()
This specifies the tags applied to resources in the environment.The name of the configuration template to use in deployment.getTier()
This specifies the tier to use for creating this environment.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
setGroupName
(String groupName) The name of the group to which the target environment belongs.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 template 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.toString()
Returns a string representation of this object; useful for testing and debugging.withApplicationName
(String applicationName) The name of the application that contains the version to be deployed.withCNAMEPrefix
(String cNAMEPrefix) If specified, the environment attempts to use this value as the prefix for the CNAME.withDescription
(String description) Describes this environment.withEnvironmentName
(String environmentName) A unique name for the deployment environment.withGroupName
(String groupName) The name of the group to which the target environment belongs.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.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.withOptionsToRemove
(OptionSpecification... optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this new environment.withOptionsToRemove
(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this new environment.withSolutionStackName
(String solutionStackName) This is an alternative to specifying a template name.This specifies the tags applied to resources in the environment.withTags
(Collection<Tag> tags) This specifies the tags applied to resources in the environment.withTemplateName
(String templateName) The name of the configuration template to use in deployment.withTier
(EnvironmentTier tier) This specifies the tier to use for creating this environment.withVersionLabel
(String versionLabel) The name of the application version to deploy.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateEnvironmentRequest
public CreateEnvironmentRequest()Default constructor for CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
CreateEnvironmentRequest
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 anInvalidParameterValue
error.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.
-
-
Method Details
-
setApplicationName
The name of the application that contains the version to be deployed.
If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.- Parameters:
applicationName
- The name of the application that contains the version to be deployed.If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.
-
getApplicationName
The name of the application that contains the version to be deployed.
If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.- Returns:
- The name of the application that contains the version to be
deployed.
If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.
-
withApplicationName
The name of the application that contains the version to be deployed.
If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.- Parameters:
applicationName
- The name of the application that contains the version to be deployed.If no application is found with this name,
CreateEnvironment
returns anInvalidParameterValue
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnvironmentName
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.
- Parameters:
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.
-
getEnvironmentName
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.
-
withEnvironmentName
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setGroupName
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.
- Parameters:
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.
-
getGroupName
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.
-
withGroupName
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
Describes this environment.
- Parameters:
description
- Describes this environment.
-
getDescription
Describes this environment.
- Returns:
- Describes this environment.
-
withDescription
Describes this environment.
- Parameters:
description
- Describes this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCNAMEPrefix
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.
- 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.
-
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.
- 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.
-
withCNAMEPrefix
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setTier
This specifies the tier to use for creating this environment.
- Parameters:
tier
- This specifies the tier to use for creating this environment.
-
getTier
This specifies the tier to use for creating this environment.
- Returns:
- This specifies the tier to use for creating this environment.
-
withTier
This specifies the tier to use for creating this environment.
- Parameters:
tier
- This specifies the tier to use for creating this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
This specifies the tags applied to resources in the environment.
- Returns:
- This specifies the tags applied to resources in the environment.
-
setTags
This specifies the tags applied to resources in the environment.
- Parameters:
tags
- This specifies the tags applied to resources in the environment.
-
withTags
This specifies the tags applied to resources in the environment.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- This specifies the tags applied to resources in the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
This specifies the tags applied to resources in the environment.
- Parameters:
tags
- This specifies the tags applied to resources in the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVersionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns anInvalidParameterValue
error.Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
- Parameters:
versionLabel
- The name of the application version to deploy.If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns anInvalidParameterValue
error.Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
-
getVersionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns anInvalidParameterValue
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 anInvalidParameterValue
error.Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
-
withVersionLabel
The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns anInvalidParameterValue
error.Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
- Parameters:
versionLabel
- The name of the application version to deploy.If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns anInvalidParameterValue
error.Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTemplateName
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 anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- 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 anInvalidParameterValue
error.Condition: You must specify either this parameter or a
SolutionStackName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.
-
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 anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
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.Condition: You must specify either this parameter or a
SolutionStackName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.
-
withTemplateName
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 anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- 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 anInvalidParameterValue
error.Condition: You must specify either this parameter or a
SolutionStackName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSolutionStackName
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.
Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- Parameters:
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.Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.
-
getSolutionStackName
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.
Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- 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.
Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.
-
withSolutionStackName
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.
Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- Parameters:
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.Condition: You must specify either this or a
TemplateName
, but not both. If you specify both, AWS Elastic Beanstalk returns anInvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns aMissingRequiredParameter
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
NOTE: This method appends the values to the existing list (if any). Use
setOptionSettings(java.util.Collection)
orwithOptionSettings(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
NOTE: This method appends the values to the existing list (if any). Use
setOptionsToRemove(java.util.Collection)
orwithOptionsToRemove(java.util.Collection)
if you want to override the existing values.- Parameters:
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this new environment.- Returns:
- Returns a reference to this 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.
- Parameters:
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this new environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-