Amazonka.Amplify.CreateApp

Creates a new Amplify app.

Creating a Request

data CreateApp

The request structure used to create apps in Amplify.

See: newCreateApp smart constructor.

Constructors

CreateApp'

Fields

• accessToken :: Maybe (Sensitive Text)

  The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

  Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

  You must specify either accessToken or oauthToken when you create a new app.

  Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

• autoBranchCreationConfig :: Maybe AutoBranchCreationConfig

  The automated branch creation configuration for an Amplify app.

• autoBranchCreationPatterns :: Maybe [Text]

  The automated branch creation glob patterns for an Amplify app.

• basicAuthCredentials :: Maybe (Sensitive Text)

  The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

• buildSpec :: Maybe (Sensitive Text)

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

• customHeaders :: Maybe Text

  The custom HTTP headers for an Amplify app.

• customRules :: Maybe [CustomRule]

  The custom rewrite and redirect rules for an Amplify app.

• description :: Maybe Text

  The description 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.

• enableBranchAutoBuild :: Maybe Bool

  Enables the auto building of branches for an Amplify app.

• enableBranchAutoDeletion :: Maybe Bool

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

• environmentVariables :: Maybe (HashMap Text Text)

  The environment variables map for an Amplify app.

• iamServiceRoleArn :: Maybe Text

  The AWS Identity and Access Management (IAM) service role 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 using SSH cloning. The OAuth token is not stored.

  Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

  You must specify either oauthToken or accessToken when you create a new app.

  Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

• platform :: Maybe Platform

  The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

• repository :: Maybe Text

  The repository for an Amplify app.

• tags :: Maybe (HashMap Text Text)

  The tag for an Amplify app.

• name :: Text

  The name for an Amplify app.

Instances

ToJSON CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

toJSON :: CreateApp -> Value

toEncoding :: CreateApp -> Encoding

toJSONList :: [CreateApp] -> Value

toEncodingList :: [CreateApp] -> Encoding

ToHeaders CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

toHeaders :: CreateApp -> [Header]

ToPath CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

toPath :: CreateApp -> ByteString

ToQuery CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

toQuery :: CreateApp -> QueryString

AWSRequest CreateApp

Defined in Amazonka.Amplify.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

Defined in Amazonka.Amplify.CreateApp

Associated Types

type Rep CreateApp :: Type -> Type

Methods

from :: CreateApp -> Rep CreateApp x

to :: Rep CreateApp x -> CreateApp

Show CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

showsPrec :: Int -> CreateApp -> ShowS

show :: CreateApp -> String

showList :: [CreateApp] -> ShowS

NFData CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

rnf :: CreateApp -> ()

Eq CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

(==) :: CreateApp -> CreateApp -> Bool

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

Hashable CreateApp

Defined in Amazonka.Amplify.CreateApp

Methods

hashWithSalt :: Int -> CreateApp -> Int

hash :: CreateApp -> Int

type AWSResponse CreateApp

Defined in Amazonka.Amplify.CreateApp

type AWSResponse CreateApp = CreateAppResponse

type Rep CreateApp

Defined in Amazonka.Amplify.CreateApp

