amazonka-elasticbeanstalk-1.6.1: Amazon Elastic Beanstalk SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElasticBeanstalk.TerminateEnvironment

Contents

Description

Terminates the specified environment.

Synopsis

Creating a Request

terminateEnvironment :: TerminateEnvironment Source #

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

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

  • teForceTerminate - Terminates the target environment even if another environment in the same group is dependent on it.
  • teTerminateResources - Indicates whether the associated AWS resources should shut down when the environment is terminated: * true : The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. * false : AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid Values: true | false
  • teEnvironmentName - The name of the environment to terminate. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
  • teEnvironmentId - The ID of the environment to terminate. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

data TerminateEnvironment Source #

Request to terminate an environment.

See: terminateEnvironment smart constructor.

Instances
Eq TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Data TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Methods

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

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

toConstr :: TerminateEnvironment -> Constr #

dataTypeOf :: TerminateEnvironment -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> TerminateEnvironment -> TerminateEnvironment #

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

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

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

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

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

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

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

Read TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Show TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Generic TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Associated Types

type Rep TerminateEnvironment :: Type -> Type #

Hashable TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

AWSRequest TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Associated Types

type Rs TerminateEnvironment :: Type #

ToHeaders TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

ToPath TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

ToQuery TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

NFData TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Methods

rnf :: TerminateEnvironment -> () #

type Rep TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

type Rep TerminateEnvironment = D1 (MetaData "TerminateEnvironment" "Network.AWS.ElasticBeanstalk.TerminateEnvironment" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "TerminateEnvironment'" PrefixI True) ((S1 (MetaSel (Just "_teForceTerminate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_teTerminateResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_teEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_teEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs TerminateEnvironment Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.TerminateEnvironment

Request Lenses

teForceTerminate :: Lens' TerminateEnvironment (Maybe Bool) Source #

Terminates the target environment even if another environment in the same group is dependent on it.

teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool) Source #

Indicates whether the associated AWS resources should shut down when the environment is terminated: * true : The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. * false : AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid Values: true | false

teEnvironmentName :: Lens' TerminateEnvironment (Maybe Text) Source #

The name of the environment to terminate. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

teEnvironmentId :: Lens' TerminateEnvironment (Maybe Text) Source #

The ID of the environment to terminate. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Destructuring the Response

environmentDescription :: EnvironmentDescription Source #

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

Describes the properties of an environment.

See: environmentDescription smart constructor.

Instances
Eq EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Data EnvironmentDescription Source # 
Instance details

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 Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Show EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Generic EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Associated Types

type Rep EnvironmentDescription :: Type -> Type #

Hashable EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

FromXML EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

NFData EnvironmentDescription Source # 
Instance details

Defined in Network.AWS.ElasticBeanstalk.Types.Product

Methods

rnf :: EnvironmentDescription -> () #

type Rep EnvironmentDescription Source # 
Instance details

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

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

The URL to the CNAME for this environment.

eTemplateName :: Lens' EnvironmentDescription (Maybe Text) Source #

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

eAbortableOperationInProgress :: Lens' EnvironmentDescription (Maybe Bool) Source #

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

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

The description of the AWS resources used by this environment.

eDateUpdated :: Lens' EnvironmentDescription (Maybe UTCTime) Source #

The last modified date for this environment.

eDateCreated :: Lens' EnvironmentDescription (Maybe UTCTime) Source #

The creation date for this environment.

eHealth :: Lens' EnvironmentDescription (Maybe EnvironmentHealth) Source #

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

The application version deployed in this environment.

eTier :: Lens' EnvironmentDescription (Maybe EnvironmentTier) Source #

Describes the current tier of this environment.

eEnvironmentName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of this environment.

eApplicationName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of the application associated with this environment.

eEnvironmentARN :: Lens' EnvironmentDescription (Maybe Text) Source #

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

eSolutionStackName :: Lens' EnvironmentDescription (Maybe Text) Source #

The name of the SolutionStack deployed with this environment.

eEnvironmentId :: Lens' EnvironmentDescription (Maybe Text) Source #

The ID of this environment.

eHealthStatus :: Lens' EnvironmentDescription (Maybe EnvironmentHealthStatus) Source #

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

eEnvironmentLinks :: Lens' EnvironmentDescription [EnvironmentLink] Source #

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

eDescription :: Lens' EnvironmentDescription (Maybe Text) Source #

Describes this environment.