Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppConfig.CreateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

Synopsis

data CreateEnvironment = CreateEnvironment' {
- description :: Maybe Text
- monitors :: Maybe [Monitor]
- tags :: Maybe (HashMap Text Text)
- applicationId :: Text
- name :: Text
}
newCreateEnvironment :: Text -> Text -> CreateEnvironment
createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
createEnvironment_monitors :: Lens' CreateEnvironment (Maybe [Monitor])
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
createEnvironment_applicationId :: Lens' CreateEnvironment Text
createEnvironment_name :: Lens' CreateEnvironment Text
data Environment = Environment' {
- applicationId :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- monitors :: Maybe [Monitor]
- name :: Maybe Text
- state :: Maybe EnvironmentState
}
newEnvironment :: Environment
environment_applicationId :: Lens' Environment (Maybe Text)
environment_description :: Lens' Environment (Maybe Text)
environment_id :: Lens' Environment (Maybe Text)
environment_monitors :: Lens' Environment (Maybe [Monitor])
environment_name :: Lens' Environment (Maybe Text)
environment_state :: Lens' Environment (Maybe EnvironmentState)

Creating a Request

data CreateEnvironment Source #

See: newCreateEnvironment smart constructor.

Constructors

CreateEnvironment'

Fields

description :: Maybe Text
A description of the environment.
monitors :: Maybe [Monitor]
Amazon CloudWatch alarms to monitor during the deployment process.
tags :: Maybe (HashMap Text Text)
Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
applicationId :: Text
The application ID.
name :: Text
A name for the environment.

Instances

Instances details

ToJSON CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods toJSON :: CreateEnvironment -> Value # toEncoding :: CreateEnvironment -> Encoding # toJSONList :: [CreateEnvironment] -> Value # toEncodingList :: [CreateEnvironment] -> Encoding #
ToHeaders CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods toHeaders :: CreateEnvironment -> [Header] #
ToPath CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods toPath :: CreateEnvironment -> ByteString #
ToQuery CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods toQuery :: CreateEnvironment -> QueryString #
AWSRequest CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Associated Types type AWSResponse CreateEnvironment # Methods request :: (Service -> Service) -> CreateEnvironment -> Request CreateEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEnvironment))) #
Generic CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Associated Types type Rep CreateEnvironment :: Type -> Type # Methods from :: CreateEnvironment -> Rep CreateEnvironment x # to :: Rep CreateEnvironment x -> CreateEnvironment #
Read CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods readsPrec :: Int -> ReadS CreateEnvironment # readList :: ReadS [CreateEnvironment] # readPrec :: ReadPrec CreateEnvironment # readListPrec :: ReadPrec [CreateEnvironment] #
Show CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods showsPrec :: Int -> CreateEnvironment -> ShowS # show :: CreateEnvironment -> String # showList :: [CreateEnvironment] -> ShowS #
NFData CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods rnf :: CreateEnvironment -> () #
Eq CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods (==) :: CreateEnvironment -> CreateEnvironment -> Bool # (/=) :: CreateEnvironment -> CreateEnvironment -> Bool #
Hashable CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment Methods hashWithSalt :: Int -> CreateEnvironment -> Int # hash :: CreateEnvironment -> Int #
type AWSResponse CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment type AWSResponse CreateEnvironment = Environment
type Rep CreateEnvironment Source #
Instance details Defined in Amazonka.AppConfig.CreateEnvironment type Rep CreateEnvironment = D1 ('MetaData "CreateEnvironment" "Amazonka.AppConfig.CreateEnvironment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "CreateEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "monitors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Monitor]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateEnvironment Source #

Arguments

:: Text	`CreateEnvironment`
-> Text	`CreateEnvironment`
-> CreateEnvironment

Create a value of CreateEnvironment 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:

CreateEnvironment, createEnvironment_description - A description of the environment.

CreateEnvironment, createEnvironment_monitors - Amazon CloudWatch alarms to monitor during the deployment process.

$sel:tags:CreateEnvironment', createEnvironment_tags - Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

CreateEnvironment, createEnvironment_applicationId - The application ID.

CreateEnvironment, createEnvironment_name - A name for the environment.

Request Lenses

createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #

A description of the environment.

createEnvironment_monitors :: Lens' CreateEnvironment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms to monitor during the deployment process.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #

Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

createEnvironment_applicationId :: Lens' CreateEnvironment Text Source #

The application ID.

createEnvironment_name :: Lens' CreateEnvironment Text Source #

A name for the environment.

Destructuring the Response

data Environment Source #

See: newEnvironment smart constructor.

Constructors

Environment'

Fields

applicationId :: Maybe Text
The application ID.
description :: Maybe Text
The description of the environment.
id :: Maybe Text
The environment ID.
monitors :: Maybe [Monitor]
Amazon CloudWatch alarms monitored during the deployment.
name :: Maybe Text
The name of the environment.
state :: Maybe EnvironmentState
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Instances

Instances details

FromJSON Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #
Generic Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Associated Types type Rep Environment :: Type -> Type # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
Read Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods readsPrec :: Int -> ReadS Environment # readList :: ReadS [Environment] # readPrec :: ReadPrec Environment # readListPrec :: ReadPrec [Environment] #
Show Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
NFData Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods rnf :: Environment -> () #
Eq Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Hashable Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods hashWithSalt :: Int -> Environment -> Int # hash :: Environment -> Int #
type Rep Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment type Rep Environment = D1 ('MetaData "Environment" "Amazonka.AppConfig.Types.Environment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "monitors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Monitor])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentState))))))

newEnvironment :: Environment Source #

Create a value of Environment 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:applicationId:Environment', environment_applicationId - The application ID.

$sel:description:Environment', environment_description - The description of the environment.

$sel:id:Environment', environment_id - The environment ID.

$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.

$sel:name:Environment', environment_name - The name of the environment.

$sel:state:Environment', environment_state - The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Response Lenses

environment_applicationId :: Lens' Environment (Maybe Text) Source #

The application ID.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

environment_id :: Lens' Environment (Maybe Text) Source #

The environment ID.

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK