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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateEnvironmentMessage as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

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) —

    The ID of the environment to update.

#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) —

    The name of the environment to update.

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Returns:

  • (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.

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

Returns:

#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) —

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