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

Amazonka.ElasticBeanstalk.TerminateEnvironment

Description

Terminates the specified environment.

Synopsis

Creating a Request

data TerminateEnvironment Source #

Request to terminate an environment.

See: newTerminateEnvironment smart constructor.

Constructors

TerminateEnvironment' 

Fields

  • forceTerminate :: Maybe Bool

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

  • terminateResources :: 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

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

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

Instances

Instances details
Eq TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Read TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Show TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Generic TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Associated Types

type Rep TerminateEnvironment :: Type -> Type #

NFData TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Methods

rnf :: TerminateEnvironment -> () #

Hashable TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

AWSRequest TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

Associated Types

type AWSResponse TerminateEnvironment #

ToHeaders TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

ToPath TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

ToQuery TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

type Rep TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

type Rep TerminateEnvironment = D1 ('MetaData "TerminateEnvironment" "Amazonka.ElasticBeanstalk.TerminateEnvironment" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "TerminateEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forceTerminate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "terminateResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse TerminateEnvironment Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.TerminateEnvironment

newTerminateEnvironment :: TerminateEnvironment Source #

Create a value of TerminateEnvironment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forceTerminate:TerminateEnvironment', terminateEnvironment_forceTerminate - Terminates the target environment even if another environment in the same group is dependent on it.

$sel:terminateResources:TerminateEnvironment', terminateEnvironment_terminateResources - 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

$sel:environmentName:TerminateEnvironment', terminateEnvironment_environmentName - 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.

$sel:environmentId:TerminateEnvironment', terminateEnvironment_environmentId - 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.

Request Lenses

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

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

terminateEnvironment_terminateResources :: 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

terminateEnvironment_environmentName :: 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.

terminateEnvironment_environmentId :: 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

data EnvironmentDescription Source #

Describes the properties of an environment.

See: newEnvironmentDescription smart constructor.

Constructors

EnvironmentDescription' 

Fields

  • status :: 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.
  • cname :: Maybe Text

    The URL to the CNAME for this environment.

  • templateName :: Maybe Text

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

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

  • endpointURL :: Maybe Text

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

  • resources :: Maybe EnvironmentResourcesDescription

    The description of the AWS resources used by this environment.

  • dateUpdated :: Maybe ISO8601

    The last modified date for this environment.

  • dateCreated :: Maybe ISO8601

    The creation date for this environment.

  • health :: 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 RestartEnvironment request.

    Default: Grey

  • versionLabel :: Maybe Text

    The application version deployed in this environment.

  • operationsRole :: Maybe Text

    The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

  • platformArn :: Maybe Text

    The ARN of the platform version.

  • tier :: Maybe EnvironmentTier

    Describes the current tier of this environment.

  • environmentName :: Maybe Text

    The name of this environment.

  • applicationName :: Maybe Text

    The name of the application associated with this environment.

  • environmentArn :: Maybe Text

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

  • solutionStackName :: Maybe Text

    The name of the SolutionStack deployed with this environment.

  • environmentId :: Maybe Text

    The ID of this environment.

  • healthStatus :: Maybe EnvironmentHealthStatus

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

  • environmentLinks :: Maybe [EnvironmentLink]

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

  • description :: Maybe Text

    Describes this environment.

Instances

Instances details
Eq EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

Read EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

Show EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

Generic EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

Associated Types

type Rep EnvironmentDescription :: Type -> Type #

NFData EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

Methods

rnf :: EnvironmentDescription -> () #

Hashable EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

FromXML EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

type Rep EnvironmentDescription Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescription

type Rep EnvironmentDescription = D1 ('MetaData "EnvironmentDescription" "Amazonka.ElasticBeanstalk.Types.EnvironmentDescription" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "EnvironmentDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentStatus)) :*: S1 ('MetaSel ('Just "cname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "abortableOperationInProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "endpointURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentResourcesDescription)) :*: S1 ('MetaSel ('Just "dateUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "dateCreated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentHealth)) :*: S1 ('MetaSel ('Just "versionLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "operationsRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentTier)) :*: (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "solutionStackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "healthStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentHealthStatus)) :*: (S1 ('MetaSel ('Just "environmentLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentLink])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newEnvironmentDescription :: EnvironmentDescription Source #

Create a value of EnvironmentDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:EnvironmentDescription', environmentDescription_status - 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.

$sel:cname:EnvironmentDescription', environmentDescription_cname - The URL to the CNAME for this environment.

$sel:templateName:EnvironmentDescription', environmentDescription_templateName - The name of the configuration template used to originally launch this environment.

$sel:abortableOperationInProgress:EnvironmentDescription', environmentDescription_abortableOperationInProgress - 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.

$sel:endpointURL:EnvironmentDescription', environmentDescription_endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

$sel:resources:EnvironmentDescription', environmentDescription_resources - The description of the AWS resources used by this environment.

$sel:dateUpdated:EnvironmentDescription', environmentDescription_dateUpdated - The last modified date for this environment.

$sel:dateCreated:EnvironmentDescription', environmentDescription_dateCreated - The creation date for this environment.

$sel:health:EnvironmentDescription', environmentDescription_health - 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 RestartEnvironment request.

Default: Grey

$sel:versionLabel:EnvironmentDescription', environmentDescription_versionLabel - The application version deployed in this environment.

$sel:operationsRole:EnvironmentDescription', environmentDescription_operationsRole - The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

$sel:platformArn:EnvironmentDescription', environmentDescription_platformArn - The ARN of the platform version.

$sel:tier:EnvironmentDescription', environmentDescription_tier - Describes the current tier of this environment.

$sel:environmentName:EnvironmentDescription', environmentDescription_environmentName - The name of this environment.

$sel:applicationName:EnvironmentDescription', environmentDescription_applicationName - The name of the application associated with this environment.

$sel:environmentArn:EnvironmentDescription', environmentDescription_environmentArn - The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

$sel:solutionStackName:EnvironmentDescription', environmentDescription_solutionStackName - The name of the SolutionStack deployed with this environment.

$sel:environmentId:EnvironmentDescription', environmentDescription_environmentId - The ID of this environment.

$sel:healthStatus:EnvironmentDescription', environmentDescription_healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

$sel:environmentLinks:EnvironmentDescription', environmentDescription_environmentLinks - A list of links to other environments in the same group.

$sel:description:EnvironmentDescription', environmentDescription_description - Describes this environment.

Response Lenses

environmentDescription_status :: 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.

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

The URL to the CNAME for this environment.

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

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

environmentDescription_abortableOperationInProgress :: 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.

environmentDescription_endpointURL :: 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.

environmentDescription_resources :: Lens' EnvironmentDescription (Maybe EnvironmentResourcesDescription) Source #

The description of the AWS resources used by this environment.

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

The last modified date for this environment.

environmentDescription_health :: 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 RestartEnvironment request.

Default: Grey

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

The application version deployed in this environment.

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

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

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

Describes the current tier of this environment.

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

The name of the application associated with this environment.

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

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

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

The name of the SolutionStack deployed with this environment.

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

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

environmentDescription_environmentLinks :: Lens' EnvironmentDescription (Maybe [EnvironmentLink]) Source #

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