Network.AWS.ElasticBeanstalk.TerminateEnvironment

Terminates the specified environment.

Creating a Request

terminateEnvironment :: TerminateEnvironment

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

Request to terminate an environment.

See: terminateEnvironment smart constructor.

Instances

Eq TerminateEnvironment

Methods

(==) :: TerminateEnvironment -> TerminateEnvironment -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS TerminateEnvironment

readList :: ReadS [TerminateEnvironment]

readPrec :: ReadPrec TerminateEnvironment

readListPrec :: ReadPrec [TerminateEnvironment]

Show TerminateEnvironment

Methods

showsPrec :: Int -> TerminateEnvironment -> ShowS

show :: TerminateEnvironment -> String

showList :: [TerminateEnvironment] -> ShowS

Generic TerminateEnvironment

Associated Types

type Rep TerminateEnvironment :: * -> *

Methods

from :: TerminateEnvironment -> Rep TerminateEnvironment x

to :: Rep TerminateEnvironment x -> TerminateEnvironment

Hashable TerminateEnvironment

Methods

hashWithSalt :: Int -> TerminateEnvironment -> Int

hash :: TerminateEnvironment -> Int

NFData TerminateEnvironment

Methods

rnf :: TerminateEnvironment -> ()

AWSRequest TerminateEnvironment

Associated Types

type Rs TerminateEnvironment :: *

Methods

request :: TerminateEnvironment -> Request TerminateEnvironment

response :: MonadResource m => Logger -> Service -> Proxy * TerminateEnvironment -> ClientResponse -> m (Response TerminateEnvironment)

ToPath TerminateEnvironment

Methods

toPath :: TerminateEnvironment -> ByteString

ToHeaders TerminateEnvironment

Methods

toHeaders :: TerminateEnvironment -> [Header]

ToQuery TerminateEnvironment

Methods

toQuery :: TerminateEnvironment -> QueryString

type Rep TerminateEnvironment

type Rep TerminateEnvironment = D1 (MetaData "TerminateEnvironment" "Network.AWS.ElasticBeanstalk.TerminateEnvironment" "amazonka-elasticbeanstalk-1.4.5-9zMrDsTBP1RFx5BKCNaBTX" False) (C1 (MetaCons "TerminateEnvironment'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_teForceTerminate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_teTerminateResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_teEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_teEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs TerminateEnvironment

type Rs TerminateEnvironment = EnvironmentDescription

Request Lenses

teForceTerminate :: Lens' TerminateEnvironment (Maybe Bool)

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

teTerminateResources :: Lens' TerminateEnvironment (Maybe Bool)

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)

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)

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

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.
• eTier - Describes the current tier of this environment.
• eEnvironmentName - The name of this environment.
• eApplicationName - The name of the application associated with this environment.
• 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

Methods

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

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

Data EnvironmentDescription

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

Methods

readsPrec :: Int -> ReadS EnvironmentDescription

readList :: ReadS [EnvironmentDescription]

readPrec :: ReadPrec EnvironmentDescription

readListPrec :: ReadPrec [EnvironmentDescription]

Show EnvironmentDescription

Methods

showsPrec :: Int -> EnvironmentDescription -> ShowS

show :: EnvironmentDescription -> String

showList :: [EnvironmentDescription] -> ShowS

Generic EnvironmentDescription

Associated Types

type Rep EnvironmentDescription :: * -> *

Methods

from :: EnvironmentDescription -> Rep EnvironmentDescription x

to :: Rep EnvironmentDescription x -> EnvironmentDescription

Hashable EnvironmentDescription

Methods

hashWithSalt :: Int -> EnvironmentDescription -> Int

hash :: EnvironmentDescription -> Int

NFData EnvironmentDescription

Methods

rnf :: EnvironmentDescription -> ()

FromXML EnvironmentDescription

Methods

parseXML :: [Node] -> Either String EnvironmentDescription

type Rep EnvironmentDescription

type Rep EnvironmentDescription = D1 (MetaData "EnvironmentDescription" "Network.AWS.ElasticBeanstalk.Types.Product" "amazonka-elasticbeanstalk-1.4.5-9zMrDsTBP1RFx5BKCNaBTX" False) (C1 (MetaCons "EnvironmentDescription'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentStatus))) (S1 (MetaSel (Just Symbol "_eCNAME") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_eTemplateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eAbortableOperationInProgress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eEndpointURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentResourcesDescription)))) ((:*:) (S1 (MetaSel (Just Symbol "_eDateUpdated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) ((:*:) (S1 (MetaSel (Just Symbol "_eDateCreated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_eHealth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealth))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eTier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentTier)))) ((:*:) (S1 (MetaSel (Just Symbol "_eEnvironmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eSolutionStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_eEnvironmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_eHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EnvironmentHealthStatus))) ((:*:) (S1 (MetaSel (Just Symbol "_eEnvironmentLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentLink]))) (S1 (MetaSel (Just Symbol "_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.

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.

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.