{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.ElasticBeanstalk.UpdateEnvironment -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 AWS Elastic Beanstalk returns an @InvalidParameterCombination@ -- error. -- -- When updating the configuration settings to a new template or individual -- settings, a draft configuration is created and -- DescribeConfigurationSettings for this environment returns two setting -- descriptions with different @DeploymentStatus@ values. module Amazonka.ElasticBeanstalk.UpdateEnvironment ( -- * Creating a Request UpdateEnvironment (..), newUpdateEnvironment, -- * Request Lenses updateEnvironment_applicationName, updateEnvironment_description, updateEnvironment_environmentId, updateEnvironment_environmentName, updateEnvironment_groupName, updateEnvironment_optionSettings, updateEnvironment_optionsToRemove, updateEnvironment_platformArn, updateEnvironment_solutionStackName, updateEnvironment_templateName, updateEnvironment_tier, updateEnvironment_versionLabel, -- * Destructuring the Response EnvironmentDescription (..), newEnvironmentDescription, -- * Response Lenses environmentDescription_abortableOperationInProgress, environmentDescription_applicationName, environmentDescription_cname, environmentDescription_dateCreated, environmentDescription_dateUpdated, environmentDescription_description, environmentDescription_endpointURL, environmentDescription_environmentArn, environmentDescription_environmentId, environmentDescription_environmentLinks, environmentDescription_environmentName, environmentDescription_health, environmentDescription_healthStatus, environmentDescription_operationsRole, environmentDescription_platformArn, environmentDescription_resources, environmentDescription_solutionStackName, environmentDescription_status, environmentDescription_templateName, environmentDescription_tier, environmentDescription_versionLabel, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.ElasticBeanstalk.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | Request to update an environment. -- -- /See:/ 'newUpdateEnvironment' smart constructor. data UpdateEnvironment = UpdateEnvironment' { -- | The name of the application with which the environment is associated. applicationName :: Prelude.Maybe Prelude.Text, -- | If this parameter is specified, AWS Elastic Beanstalk updates the -- description of this environment. description :: Prelude.Maybe Prelude.Text, -- | 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. environmentId :: Prelude.Maybe Prelude.Text, -- | 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. environmentName :: Prelude.Maybe Prelude.Text, -- | 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 -- -- for details. groupName :: Prelude.Maybe Prelude.Text, -- | If specified, AWS Elastic Beanstalk updates the configuration set -- associated with the running environment and sets the specified -- configuration options to the requested value. optionSettings :: Prelude.Maybe [ConfigurationOptionSetting], -- | A list of custom user-defined configuration options to remove from the -- configuration set for this environment. optionsToRemove :: Prelude.Maybe [OptionSpecification], -- | The ARN of the platform, if used. platformArn :: Prelude.Maybe Prelude.Text, -- | This specifies the platform version that the environment will run after -- the environment is updated. solutionStackName :: Prelude.Maybe Prelude.Text, -- | 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. templateName :: Prelude.Maybe Prelude.Text, -- | 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. tier :: Prelude.Maybe EnvironmentTier, -- | 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. versionLabel :: Prelude.Maybe Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'UpdateEnvironment' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'applicationName', 'updateEnvironment_applicationName' - The name of the application with which the environment is associated. -- -- 'description', 'updateEnvironment_description' - If this parameter is specified, AWS Elastic Beanstalk updates the -- description of this environment. -- -- 'environmentId', 'updateEnvironment_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. -- -- 'environmentName', 'updateEnvironment_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. -- -- 'groupName', 'updateEnvironment_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 -- -- for details. -- -- 'optionSettings', 'updateEnvironment_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. -- -- 'optionsToRemove', 'updateEnvironment_optionsToRemove' - A list of custom user-defined configuration options to remove from the -- configuration set for this environment. -- -- 'platformArn', 'updateEnvironment_platformArn' - The ARN of the platform, if used. -- -- 'solutionStackName', 'updateEnvironment_solutionStackName' - This specifies the platform version that the environment will run after -- the environment is updated. -- -- 'templateName', 'updateEnvironment_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. -- -- 'tier', 'updateEnvironment_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. -- -- 'versionLabel', 'updateEnvironment_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. newUpdateEnvironment :: UpdateEnvironment newUpdateEnvironment = UpdateEnvironment' { applicationName = Prelude.Nothing, description = Prelude.Nothing, environmentId = Prelude.Nothing, environmentName = Prelude.Nothing, groupName = Prelude.Nothing, optionSettings = Prelude.Nothing, optionsToRemove = Prelude.Nothing, platformArn = Prelude.Nothing, solutionStackName = Prelude.Nothing, templateName = Prelude.Nothing, tier = Prelude.Nothing, versionLabel = Prelude.Nothing } -- | The name of the application with which the environment is associated. updateEnvironment_applicationName :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_applicationName = Lens.lens (\UpdateEnvironment' {applicationName} -> applicationName) (\s@UpdateEnvironment' {} a -> s {applicationName = a} :: UpdateEnvironment) -- | If this parameter is specified, AWS Elastic Beanstalk updates the -- description of this environment. updateEnvironment_description :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_description = Lens.lens (\UpdateEnvironment' {description} -> description) (\s@UpdateEnvironment' {} a -> s {description = a} :: UpdateEnvironment) -- | 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. updateEnvironment_environmentId :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_environmentId = Lens.lens (\UpdateEnvironment' {environmentId} -> environmentId) (\s@UpdateEnvironment' {} a -> s {environmentId = a} :: UpdateEnvironment) -- | 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. updateEnvironment_environmentName :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_environmentName = Lens.lens (\UpdateEnvironment' {environmentName} -> environmentName) (\s@UpdateEnvironment' {} a -> s {environmentName = a} :: UpdateEnvironment) -- | 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 -- -- for details. updateEnvironment_groupName :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_groupName = Lens.lens (\UpdateEnvironment' {groupName} -> groupName) (\s@UpdateEnvironment' {} a -> s {groupName = a} :: UpdateEnvironment) -- | If specified, AWS Elastic Beanstalk updates the configuration set -- associated with the running environment and sets the specified -- configuration options to the requested value. updateEnvironment_optionSettings :: Lens.Lens' UpdateEnvironment (Prelude.Maybe [ConfigurationOptionSetting]) updateEnvironment_optionSettings = Lens.lens (\UpdateEnvironment' {optionSettings} -> optionSettings) (\s@UpdateEnvironment' {} a -> s {optionSettings = a} :: UpdateEnvironment) Prelude.. Lens.mapping Lens.coerced -- | A list of custom user-defined configuration options to remove from the -- configuration set for this environment. updateEnvironment_optionsToRemove :: Lens.Lens' UpdateEnvironment (Prelude.Maybe [OptionSpecification]) updateEnvironment_optionsToRemove = Lens.lens (\UpdateEnvironment' {optionsToRemove} -> optionsToRemove) (\s@UpdateEnvironment' {} a -> s {optionsToRemove = a} :: UpdateEnvironment) Prelude.. Lens.mapping Lens.coerced -- | The ARN of the platform, if used. updateEnvironment_platformArn :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_platformArn = Lens.lens (\UpdateEnvironment' {platformArn} -> platformArn) (\s@UpdateEnvironment' {} a -> s {platformArn = a} :: UpdateEnvironment) -- | This specifies the platform version that the environment will run after -- the environment is updated. updateEnvironment_solutionStackName :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_solutionStackName = Lens.lens (\UpdateEnvironment' {solutionStackName} -> solutionStackName) (\s@UpdateEnvironment' {} a -> s {solutionStackName = a} :: UpdateEnvironment) -- | 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. updateEnvironment_templateName :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_templateName = Lens.lens (\UpdateEnvironment' {templateName} -> templateName) (\s@UpdateEnvironment' {} a -> s {templateName = a} :: UpdateEnvironment) -- | 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. updateEnvironment_tier :: Lens.Lens' UpdateEnvironment (Prelude.Maybe EnvironmentTier) updateEnvironment_tier = Lens.lens (\UpdateEnvironment' {tier} -> tier) (\s@UpdateEnvironment' {} a -> s {tier = a} :: UpdateEnvironment) -- | 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. updateEnvironment_versionLabel :: Lens.Lens' UpdateEnvironment (Prelude.Maybe Prelude.Text) updateEnvironment_versionLabel = Lens.lens (\UpdateEnvironment' {versionLabel} -> versionLabel) (\s@UpdateEnvironment' {} a -> s {versionLabel = a} :: UpdateEnvironment) instance Core.AWSRequest UpdateEnvironment where type AWSResponse UpdateEnvironment = EnvironmentDescription request overrides = Request.postQuery (overrides defaultService) response = Response.receiveXMLWrapper "UpdateEnvironmentResult" (\s h x -> Data.parseXML x) instance Prelude.Hashable UpdateEnvironment where hashWithSalt _salt UpdateEnvironment' {..} = _salt `Prelude.hashWithSalt` applicationName `Prelude.hashWithSalt` description `Prelude.hashWithSalt` environmentId `Prelude.hashWithSalt` environmentName `Prelude.hashWithSalt` groupName `Prelude.hashWithSalt` optionSettings `Prelude.hashWithSalt` optionsToRemove `Prelude.hashWithSalt` platformArn `Prelude.hashWithSalt` solutionStackName `Prelude.hashWithSalt` templateName `Prelude.hashWithSalt` tier `Prelude.hashWithSalt` versionLabel instance Prelude.NFData UpdateEnvironment where rnf UpdateEnvironment' {..} = Prelude.rnf applicationName `Prelude.seq` Prelude.rnf description `Prelude.seq` Prelude.rnf environmentId `Prelude.seq` Prelude.rnf environmentName `Prelude.seq` Prelude.rnf groupName `Prelude.seq` Prelude.rnf optionSettings `Prelude.seq` Prelude.rnf optionsToRemove `Prelude.seq` Prelude.rnf platformArn `Prelude.seq` Prelude.rnf solutionStackName `Prelude.seq` Prelude.rnf templateName `Prelude.seq` Prelude.rnf tier `Prelude.seq` Prelude.rnf versionLabel instance Data.ToHeaders UpdateEnvironment where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath UpdateEnvironment where toPath = Prelude.const "/" instance Data.ToQuery UpdateEnvironment where toQuery UpdateEnvironment' {..} = Prelude.mconcat [ "Action" Data.=: ("UpdateEnvironment" :: Prelude.ByteString), "Version" Data.=: ("2010-12-01" :: Prelude.ByteString), "ApplicationName" Data.=: applicationName, "Description" Data.=: description, "EnvironmentId" Data.=: environmentId, "EnvironmentName" Data.=: environmentName, "GroupName" Data.=: groupName, "OptionSettings" Data.=: Data.toQuery ( Data.toQueryList "member" Prelude.<$> optionSettings ), "OptionsToRemove" Data.=: Data.toQuery ( Data.toQueryList "member" Prelude.<$> optionsToRemove ), "PlatformArn" Data.=: platformArn, "SolutionStackName" Data.=: solutionStackName, "TemplateName" Data.=: templateName, "Tier" Data.=: tier, "VersionLabel" Data.=: versionLabel ]