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.OpsWorks.CreateApp

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Synopsis

data CreateApp = CreateApp' {
- appSource :: Maybe Source
- attributes :: Maybe (HashMap AppAttributesKeys Text)
- dataSources :: Maybe [DataSource]
- description :: Maybe Text
- domains :: Maybe [Text]
- enableSsl :: Maybe Bool
- environment :: Maybe [EnvironmentVariable]
- shortname :: Maybe Text
- sslConfiguration :: Maybe SslConfiguration
- stackId :: Text
- name :: Text
- type' :: AppType
}
newCreateApp :: Text -> Text -> AppType -> CreateApp
createApp_appSource :: Lens' CreateApp (Maybe Source)
createApp_attributes :: Lens' CreateApp (Maybe (HashMap AppAttributesKeys Text))
createApp_dataSources :: Lens' CreateApp (Maybe [DataSource])
createApp_description :: Lens' CreateApp (Maybe Text)
createApp_domains :: Lens' CreateApp (Maybe [Text])
createApp_enableSsl :: Lens' CreateApp (Maybe Bool)
createApp_environment :: Lens' CreateApp (Maybe [EnvironmentVariable])
createApp_shortname :: Lens' CreateApp (Maybe Text)
createApp_sslConfiguration :: Lens' CreateApp (Maybe SslConfiguration)
createApp_stackId :: Lens' CreateApp Text
createApp_name :: Lens' CreateApp Text
createApp_type :: Lens' CreateApp AppType
data CreateAppResponse = CreateAppResponse' {
- appId :: Maybe Text
- httpStatus :: Int
}
newCreateAppResponse :: Int -> CreateAppResponse
createAppResponse_appId :: Lens' CreateAppResponse (Maybe Text)
createAppResponse_httpStatus :: Lens' CreateAppResponse Int

Creating a Request

data CreateApp Source #

See: newCreateApp smart constructor.

Constructors

CreateApp'

Fields

appSource :: Maybe Source
A Source object that specifies the app repository.
attributes :: Maybe (HashMap AppAttributesKeys Text)
One or more user-defined key/value pairs to be added to the stack attributes.
dataSources :: Maybe [DataSource]
The app's data source.
description :: Maybe Text
A description of the app.
domains :: Maybe [Text]
The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
enableSsl :: Maybe Bool
Whether to enable SSL for the app.
environment :: Maybe [EnvironmentVariable]
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
shortname :: Maybe Text
The app's short name.
sslConfiguration :: Maybe SslConfiguration
An SslConfiguration object with the SSL configuration.
stackId :: Text
The stack ID.
name :: Text
The app name.
type' :: AppType
The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

Instances

Instances details

