Network.AWS.ElasticBeanstalk.UpdateEnvironment

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.

Creating a Request

updateEnvironment :: UpdateEnvironment

Creates a value of UpdateEnvironment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ueTemplateName - 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.
• ueOptionsToRemove - A list of custom user-defined configuration options to remove from the configuration set for this environment.
• ueOptionSettings - If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
• ueVersionLabel - 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.
• uePlatformARN - The ARN of the platform, if used.
• ueTier - 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.
• ueEnvironmentName - 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.
• ueApplicationName - The name of the application with which the environment is associated.
• ueSolutionStackName - This specifies the platform version that the environment will run after the environment is updated.
• ueEnvironmentId - 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.
• ueGroupName - 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.
• ueDescription - If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

data UpdateEnvironment

Request to update an environment.

See: updateEnvironment smart constructor.

Instances

Eq UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

(==) :: UpdateEnvironment -> UpdateEnvironment -> Bool

(/=) :: UpdateEnvironment -> UpdateEnvironment -> Bool

Data UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateEnvironment -> c UpdateEnvironment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateEnvironment

toConstr :: UpdateEnvironment -> Constr

dataTypeOf :: UpdateEnvironment -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateEnvironment)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateEnvironment)

gmapT :: (forall b. Data b => b -> b) -> UpdateEnvironment -> UpdateEnvironment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateEnvironment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateEnvironment -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateEnvironment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateEnvironment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateEnvironment -> m UpdateEnvironment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateEnvironment -> m UpdateEnvironment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateEnvironment -> m UpdateEnvironment

Read UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

readsPrec :: Int -> ReadS UpdateEnvironment

readList :: ReadS [UpdateEnvironment]

readPrec :: ReadPrec UpdateEnvironment

readListPrec :: ReadPrec [UpdateEnvironment]

Show UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

showsPrec :: Int -> UpdateEnvironment -> ShowS

show :: UpdateEnvironment -> String

showList :: [UpdateEnvironment] -> ShowS

Generic UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Associated Types

type Rep UpdateEnvironment :: Type -> Type

Methods

from :: UpdateEnvironment -> Rep UpdateEnvironment x

to :: Rep UpdateEnvironment x -> UpdateEnvironment

Hashable UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

hashWithSalt :: Int -> UpdateEnvironment -> Int

hash :: UpdateEnvironment -> Int

AWSRequest UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Associated Types

type Rs UpdateEnvironment :: Type

Methods

request :: UpdateEnvironment -> Request UpdateEnvironment

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateEnvironment -> ClientResponse -> m (Response UpdateEnvironment)

ToHeaders UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

toHeaders :: UpdateEnvironment -> [Header]

ToPath UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

toPath :: UpdateEnvironment -> ByteString

ToQuery UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

toQuery :: UpdateEnvironment -> QueryString

NFData UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

Methods

rnf :: UpdateEnvironment -> ()

type Rep UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

