Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Amplify.CreateApp

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Amplify app.

Synopsis

data CreateApp = CreateApp' {
- enableBranchAutoBuild :: Maybe Bool
- oauthToken :: Maybe (Sensitive Text)
- accessToken :: Maybe (Sensitive Text)
- customHeaders :: Maybe Text
- platform :: Maybe Platform
- basicAuthCredentials :: Maybe (Sensitive Text)
- repository :: Maybe Text
- buildSpec :: Maybe Text
- enableBranchAutoDeletion :: Maybe Bool
- customRules :: Maybe [CustomRule]
- iamServiceRoleArn :: Maybe Text
- autoBranchCreationPatterns :: Maybe [Text]
- autoBranchCreationConfig :: Maybe AutoBranchCreationConfig
- environmentVariables :: Maybe (HashMap Text Text)
- enableAutoBranchCreation :: Maybe Bool
- enableBasicAuth :: Maybe Bool
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newCreateApp :: Text -> CreateApp
createApp_enableBranchAutoBuild :: Lens' CreateApp (Maybe Bool)
createApp_oauthToken :: Lens' CreateApp (Maybe Text)
createApp_accessToken :: Lens' CreateApp (Maybe Text)
createApp_customHeaders :: Lens' CreateApp (Maybe Text)
createApp_platform :: Lens' CreateApp (Maybe Platform)
createApp_basicAuthCredentials :: Lens' CreateApp (Maybe Text)
createApp_repository :: Lens' CreateApp (Maybe Text)
createApp_buildSpec :: Lens' CreateApp (Maybe Text)
createApp_enableBranchAutoDeletion :: Lens' CreateApp (Maybe Bool)
createApp_customRules :: Lens' CreateApp (Maybe [CustomRule])
createApp_iamServiceRoleArn :: Lens' CreateApp (Maybe Text)
createApp_autoBranchCreationPatterns :: Lens' CreateApp (Maybe [Text])
createApp_autoBranchCreationConfig :: Lens' CreateApp (Maybe AutoBranchCreationConfig)
createApp_environmentVariables :: Lens' CreateApp (Maybe (HashMap Text Text))
createApp_enableAutoBranchCreation :: Lens' CreateApp (Maybe Bool)
createApp_enableBasicAuth :: Lens' CreateApp (Maybe Bool)
createApp_description :: Lens' CreateApp (Maybe Text)
createApp_tags :: Lens' CreateApp (Maybe (HashMap Text Text))
createApp_name :: Lens' CreateApp Text
data CreateAppResponse = CreateAppResponse' {
- httpStatus :: Int
- app :: App
}
newCreateAppResponse :: Int -> App -> CreateAppResponse
createAppResponse_httpStatus :: Lens' CreateAppResponse Int
createAppResponse_app :: Lens' CreateAppResponse App

Creating a Request

data CreateApp Source #

The request structure used to create apps in Amplify.

See: newCreateApp smart constructor.

Constructors

CreateApp'

Fields

enableBranchAutoBuild :: Maybe Bool
Enables the auto building of branches for an Amplify app.
oauthToken :: Maybe (Sensitive Text)
The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
accessToken :: Maybe (Sensitive Text)
The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
customHeaders :: Maybe Text
The custom HTTP headers for an Amplify app.
platform :: Maybe Platform
The platform or framework for an Amplify app.
basicAuthCredentials :: Maybe (Sensitive Text)
The credentials for basic authorization for an Amplify app.
repository :: Maybe Text
The repository for an Amplify app.
buildSpec :: Maybe Text
The build specification (build spec) for an Amplify app.
enableBranchAutoDeletion :: Maybe Bool
Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
customRules :: Maybe [CustomRule]
The custom rewrite and redirect rules for an Amplify app.
iamServiceRoleArn :: Maybe Text
The AWS Identity and Access Management (IAM) service role for an Amplify app.
autoBranchCreationPatterns :: Maybe [Text]
The automated branch creation glob patterns for an Amplify app.
autoBranchCreationConfig :: Maybe AutoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
environmentVariables :: Maybe (HashMap Text Text)
The environment variables map for an Amplify app.
enableAutoBranchCreation :: Maybe Bool
Enables automated branch creation for an Amplify app.
enableBasicAuth :: Maybe Bool
Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
description :: Maybe Text
The description for an Amplify app.
tags :: Maybe (HashMap Text Text)
The tag for an Amplify app.
name :: Text
The name for an Amplify app.

Instances

Instances details

