com.amazonaws.services.elasticbeanstalk.model

## クラス CreateEnvironmentRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class CreateEnvironmentRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `CreateEnvironment operation`.

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

  関連項目:
    `AWSElasticBeanstalk.createEnvironment(CreateEnvironmentRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CreateEnvironmentRequest()` Default constructor for a new CreateEnvironmentRequest object.
    `CreateEnvironmentRequest(java.lang.String applicationName, java.lang.String environmentName)` Constructs a new CreateEnvironmentRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getApplicationName()` The name of the application that contains the version to be deployed.
    `java.lang.String` | `getCNAMEPrefix()` If specified, the environment attempts to use this value as the prefix for the CNAME.
    `java.lang.String` | `getDescription()` Describes this environment.
    `java.lang.String` | `getEnvironmentName()` A unique name for the deployment environment.
    `java.util.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.
    `java.util.List<OptionSpecification>` | `getOptionsToRemove()` A list of custom user-defined configuration options to remove from the configuration set for this new environment.
    `java.lang.String` | `getSolutionStackName()` This is an alternative to specifying a configuration name.
    `java.lang.String` | `getTemplateName()` The name of the configuration template to use in deployment.
    `java.lang.String` | `getVersionLabel()` The name of the application version to deploy.
    `int` | `hashCode()`
    `void` | `setApplicationName(java.lang.String applicationName)` The name of the application that contains the version to be deployed.
    `void` | `setCNAMEPrefix(java.lang.String cNAMEPrefix)` If specified, the environment attempts to use this value as the prefix for the CNAME.
    `void` | `setDescription(java.lang.String description)` Describes this environment.
    `void` | `setEnvironmentName(java.lang.String environmentName)` A unique name for the deployment environment.
    `void` | `setOptionSettings(java.util.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(java.util.Collection<OptionSpecification> optionsToRemove)` A list of custom user-defined configuration options to remove from the configuration set for this new environment.
    `void` | `setSolutionStackName(java.lang.String solutionStackName)` This is an alternative to specifying a configuration name.
    `void` | `setTemplateName(java.lang.String templateName)` The name of the configuration template to use in deployment.
    `void` | `setVersionLabel(java.lang.String versionLabel)` The name of the application version to deploy.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `CreateEnvironmentRequest` | `withApplicationName(java.lang.String applicationName)` The name of the application that contains the version to be deployed.
    `CreateEnvironmentRequest` | `withCNAMEPrefix(java.lang.String cNAMEPrefix)` If specified, the environment attempts to use this value as the prefix for the CNAME.
    `CreateEnvironmentRequest` | `withDescription(java.lang.String description)` Describes this environment.
    `CreateEnvironmentRequest` | `withEnvironmentName(java.lang.String environmentName)` A unique name for the deployment environment.
    `CreateEnvironmentRequest` | `withOptionSettings(java.util.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(java.util.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(java.lang.String solutionStackName)` This is an alternative to specifying a configuration name.
    `CreateEnvironmentRequest` | `withTemplateName(java.lang.String templateName)` The name of the configuration template to use in deployment.
    `CreateEnvironmentRequest` | `withVersionLabel(java.lang.String versionLabel)` The name of the application version to deploy.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### 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(java.lang.String applicationName,
                                  java.lang.String environmentName)

      Constructs a new CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `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.

  - ### メソッドの詳細

    - #### getApplicationName

          public java.lang.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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### getVersionLabel

          public java.lang.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 most recently created application version.

      Constraints:
      Length: 1 - 100

      戻り値:
        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 most recently created application version.

    - #### setVersionLabel

          public void setVersionLabel(java.lang.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 most recently created application version.

      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 most recently created application version.

    - #### withVersionLabel

          public CreateEnvironmentRequest withVersionLabel(java.lang.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 most recently created application version.

      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 most recently created application version.

    - #### getEnvironmentName

          public java.lang.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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### getTemplateName

          public java.lang.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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### getSolutionStackName

          public java.lang.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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### getCNAMEPrefix

          public java.lang.String getCNAMEPrefix()

      If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

      Constraints:
      Length: 4 - 63

      戻り値:
        If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

    - #### setCNAMEPrefix

          public void setCNAMEPrefix(java.lang.String cNAMEPrefix)

      If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

      Constraints:
      Length: 4 - 63

      パラメータ:
        `cNAMEPrefix` - If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

    - #### withCNAMEPrefix

          public CreateEnvironmentRequest withCNAMEPrefix(java.lang.String cNAMEPrefix)

      If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name.

      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 environment uses the environment name.

    - #### getDescription

          public java.lang.String getDescription()

      Describes this environment.

      Constraints:
      Length: 0 - 200

      戻り値:
        Describes this environment.

    - #### setDescription

          public void setDescription(java.lang.String description)

      Describes this environment.

      Constraints:
      Length: 0 - 200

      パラメータ:
        `description` - Describes this environment.

    - #### withDescription

          public CreateEnvironmentRequest withDescription(java.lang.String description)

      Describes this environment.

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

      Constraints:
      Length: 0 - 200

      パラメータ:
        `description` - Describes this environment.

    - #### getOptionSettings

          public java.util.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.
      戻り値:
        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(java.util.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.

    - #### 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.

      パラメータ:
        `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(java.util.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.

      パラメータ:
        `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.

    - #### getOptionsToRemove

          public java.util.List<OptionSpecification> getOptionsToRemove()

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

    - #### setOptionsToRemove

          public void setOptionsToRemove(java.util.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.

    - #### 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.

      パラメータ:
        `optionsToRemove` - A list of custom user-defined configuration options to remove from the configuration set for this new environment.

    - #### withOptionsToRemove

          public CreateEnvironmentRequest withOptionsToRemove(java.util.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.

      パラメータ:
        `optionsToRemove` - A list of custom user-defined configuration options to remove from the configuration set for this new environment.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`