amazonka-amplify-2.0: Amazon Amplify SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Amplify.UpdateApp

Description

Updates an existing Amplify app.

Synopsis

Creating a Request

data UpdateApp Source #

The request structure for the update app request.

See: newUpdateApp smart constructor.

Constructors

UpdateApp' 

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 update an 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]

    Describes the automated branch creation glob patterns for an Amplify app.

  • basicAuthCredentials :: Maybe (Sensitive Text)

    The basic authorization credentials 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 redirect and rewrite 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.

  • enableBranchAutoBuild :: Maybe Bool

    Enables branch auto-building 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 for an Amplify app.

  • iamServiceRoleArn :: Maybe Text

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

  • name :: Maybe Text

    The name 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 update an 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 name of the repository for an Amplify app

  • appId :: Text

    The unique ID for an Amplify app.

Instances

Instances details
ToJSON UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

toJSON :: UpdateApp -> Value #

toEncoding :: UpdateApp -> Encoding #

toJSONList :: [UpdateApp] -> Value #

toEncodingList :: [UpdateApp] -> Encoding #

ToHeaders UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

toHeaders :: UpdateApp -> [Header] #

ToPath UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

toPath :: UpdateApp -> ByteString #

ToQuery UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

toQuery :: UpdateApp -> QueryString #

AWSRequest UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Associated Types

type AWSResponse UpdateApp #

Methods

request :: (Service -> Service) -> UpdateApp -> Request UpdateApp #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApp))) #

Generic UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Associated Types

type Rep UpdateApp :: Type -> Type #

Methods

from :: UpdateApp -> Rep UpdateApp x #

to :: Rep UpdateApp x -> UpdateApp #

Show UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

showsPrec :: Int -> UpdateApp -> ShowS #

show :: UpdateApp -> String #

showList :: [UpdateApp] -> ShowS #

NFData UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

rnf :: UpdateApp -> () #

Eq UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

(==) :: UpdateApp -> UpdateApp -> Bool #

(/=) :: UpdateApp -> UpdateApp -> Bool #

Hashable UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

hashWithSalt :: Int -> UpdateApp -> Int #

hash :: UpdateApp -> Int #

type AWSResponse UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

type AWSResponse UpdateApp = UpdateAppResponse
type Rep UpdateApp Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

