You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass UpdateEnvironmentMessage data as a hash:

{
  application_name: "ApplicationName",
  environment_id: "EnvironmentId",
  environment_name: "EnvironmentName",
  group_name: "GroupName",
  description: "Description",
  tier: {
    name: "String",
    type: "String",
    version: "String",
  },
  version_label: "VersionLabel",
  template_name: "ConfigurationTemplateName",
  solution_stack_name: "SolutionStackName",
  platform_arn: "PlatformArn",
  option_settings: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
      value: "ConfigurationOptionValue",
    },
  ],
  options_to_remove: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
    },
  ],
}

Request to update an environment.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#environment_idString

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)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#environment_nameString

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)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#group_nameString

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:

  • (String)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

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



4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#options_to_removeArray<Types::OptionSpecification>

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

Returns:



4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#platform_arnString

The ARN of the platform, if used.

Returns:

  • (String)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#solution_stack_nameString

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

Returns:

  • (String)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#template_nameString

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)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

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



4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end

#version_labelString

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)


4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4280

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)
  include Aws::Structure
end