type Rep CreateApp = D1 ('MetaData "CreateApp" "Amazonka.Amplify.CreateApp" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateApp'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "autoBranchCreationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoBranchCreationConfig))) :*: (S1 ('MetaSel ('Just "autoBranchCreationPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "basicAuthCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "buildSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "customHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "customRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomRule])) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enableAutoBranchCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "enableBasicAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "enableBranchAutoBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "enableBranchAutoDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "environmentVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "iamServiceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "oauthToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Platform))) :*: (S1 ('MetaSel ('Just "repository") '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)))))))

newCreateApp

Arguments

:: Text

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:accessToken:CreateApp', createApp_accessToken - The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

CreateApp, createApp_autoBranchCreationConfig - The automated branch creation configuration for an Amplify app.

CreateApp, createApp_autoBranchCreationPatterns - The automated branch creation glob patterns for an Amplify app.

CreateApp, createApp_basicAuthCredentials - The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

CreateApp, createApp_buildSpec - The build specification (build spec) for an Amplify app.

CreateApp, createApp_customHeaders - The custom HTTP headers for an Amplify app.

CreateApp, createApp_customRules - The custom rewrite and redirect rules for an Amplify app.

CreateApp, createApp_description - The description for an Amplify app.

CreateApp, createApp_enableAutoBranchCreation - Enables automated branch creation for an Amplify app.

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

CreateApp, createApp_enableBranchAutoBuild - Enables the auto building of branches for an Amplify app.

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

CreateApp, createApp_environmentVariables - The environment variables map for an Amplify app.

CreateApp, createApp_iamServiceRoleArn - The AWS Identity and Access Management (IAM) service role 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 using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

CreateApp, createApp_platform - The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

CreateApp, createApp_repository - The repository for an Amplify app.

CreateApp, createApp_tags - The tag for an Amplify app.

CreateApp, createApp_name - The name for an Amplify app.

Request Lenses

createApp_accessToken :: Lens' CreateApp (Maybe Text)

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

createApp_autoBranchCreationConfig :: Lens' CreateApp (Maybe AutoBranchCreationConfig)

The automated branch creation configuration for an Amplify app.

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

The automated branch creation glob patterns for an Amplify app.

createApp_basicAuthCredentials :: Lens' CreateApp (Maybe Text)

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

createApp_buildSpec :: Lens' CreateApp (Maybe Text)

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

createApp_customHeaders :: Lens' CreateApp (Maybe Text)

The custom HTTP headers for an Amplify app.

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

The custom rewrite and redirect rules for an Amplify app.

createApp_description :: Lens' CreateApp (Maybe Text)

The description for an Amplify app.

createApp_enableAutoBranchCreation :: Lens' CreateApp (Maybe Bool)

Enables automated branch creation for an Amplify app.

createApp_enableBasicAuth :: Lens' CreateApp (Maybe Bool)

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

createApp_enableBranchAutoBuild :: Lens' CreateApp (Maybe Bool)

Enables the auto building of branches for an Amplify app.

createApp_enableBranchAutoDeletion :: Lens' CreateApp (Maybe Bool)

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

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

The environment variables map for an Amplify app.

createApp_iamServiceRoleArn :: Lens' CreateApp (Maybe Text)

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

createApp_oauthToken :: Lens' CreateApp (Maybe 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 using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

createApp_platform :: Lens' CreateApp (Maybe Platform)

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

createApp_repository :: Lens' CreateApp (Maybe Text)

The repository for an Amplify app.

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

The tag for an Amplify app.

createApp_name :: Lens' CreateApp Text

The name for an Amplify app.

Destructuring the Response

data CreateAppResponse

See: newCreateAppResponse smart constructor.

Constructors

CreateAppResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• app :: App

Instances

Generic CreateAppResponse

Defined in Amazonka.Amplify.CreateApp

Associated Types

type Rep CreateAppResponse :: Type -> Type

Methods

from :: CreateAppResponse -> Rep CreateAppResponse x

to :: Rep CreateAppResponse x -> CreateAppResponse

Show CreateAppResponse

Defined in Amazonka.Amplify.CreateApp

Methods

showsPrec :: Int -> CreateAppResponse -> ShowS

show :: CreateAppResponse -> String

showList :: [CreateAppResponse] -> ShowS

NFData CreateAppResponse

Defined in Amazonka.Amplify.CreateApp

Methods

rnf :: CreateAppResponse -> ()

Eq CreateAppResponse

Defined in Amazonka.Amplify.CreateApp

Methods

(==) :: CreateAppResponse -> CreateAppResponse -> Bool

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

type Rep CreateAppResponse

Defined in Amazonka.Amplify.CreateApp

type Rep CreateAppResponse = D1 ('MetaData "CreateAppResponse" "Amazonka.Amplify.CreateApp" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" '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

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

The response's http status code.

createAppResponse_app :: Lens' CreateAppResponse App

Undocumented member.