Eq CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods (==) :: CreateApp -> CreateApp -> Bool # (/=) :: CreateApp -> CreateApp -> Bool #
Show CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods showsPrec :: Int -> CreateApp -> ShowS # show :: CreateApp -> String # showList :: [CreateApp] -> ShowS #
Generic CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Associated Types type Rep CreateApp :: Type -> Type # Methods from :: CreateApp -> Rep CreateApp x # to :: Rep CreateApp x -> CreateApp #
NFData CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods rnf :: CreateApp -> () #
Hashable CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods hashWithSalt :: Int -> CreateApp -> Int # hash :: CreateApp -> Int #
ToJSON CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods toJSON :: CreateApp -> Value # toEncoding :: CreateApp -> Encoding # toJSONList :: [CreateApp] -> Value # toEncodingList :: [CreateApp] -> Encoding #
AWSRequest CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Associated Types type AWSResponse CreateApp # Methods request :: CreateApp -> Request CreateApp # response :: MonadResource m => Logger -> Service -> Proxy CreateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApp))) #
ToHeaders CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods toHeaders :: CreateApp -> [Header] #
ToPath CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods toPath :: CreateApp -> ByteString #
ToQuery CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods toQuery :: CreateApp -> QueryString #
type Rep CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.Amplify.CreateApp" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "enableBranchAutoBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "oauthToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "customHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Platform)) :: S1 ('MetaSel ('Just "basicAuthCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "buildSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableBranchAutoDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "customRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomRule])) :: S1 ('MetaSel ('Just "iamServiceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "autoBranchCreationPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "autoBranchCreationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoBranchCreationConfig)) :: S1 ('MetaSel ('Just "environmentVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "enableAutoBranchCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableBasicAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse CreateApp Source #
Instance details Defined in Amazonka.Amplify.CreateApp type AWSResponse CreateApp = CreateAppResponse

newCreateApp Source #

Arguments

:: Text	`$sel:name: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:

$sel:enableBranchAutoBuild:CreateApp', createApp_enableBranchAutoBuild - Enables the auto building of branches for an Amplify app.

$sel:oauthToken:CreateApp', createApp_oauthToken - The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

$sel:accessToken:CreateApp', createApp_accessToken - The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

$sel:customHeaders:CreateApp', createApp_customHeaders - The custom HTTP headers for an Amplify app.

$sel:platform:CreateApp', createApp_platform - The platform or framework for an Amplify app.

$sel:basicAuthCredentials:CreateApp', createApp_basicAuthCredentials - The credentials for basic authorization for an Amplify app.

$sel:repository:CreateApp', createApp_repository - The repository for an Amplify app.

$sel:buildSpec:CreateApp', createApp_buildSpec - The build specification (build spec) for an Amplify app.

$sel:enableBranchAutoDeletion:CreateApp', createApp_enableBranchAutoDeletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

$sel:customRules:CreateApp', createApp_customRules - The custom rewrite and redirect rules for an Amplify app.

$sel:iamServiceRoleArn:CreateApp', createApp_iamServiceRoleArn - The AWS Identity and Access Management (IAM) service role for an Amplify app.

$sel:autoBranchCreationPatterns:CreateApp', createApp_autoBranchCreationPatterns - The automated branch creation glob patterns for an Amplify app.

$sel:autoBranchCreationConfig:CreateApp', createApp_autoBranchCreationConfig - The automated branch creation configuration for an Amplify app.

$sel:environmentVariables:CreateApp', createApp_environmentVariables - The environment variables map for an Amplify app.

$sel:enableAutoBranchCreation:CreateApp', createApp_enableAutoBranchCreation - Enables automated branch creation for an Amplify app.

$sel:enableBasicAuth:CreateApp', createApp_enableBasicAuth - Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

$sel:description:CreateApp', createApp_description - The description for an Amplify app.

$sel:tags:CreateApp', createApp_tags - The tag for an Amplify app.

$sel:name:CreateApp', createApp_name - The name for an Amplify app.

Request Lenses

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

Enables the auto building of branches for an Amplify app.

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

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

The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

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

The custom HTTP headers for an Amplify app.

createApp_platform :: Lens' CreateApp (Maybe Platform) Source #

The platform or framework for an Amplify app.

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

The credentials for basic authorization for an Amplify app.

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

The repository for an Amplify app.

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

The build specification (build spec) for an Amplify app.

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

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

createApp_customRules :: Lens' CreateApp (Maybe [CustomRule]) Source #

The custom rewrite and redirect rules for an Amplify app.

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

The AWS Identity and Access Management (IAM) service role for an Amplify app.

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

The automated branch creation glob patterns for an Amplify app.

createApp_autoBranchCreationConfig :: Lens' CreateApp (Maybe AutoBranchCreationConfig) Source #

The automated branch creation configuration for an Amplify app.

createApp_environmentVariables :: Lens' CreateApp (Maybe (HashMap Text Text)) Source #

The environment variables map for an Amplify app.

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

Enables automated branch creation for an Amplify app.

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

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

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

The description for an Amplify app.

createApp_tags :: Lens' CreateApp (Maybe (HashMap Text Text)) Source #

The tag for an Amplify app.

createApp_name :: Lens' CreateApp Text Source #

The name for an Amplify app.

Destructuring the Response

data CreateAppResponse Source #

See: newCreateAppResponse smart constructor.

Constructors

CreateAppResponse'
Fields httpStatus :: Int The response's http status code. app :: App

Instances

Instances details

Eq CreateAppResponse Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods (==) :: CreateAppResponse -> CreateAppResponse -> Bool # (/=) :: CreateAppResponse -> CreateAppResponse -> Bool #
Show CreateAppResponse Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods showsPrec :: Int -> CreateAppResponse -> ShowS # show :: CreateAppResponse -> String # showList :: [CreateAppResponse] -> ShowS #
Generic CreateAppResponse Source #
Instance details Defined in Amazonka.Amplify.CreateApp Associated Types type Rep CreateAppResponse :: Type -> Type # Methods from :: CreateAppResponse -> Rep CreateAppResponse x # to :: Rep CreateAppResponse x -> CreateAppResponse #
NFData CreateAppResponse Source #
Instance details Defined in Amazonka.Amplify.CreateApp Methods rnf :: CreateAppResponse -> () #
type Rep CreateAppResponse Source #
Instance details Defined in Amazonka.Amplify.CreateApp type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.Amplify.CreateApp" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "CreateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "app") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 App)))

newCreateAppResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAppResponse'`
-> App	`$sel:app: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:

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

$sel:app:CreateAppResponse', createAppResponse_app - Undocumented member.

Response Lenses

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

createAppResponse_app :: Lens' CreateAppResponse App Source #

Undocumented member.