type Rep UpdateApp = D1 ('MetaData "UpdateApp" "Amazonka.Amplify.UpdateApp" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateApp'" '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 "name") '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 "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateApp Source #

Arguments

:: Text

UpdateApp

-> UpdateApp 

Create a value of UpdateApp 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:UpdateApp', updateApp_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 update an 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 .

UpdateApp, updateApp_autoBranchCreationConfig - The automated branch creation configuration for an Amplify app.

UpdateApp, updateApp_autoBranchCreationPatterns - Describes the automated branch creation glob patterns for an Amplify app.

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

UpdateApp, updateApp_buildSpec - The build specification (build spec) for an Amplify app.

UpdateApp, updateApp_customHeaders - The custom HTTP headers for an Amplify app.

UpdateApp, updateApp_customRules - The custom redirect and rewrite rules for an Amplify app.

UpdateApp, updateApp_description - The description for an Amplify app.

UpdateApp, updateApp_enableAutoBranchCreation - Enables automated branch creation for an Amplify app.

UpdateApp, updateApp_enableBasicAuth - Enables basic authorization for an Amplify app.

UpdateApp, updateApp_enableBranchAutoBuild - Enables branch auto-building for an Amplify app.

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

UpdateApp, updateApp_environmentVariables - The environment variables for an Amplify app.

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

UpdateApp, updateApp_name - The name for an Amplify app.

$sel:oauthToken:UpdateApp', updateApp_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 update an 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 .

UpdateApp, updateApp_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.

UpdateApp, updateApp_repository - The name of the repository for an Amplify app

UpdateApp, updateApp_appId - The unique ID for an Amplify app.

Request Lenses

updateApp_accessToken :: Lens' UpdateApp (Maybe Text) Source #

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 update an 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 .

updateApp_autoBranchCreationConfig :: Lens' UpdateApp (Maybe AutoBranchCreationConfig) Source #

The automated branch creation configuration for an Amplify app.

updateApp_autoBranchCreationPatterns :: Lens' UpdateApp (Maybe [Text]) Source #

Describes the automated branch creation glob patterns for an Amplify app.

updateApp_basicAuthCredentials :: Lens' UpdateApp (Maybe Text) Source #

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

updateApp_buildSpec :: Lens' UpdateApp (Maybe Text) Source #

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

updateApp_customHeaders :: Lens' UpdateApp (Maybe Text) Source #

The custom HTTP headers for an Amplify app.

updateApp_customRules :: Lens' UpdateApp (Maybe [CustomRule]) Source #

The custom redirect and rewrite rules for an Amplify app.

updateApp_description :: Lens' UpdateApp (Maybe Text) Source #

The description for an Amplify app.

updateApp_enableAutoBranchCreation :: Lens' UpdateApp (Maybe Bool) Source #

Enables automated branch creation for an Amplify app.

updateApp_enableBasicAuth :: Lens' UpdateApp (Maybe Bool) Source #

Enables basic authorization for an Amplify app.

updateApp_enableBranchAutoBuild :: Lens' UpdateApp (Maybe Bool) Source #

Enables branch auto-building for an Amplify app.

updateApp_enableBranchAutoDeletion :: Lens' UpdateApp (Maybe Bool) Source #

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

updateApp_environmentVariables :: Lens' UpdateApp (Maybe (HashMap Text Text)) Source #

The environment variables for an Amplify app.

updateApp_iamServiceRoleArn :: Lens' UpdateApp (Maybe Text) Source #

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

updateApp_name :: Lens' UpdateApp (Maybe Text) Source #

The name for an Amplify app.

updateApp_oauthToken :: Lens' UpdateApp (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 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 update an 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 .

updateApp_platform :: Lens' UpdateApp (Maybe Platform) Source #

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.

updateApp_repository :: Lens' UpdateApp (Maybe Text) Source #

The name of the repository for an Amplify app

updateApp_appId :: Lens' UpdateApp Text Source #

The unique ID for an Amplify app.

Destructuring the Response

data UpdateAppResponse Source #

The result structure for an Amplify app update request.

See: newUpdateAppResponse smart constructor.

Constructors

UpdateAppResponse' 

Fields

Instances

Instances details
Generic UpdateAppResponse Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Associated Types

type Rep UpdateAppResponse :: Type -> Type #

Methods

from :: UpdateAppResponse -> Rep UpdateAppResponse x #

to :: Rep UpdateAppResponse x -> UpdateAppResponse #

Show UpdateAppResponse Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

showsPrec :: Int -> UpdateAppResponse -> ShowS #

show :: UpdateAppResponse -> String #

showList :: [UpdateAppResponse] -> ShowS #

NFData UpdateAppResponse Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

rnf :: UpdateAppResponse -> () #

Eq UpdateAppResponse Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

Methods

(==) :: UpdateAppResponse -> UpdateAppResponse -> Bool #

(/=) :: UpdateAppResponse -> UpdateAppResponse -> Bool #

type Rep UpdateAppResponse Source # 
Instance details

Defined in Amazonka.Amplify.UpdateApp

type Rep UpdateAppResponse = D1 ('MetaData "UpdateAppResponse" "Amazonka.Amplify.UpdateApp" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "app") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 App)))

newUpdateAppResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateAppResponse'

-> App

$sel:app:UpdateAppResponse'

-> UpdateAppResponse 

Create a value of UpdateAppResponse 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:UpdateAppResponse', updateAppResponse_httpStatus - The response's http status code.

$sel:app:UpdateAppResponse', updateAppResponse_app - Represents the updated Amplify app.

Response Lenses

updateAppResponse_httpStatus :: Lens' UpdateAppResponse Int Source #

The response's http status code.

updateAppResponse_app :: Lens' UpdateAppResponse App Source #

Represents the updated Amplify app.