Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, ElasticBeanstalkRequest.Builder, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateEnvironmentRequest
@Mutable @NotThreadSafe public static interface UpdateEnvironmentRequest.Builder extends ElasticBeanstalkRequest.Builder, SdkPojo, CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

  • Method Details

    • applicationName

      UpdateEnvironmentRequest.Builder applicationName(String applicationName)

      The name of the application with which the environment is associated.

      Parameters:
      applicationName - The name of the application with which the environment is associated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentId

      UpdateEnvironmentRequest.Builder environmentId(String environmentId)

      The ID of the environment to update.

      If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentId - The ID of the environment to update.

      If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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

    • environmentName

      UpdateEnvironmentRequest.Builder environmentName(String environmentName)

      The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

      Parameters:
      environmentName - The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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

    • groupName

      UpdateEnvironmentRequest.Builder groupName(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 or environment ID parameters. 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 or environment ID parameters. See Environment Manifest (env.yaml) for details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateEnvironmentRequest.Builder description(String description)

      If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

      Parameters:
      description - If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tier

      UpdateEnvironmentRequest.Builder tier(EnvironmentTier tier)

      This specifies the tier to use to update the environment.

      Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

      Parameters:
      tier - This specifies the tier to use to update the environment.

      Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

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

    • tier

      default UpdateEnvironmentRequest.Builder tier(Consumer<EnvironmentTier.Builder> tier)

      This specifies the tier to use to update the environment.

      Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

      This is a convenience method that creates an instance of the EnvironmentTier.Builder avoiding the need to create one manually via EnvironmentTier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tier(EnvironmentTier).

      Parameters:
      tier - a consumer that will call methods on EnvironmentTier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • versionLabel

      UpdateEnvironmentRequest.Builder versionLabel(String versionLabel)

      If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

      Parameters:
      versionLabel - If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateName

      UpdateEnvironmentRequest.Builder templateName(String templateName)

      If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Parameters:
      templateName - If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • solutionStackName

      UpdateEnvironmentRequest.Builder solutionStackName(String solutionStackName)

      This specifies the platform version that the environment will run after the environment is updated.

      Parameters:
      solutionStackName - This specifies the platform version that the environment will run after the environment is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformArn

      UpdateEnvironmentRequest.Builder platformArn(String platformArn)

      The ARN of the platform, if used.

      Parameters:
      platformArn - The ARN of the platform, if used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionSettings

      UpdateEnvironmentRequest.Builder optionSettings(Collection<ConfigurationOptionSetting> optionSettings)

      If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

      Parameters:
      optionSettings - If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionSettings

      UpdateEnvironmentRequest.Builder optionSettings(ConfigurationOptionSetting... optionSettings)

      If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

      Parameters:
      optionSettings - If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionSettings

      UpdateEnvironmentRequest.Builder optionSettings(Consumer<ConfigurationOptionSetting.Builder>... optionSettings)

      If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

      This is a convenience method that creates an instance of the ConfigurationOptionSetting.Builder avoiding the need to create one manually via ConfigurationOptionSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to optionSettings(List<ConfigurationOptionSetting>).

      Parameters:
      optionSettings - a consumer that will call methods on ConfigurationOptionSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • optionsToRemove

      UpdateEnvironmentRequest.Builder optionsToRemove(Collection<OptionSpecification> optionsToRemove)

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

      Parameters:
      optionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionsToRemove

      UpdateEnvironmentRequest.Builder optionsToRemove(OptionSpecification... optionsToRemove)

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

      Parameters:
      optionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optionsToRemove

      UpdateEnvironmentRequest.Builder optionsToRemove(Consumer<OptionSpecification.Builder>... optionsToRemove)

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

      This is a convenience method that creates an instance of the OptionSpecification.Builder avoiding the need to create one manually via OptionSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to optionsToRemove(List<OptionSpecification>).

      Parameters:
      optionsToRemove - a consumer that will call methods on OptionSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.