public class CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description | 
|---|
| CreateEnvironmentRequest()Default constructor for CreateEnvironmentRequest object. | 
| CreateEnvironmentRequest(String applicationName,
                        String environmentName)Constructs a new CreateEnvironmentRequest object. | 
| Modifier and Type | Method and Description | 
|---|---|
| CreateEnvironmentRequest | clone()Creates a shallow clone of this request. | 
| 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. | 
| String | getGroupName()
 The name of the group to which the target environment belongs. | 
| 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 template 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 | 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. | 
| 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 | withGroupName(String groupName)
 The name of the group to which the target environment belongs. | 
| 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 template 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. | 
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic 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 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.
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.
 
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 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.
 
         If no application is found with this name,
         CreateEnvironment returns an
         InvalidParameterValue error.
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.
 
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 void setEnvironmentName(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.
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.
public String 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.
         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.
public CreateEnvironmentRequest withEnvironmentName(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.
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.
public void setGroupName(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.
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.public String 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.
public CreateEnvironmentRequest withGroupName(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.
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.public void setDescription(String description)
Describes this environment.
description - Describes this environment.public String getDescription()
Describes this environment.
public CreateEnvironmentRequest withDescription(String description)
Describes this environment.
description - Describes this environment.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.
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 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.
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.
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 void setTier(EnvironmentTier tier)
This specifies the tier to use for creating this environment.
tier - This specifies the tier to use for creating this environment.public EnvironmentTier getTier()
This specifies the tier to use for creating this environment.
public CreateEnvironmentRequest withTier(EnvironmentTier tier)
This specifies the tier to use for creating this environment.
tier - This specifies the tier to use for creating this environment.public List<Tag> getTags()
This specifies the tags applied to resources in the environment.
public void setTags(Collection<Tag> tags)
This specifies the tags applied to resources in the environment.
tags - This specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Tag... tags)
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) or
 withTags(java.util.Collection) if you want to override the
 existing values.
 
tags - This specifies the tags applied to resources in the environment.public CreateEnvironmentRequest withTags(Collection<Tag> tags)
This specifies the tags applied to resources in the environment.
tags - This specifies the tags applied to resources in the environment.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.
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 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.
         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)
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.
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 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.
 
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 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.
 
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)
 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.
 
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 void setSolutionStackName(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.
 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.
 
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 an
        InvalidParameterCombination error. If you do not
        specify either, AWS Elastic Beanstalk returns a
        MissingRequiredParameter error.
public String 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 an
 InvalidParameterCombination error. If you do not specify
 either, AWS Elastic Beanstalk returns a
 MissingRequiredParameter error.
 
         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)
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 an
 InvalidParameterCombination error. If you do not specify
 either, AWS Elastic Beanstalk returns a
 MissingRequiredParameter error.
 
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 an
        InvalidParameterCombination error. If you do not
        specify either, AWS Elastic Beanstalk returns a
        MissingRequiredParameter error.
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.
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.
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)
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) or
 withOptionSettings(java.util.Collection) if you want to override
 the existing values.
 
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)
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.
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()
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
optionsToRemove - A list of custom user-defined configuration options to remove from
        the configuration set for this new environment.public CreateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove)
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) or
 withOptionsToRemove(java.util.Collection) if you want to
 override the existing values.
 
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)
A list of custom user-defined configuration options to remove from the configuration set for this new environment.
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 ObjectObject.toString()public CreateEnvironmentRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.