Class CreateEnvironmentRequest

    • Constructor Detail

      • 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

        public CreateEnvironmentRequest​(String applicationName,
                                        String environmentName)
        Constructs a new CreateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
        Parameters:
        applicationName - The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

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

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

      • setApplicationName

        public void setApplicationName​(String applicationName)

        The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

        Parameters:
        applicationName - The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

      • getApplicationName

        public String getApplicationName()

        The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

        Returns:
        The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

      • withApplicationName

        public CreateEnvironmentRequest withApplicationName​(String applicationName)

        The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

        Parameters:
        applicationName - The name of the application that contains the version to be deployed.

        If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

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

        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.

        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

        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.

        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

        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.

        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

        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.

        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

        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.

        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

        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.

        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

        public void setDescription​(String description)

        Describes this environment.

        Parameters:
        description - Describes this environment.
      • getDescription

        public String getDescription()

        Describes this environment.

        Returns:
        Describes this environment.
      • withDescription

        public CreateEnvironmentRequest withDescription​(String description)

        Describes this environment.

        Parameters:
        description - Describes this environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCNAMEPrefix

        public void setCNAMEPrefix​(String cNAMEPrefix)

        If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

        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

        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.

        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

        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.

        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

        public void setTier​(EnvironmentTier tier)

        This specifies the tier to use for creating this environment.

        Parameters:
        tier - This specifies the tier to use for creating this environment.
      • getTier

        public EnvironmentTier getTier()

        This specifies the tier to use for creating this environment.

        Returns:
        This specifies the tier to use for creating this environment.
      • withTier

        public CreateEnvironmentRequest withTier​(EnvironmentTier tier)

        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

        public List<Tag> getTags()

        This specifies the tags applied to resources in the environment.

        Returns:
        This specifies the tags applied to resources in the environment.
      • setTags

        public void setTags​(Collection<Tag> tags)

        This specifies the tags applied to resources in the environment.

        Parameters:
        tags - This specifies the tags applied to resources in the environment.
      • withTags

        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.

        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

        public CreateEnvironmentRequest withTags​(Collection<Tag> tags)

        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

        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.

        Parameters:
        versionLabel - The name of the application version to deploy.

        If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

        Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

      • getVersionLabel

        public String getVersionLabel()

        The name of the application version to deploy.

        If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

        Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

        Returns:
        The name of the application version to deploy.

        If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

        Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

      • withVersionLabel

        public CreateEnvironmentRequest withVersionLabel​(String versionLabel)

        The name of the application version to deploy.

        If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

        Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

        Parameters:
        versionLabel - The name of the application version to deploy.

        If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

        Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

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

        public void setTemplateName​(String templateName)

        The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

        Parameters:
        templateName - The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

      • getTemplateName

        public String getTemplateName()

        The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

        Returns:
        The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

      • withTemplateName

        public CreateEnvironmentRequest withTemplateName​(String templateName)

        The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

        Parameters:
        templateName - The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

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

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

        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.

        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 an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

      • getSolutionStackName

        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.

        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 an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

      • withSolutionStackName

        public CreateEnvironmentRequest withSolutionStackName​(String solutionStackName)

        This is an alternative to specifying a 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.

        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 an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

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

        public List<ConfigurationOptionSetting> getOptionSettings()

        If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

        Returns:
        If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
      • setOptionSettings

        public void setOptionSettings​(Collection<ConfigurationOptionSetting> optionSettings)

        If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

        Parameters:
        optionSettings - If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
      • withOptionSettings

        public CreateEnvironmentRequest withOptionSettings​(ConfigurationOptionSetting... optionSettings)

        If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

        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.

        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

        public List<OptionSpecification> getOptionsToRemove()

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

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

        public void setOptionsToRemove​(Collection<OptionSpecification> optionsToRemove)

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

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

        public CreateEnvironmentRequest withOptionsToRemove​(OptionSpecification... optionsToRemove)

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

        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.

        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

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object