Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment¶

Description¶

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and describe_configuration_settings for this environment returns two setting descriptions with different DeploymentStatus values.

Usage¶

elasticbeanstalk_update_environment(ApplicationName, EnvironmentId,
  EnvironmentName, GroupName, Description, Tier, VersionLabel,
  TemplateName, SolutionStackName, PlatformArn, OptionSettings,
  OptionsToRemove)

Arguments¶

• ApplicationName

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

• EnvironmentId

  The ID of the environment to update.

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

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

• EnvironmentName

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

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

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

• Description

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

• Tier

  This specifies the tier to use to update the environment.

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

• VersionLabel

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

• TemplateName

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

• SolutionStackName

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

• PlatformArn

  The ARN of the platform, if used.

• OptionSettings

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

• OptionsToRemove

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

Value¶

A list with the following syntax:

list(
  EnvironmentName = "string",
  EnvironmentId = "string",
  ApplicationName = "string",
  VersionLabel = "string",
  SolutionStackName = "string",
  PlatformArn = "string",
  TemplateName = "string",
  Description = "string",
  EndpointURL = "string",
  CNAME = "string",
  DateCreated = as.POSIXct(
    "2015-01-01"
  ),
  DateUpdated = as.POSIXct(
    "2015-01-01"
  ),
  Status = "Aborting"|"Launching"|"Updating"|"LinkingFrom"|"LinkingTo"|"Ready"|"Terminating"|"Terminated",
  AbortableOperationInProgress = TRUE|FALSE,
  Health = "Green"|"Yellow"|"Red"|"Grey",
  HealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|"Suspended",
  Resources = list(
    LoadBalancer = list(
      LoadBalancerName = "string",
      Domain = "string",
      Listeners = list(
        list(
          Protocol = "string",
          Port = 123
        )
      )
    )
  ),
  Tier = list(
    Name = "string",
    Type = "string",
    Version = "string"
  ),
  EnvironmentLinks = list(
    list(
      LinkName = "string",
      EnvironmentName = "string"
    )
  ),
  EnvironmentArn = "string",
  OperationsRole = "string"
)

Request syntax¶

svc$update_environment(
  ApplicationName = "string",
  EnvironmentId = "string",
  EnvironmentName = "string",
  GroupName = "string",
  Description = "string",
  Tier = list(
    Name = "string",
    Type = "string",
    Version = "string"
  ),
  VersionLabel = "string",
  TemplateName = "string",
  SolutionStackName = "string",
  PlatformArn = "string",
  OptionSettings = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string",
      Value = "string"
    )
  ),
  OptionsToRemove = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string"
    )
  )
)

Examples¶

# The following operation updates an environment named "my-env" to version
# "v2" of the application to which it belongs:
svc$update_environment(
  EnvironmentName = "my-env",
  VersionLabel = "v2"
)

# The following operation configures several options in the
# aws:elb:loadbalancer namespace:
svc$update_environment(
  EnvironmentName = "my-env",
  OptionSettings = list(
    list(
      Namespace = "aws:elb:healthcheck",
      OptionName = "Interval",
      Value = "15"
    ),
    list(
      Namespace = "aws:elb:healthcheck",
      OptionName = "Timeout",
      Value = "8"
    ),
    list(
      Namespace = "aws:elb:healthcheck",
      OptionName = "HealthyThreshold",
      Value = "2"
    ),
    list(
      Namespace = "aws:elb:healthcheck",
      OptionName = "UnhealthyThreshold",
      Value = "3"
    )
  )
)