type Rep UpdateEnvironment = D1 (MetaData "UpdateEnvironment" "Network.AWS.ElasticBeanstalk.UpdateEnvironment" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "UpdateEnvironment'" PrefixI True) (((S1 (MetaSel (Just "_ueTemplateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ueOptionsToRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [OptionSpecification])) :*: S1 (MetaSel (Just "_ueOptionSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ConfigurationOptionSetting])))) :*: (S1 (MetaSel (Just "_ueVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uePlatformARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ueTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentTier))))) :*: ((S1 (MetaSel (Just "_ueEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ueApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ueSolutionStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_ueEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ueGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ueDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs UpdateEnvironment

Defined in Network.AWS.ElasticBeanstalk.UpdateEnvironment

type Rs UpdateEnvironment = EnvironmentDescription

Request Lenses

ueTemplateName :: Lens' UpdateEnvironment (Maybe 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.

ueOptionsToRemove :: Lens' UpdateEnvironment [OptionSpecification]

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

ueOptionSettings :: Lens' UpdateEnvironment [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.

ueVersionLabel :: Lens' UpdateEnvironment (Maybe Text)

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.

uePlatformARN :: Lens' UpdateEnvironment (Maybe Text)

The ARN of the platform, if used.

ueTier :: Lens' UpdateEnvironment (Maybe 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.

ueEnvironmentName :: Lens' UpdateEnvironment (Maybe 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.

ueApplicationName :: Lens' UpdateEnvironment (Maybe Text)

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

ueSolutionStackName :: Lens' UpdateEnvironment (Maybe Text)

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

ueEnvironmentId :: Lens' UpdateEnvironment (Maybe 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.

ueGroupName :: Lens' UpdateEnvironment (Maybe 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 Environment Manifest (env.yaml) for details.

ueDescription :: Lens' UpdateEnvironment (Maybe Text)

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

Destructuring the Response

environmentDescription :: EnvironmentDescription

Creates a value of EnvironmentDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eStatus - The current operational status of the environment: * Launching : Environment is in the process of initial deployment. * Updating : Environment is in the process of updating its configuration settings or application version. * Ready : Environment is available to have an action performed on it, such as update or terminate. * Terminating : Environment is in the shut-down process. * Terminated : Environment is not running.
• eCNAME - The URL to the CNAME for this environment.
• eTemplateName - The name of the configuration template used to originally launch this environment.
• eAbortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.
• eEndpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
• eResources - The description of the AWS resources used by this environment.
• eDateUpdated - The last modified date for this environment.
• eDateCreated - The creation date for this environment.
• eHealth - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: * Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. * Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. * Green : Indicates the environment is healthy and fully functional. * Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request. Default: Grey
• eVersionLabel - The application version deployed in this environment.
• ePlatformARN - The ARN of the platform.
• eTier - Describes the current tier of this environment.
• eEnvironmentName - The name of this environment.
• eApplicationName - The name of the application associated with this environment.
• eEnvironmentARN - The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
• eSolutionStackName - The name of the SolutionStack deployed with this environment.
• eEnvironmentId - The ID of this environment.
• eHealthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .
• eEnvironmentLinks - A list of links to other environments in the same group.
• eDescription - Describes this environment.

data EnvironmentDescription

Describes the properties of an environment.

See: environmentDescription smart constructor.

Instances

Eq EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

(==) :: EnvironmentDescription -> EnvironmentDescription -> Bool

(/=) :: EnvironmentDescription -> EnvironmentDescription -> Bool

Data EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnvironmentDescription -> c EnvironmentDescription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnvironmentDescription

toConstr :: EnvironmentDescription -> Constr

dataTypeOf :: EnvironmentDescription -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EnvironmentDescription)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnvironmentDescription)

gmapT :: (forall b. Data b => b -> b) -> EnvironmentDescription -> EnvironmentDescription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescription -> r

gmapQ :: (forall d. Data d => d -> u) -> EnvironmentDescription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EnvironmentDescription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescription -> m EnvironmentDescription

Read EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

readsPrec :: Int -> ReadS EnvironmentDescription

readList :: ReadS [EnvironmentDescription]

readPrec :: ReadPrec EnvironmentDescription

readListPrec :: ReadPrec [EnvironmentDescription]

Show EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

showsPrec :: Int -> EnvironmentDescription -> ShowS

show :: EnvironmentDescription -> String

showList :: [EnvironmentDescription] -> ShowS

Generic EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Associated Types

type Rep EnvironmentDescription :: Type -> Type

Methods

from :: EnvironmentDescription -> Rep EnvironmentDescription x

to :: Rep EnvironmentDescription x -> EnvironmentDescription

Hashable EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

hashWithSalt :: Int -> EnvironmentDescription -> Int

hash :: EnvironmentDescription -> Int

FromXML EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

parseXML :: [Node] -> Either String EnvironmentDescription

NFData EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

rnf :: EnvironmentDescription -> ()

type Rep EnvironmentDescription

Defined in Network.AWS.ElasticBeanstalk.Types.Product

type Rep EnvironmentDescription = D1 (MetaData "EnvironmentDescription" "Network.AWS.ElasticBeanstalk.Types.Product" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "EnvironmentDescription'" PrefixI True) ((((S1 (MetaSel (Just "_eStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentStatus)) :*: S1 (MetaSel (Just "_eCNAME") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_eTemplateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_eAbortableOperationInProgress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_eEndpointURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_eResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentResourcesDescription)) :*: S1 (MetaSel (Just "_eDateUpdated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 (MetaSel (Just "_eDateCreated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 (MetaSel (Just "_eHealth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealth)) :*: S1 (MetaSel (Just "_eVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_ePlatformARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentTier))) :*: (S1 (MetaSel (Just "_eEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_eApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eEnvironmentARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_eSolutionStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_eHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealthStatus)) :*: (S1 (MetaSel (Just "_eEnvironmentLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentLink])) :*: S1 (MetaSel (Just "_eDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

Response Lenses

eStatus :: Lens' EnvironmentDescription (Maybe EnvironmentStatus)

The current operational status of the environment: * Launching : Environment is in the process of initial deployment. * Updating : Environment is in the process of updating its configuration settings or application version. * Ready : Environment is available to have an action performed on it, such as update or terminate. * Terminating : Environment is in the shut-down process. * Terminated : Environment is not running.

eCNAME :: Lens' EnvironmentDescription (Maybe Text)

The URL to the CNAME for this environment.

eTemplateName :: Lens' EnvironmentDescription (Maybe Text)

The name of the configuration template used to originally launch this environment.

eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool)

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.

eEndpointURL :: Lens' EnvironmentDescription (Maybe Text)

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

eResources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription)

The description of the AWS resources used by this environment.

eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime)

The last modified date for this environment.

eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime)

The creation date for this environment.

eHealth :: Lens' EnvironmentDescription (Maybe EnvironmentHealth)

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: * Red : Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. * Yellow : Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. * Green : Indicates the environment is healthy and fully functional. * Grey : Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request. Default: Grey

eVersionLabel :: Lens' EnvironmentDescription (Maybe Text)

The application version deployed in this environment.

ePlatformARN :: Lens' EnvironmentDescription (Maybe Text)

The ARN of the platform.

eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier)

Describes the current tier of this environment.

eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text)

The name of this environment.

eApplicationName :: Lens' EnvironmentDescription (Maybe Text)

The name of the application associated with this environment.

eEnvironmentARN :: Lens' EnvironmentDescription (Maybe Text)

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text)

The name of the SolutionStack deployed with this environment.

eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text)

The ID of this environment.

eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus)

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses .

eEnvironmentLinks :: Lens' EnvironmentDescription [EnvironmentLink]

A list of links to other environments in the same group.

eDescription :: Lens' EnvironmentDescription (Maybe Text)

Describes this environment.