Class: Aws::ElasticBeanstalk::Types::UpdateEnvironmentMessage

Inherits:

Struct

• Object
• Struct
• Aws::ElasticBeanstalk::Types::UpdateEnvironmentMessage

Includes:

Structure

Defined in:

lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Request to update an environment.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_name ⇒ String

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

• #description ⇒ String

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

• #environment_id ⇒ String

  The ID of the environment to update.

• #environment_name ⇒ String

  The name of the environment to update.

• #group_name ⇒ String

  The name of the group to which the target environment belongs.

• #option_settings ⇒ Array<Types::ConfigurationOptionSetting>

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

• #options_to_remove ⇒ Array<Types::OptionSpecification>

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

• #platform_arn ⇒ String

  The ARN of the platform, if used.

• #solution_stack_name ⇒ String

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

• #template_name ⇒ String

  If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.

• #tier ⇒ Types::EnvironmentTier

  This specifies the tier to use to update the environment.

• #version_label ⇒ String

  If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.

Instance Attribute Details

#application_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

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.

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#option_settings ⇒ Array<Types::ConfigurationOptionSetting>

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:

• (Array<Types::ConfigurationOptionSetting>)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#options_to_remove ⇒ Array<Types::OptionSpecification>

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

Returns:

• (Array<Types::OptionSpecification>)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#platform_arn ⇒ String

The ARN of the platform, if used.

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#solution_stack_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ Types::EnvironmentTier

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:

• (Types::EnvironmentTier)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end

#version_label ⇒ String

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:

• (String)

# File 'lib/aws-sdk-elasticbeanstalk/types.rb', line 4471

class UpdateEnvironmentMessage < Struct.new(
  :application_name,
  :environment_id,
  :environment_name,
  :group_name,
  :description,
  :tier,
  :version_label,
  :template_name,
  :solution_stack_name,
  :platform_arn,
  :option_settings,
  :options_to_remove)
  SENSITIVE = []
  include Aws::Structure
end