ToJSON CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods toJSON :: CreateApp -> Value # toEncoding :: CreateApp -> Encoding # toJSONList :: [CreateApp] -> Value # toEncodingList :: [CreateApp] -> Encoding #
ToHeaders CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods toHeaders :: CreateApp -> [Header] #
ToPath CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods toPath :: CreateApp -> ByteString #
ToQuery CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods toQuery :: CreateApp -> QueryString #
AWSRequest CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Associated Types type AWSResponse CreateApp # Methods request :: (Service -> Service) -> CreateApp -> Request CreateApp # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApp))) #
Generic CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Associated Types type Rep CreateApp :: Type -> Type # Methods from :: CreateApp -> Rep CreateApp x # to :: Rep CreateApp x -> CreateApp #
Read CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods readsPrec :: Int -> ReadS CreateApp # readList :: ReadS [CreateApp] # readPrec :: ReadPrec CreateApp # readListPrec :: ReadPrec [CreateApp] #
Show CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods showsPrec :: Int -> CreateApp -> ShowS # show :: CreateApp -> String # showList :: [CreateApp] -> ShowS #
NFData CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods rnf :: CreateApp -> () #
Eq CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods (==) :: CreateApp -> CreateApp -> Bool # (/=) :: CreateApp -> CreateApp -> Bool #
Hashable CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods hashWithSalt :: Int -> CreateApp -> Int # hash :: CreateApp -> Int #
type AWSResponse CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp type AWSResponse CreateApp = CreateAppResponse
type Rep CreateApp Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.OpsWorks.CreateApp" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Source)) :: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap AppAttributesKeys Text))) :: S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSource])))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "enableSsl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentVariable])) :: (S1 ('MetaSel ('Just "shortname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sslConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SslConfiguration)))) :: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppType))))))

newCreateApp Source #

Arguments

:: Text	`CreateApp`
-> Text	`CreateApp`
-> AppType	`CreateApp`
-> CreateApp

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

CreateApp, createApp_appSource - A Source object that specifies the app repository.

CreateApp, createApp_attributes - One or more user-defined key/value pairs to be added to the stack attributes.

CreateApp, createApp_dataSources - The app's data source.

CreateApp, createApp_description - A description of the app.

CreateApp, createApp_domains - The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

CreateApp, createApp_enableSsl - Whether to enable SSL for the app.

CreateApp, createApp_environment - An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

CreateApp, createApp_shortname - The app's short name.

CreateApp, createApp_sslConfiguration - An SslConfiguration object with the SSL configuration.

CreateApp, createApp_stackId - The stack ID.

CreateApp, createApp_name - The app name.

CreateApp, createApp_type - The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

Request Lenses

createApp_appSource :: Lens' CreateApp (Maybe Source) Source #

A Source object that specifies the app repository.

createApp_attributes :: Lens' CreateApp (Maybe (HashMap AppAttributesKeys Text)) Source #

One or more user-defined key/value pairs to be added to the stack attributes.

createApp_dataSources :: Lens' CreateApp (Maybe [DataSource]) Source #

The app's data source.

createApp_description :: Lens' CreateApp (Maybe Text) Source #

A description of the app.

createApp_domains :: Lens' CreateApp (Maybe [Text]) Source #

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

createApp_enableSsl :: Lens' CreateApp (Maybe Bool) Source #

Whether to enable SSL for the app.

createApp_environment :: Lens' CreateApp (Maybe [EnvironmentVariable]) Source #

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

createApp_shortname :: Lens' CreateApp (Maybe Text) Source #

The app's short name.

createApp_sslConfiguration :: Lens' CreateApp (Maybe SslConfiguration) Source #

An SslConfiguration object with the SSL configuration.

createApp_stackId :: Lens' CreateApp Text Source #

The stack ID.

createApp_name :: Lens' CreateApp Text Source #

The app name.

createApp_type :: Lens' CreateApp AppType Source #

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

Destructuring the Response

data CreateAppResponse Source #

Contains the response to a CreateApp request.

See: newCreateAppResponse smart constructor.

Constructors

CreateAppResponse'
Fields appId :: Maybe Text The app ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Associated Types type Rep CreateAppResponse :: Type -> Type # Methods from :: CreateAppResponse -> Rep CreateAppResponse x # to :: Rep CreateAppResponse x -> CreateAppResponse #
Read CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods readsPrec :: Int -> ReadS CreateAppResponse # readList :: ReadS [CreateAppResponse] # readPrec :: ReadPrec CreateAppResponse # readListPrec :: ReadPrec [CreateAppResponse] #
Show CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods showsPrec :: Int -> CreateAppResponse -> ShowS # show :: CreateAppResponse -> String # showList :: [CreateAppResponse] -> ShowS #
NFData CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods rnf :: CreateAppResponse -> () #
Eq CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp Methods (==) :: CreateAppResponse -> CreateAppResponse -> Bool # (/=) :: CreateAppResponse -> CreateAppResponse -> Bool #
type Rep CreateAppResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateApp type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.OpsWorks.CreateApp" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "CreateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAppResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAppResponse'`
-> CreateAppResponse

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

CreateAppResponse, createAppResponse_appId - The app ID.

$sel:httpStatus:CreateAppResponse', createAppResponse_httpStatus - The response's http status code.

Response Lenses

createAppResponse_appId :: Lens' CreateAppResponse (Maybe Text) Source #

The app ID.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.