Values.UpdateAppRequestSourceThe request structure for the update app request.
type nonrec t = {appId : AppId.t;The unique ID for an Amplify app.
*)name : Name.t option;The name for an Amplify app.
*)description : Description.t option;The description for an Amplify app.
*)platform : Platform.t option;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. If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE.
*)computeRoleArn : ComputeRoleArn.t option;The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.
*)iamServiceRoleArn : ServiceRoleArn.t option;The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
*)environmentVariables : EnvironmentVariables.t option;The environment variables for an Amplify app.
*)enableBranchAutoBuild : EnableAutoBuild.t option;Enables branch auto-building for an Amplify app.
*)enableBranchAutoDeletion : EnableBranchAutoDeletion.t option;Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
*)enableBasicAuth : EnableBasicAuth.t option;Enables basic authorization for an Amplify app.
*)basicAuthCredentials : BasicAuthCredentials.t option;The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
*)customRules : CustomRules.t option;The custom redirect and rewrite rules for an Amplify app.
*)buildSpec : BuildSpec.t option;The build specification (build spec) for an Amplify app.
*)customHeaders : CustomHeaders.t option;The custom HTTP headers for an Amplify app.
*)enableAutoBranchCreation : EnableAutoBranchCreation.t option;Enables automated branch creation for an Amplify app.
*)autoBranchCreationPatterns : AutoBranchCreationPatterns.t option;Describes the automated branch creation glob patterns for an Amplify app.
*)autoBranchCreationConfig : AutoBranchCreationConfig.t option;The automated branch creation configuration for an Amplify app.
*)repository : Repository.t option;The name of the Git repository for an Amplify app.
*)oauthToken : OauthToken.t option;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 .
*)accessToken : AccessToken.t option;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 .
*)jobConfig : JobConfig.t option;Describes the configuration details that apply to the jobs for an Amplify app.
*)cacheConfig : CacheConfig.t option;The cache configuration for the Amplify app.
*)}val make :
?name:??? ->
?description:??? ->
?platform:??? ->
?computeRoleArn:??? ->
?iamServiceRoleArn:??? ->
?environmentVariables:??? ->
?enableBranchAutoBuild:??? ->
?enableBranchAutoDeletion:??? ->
?enableBasicAuth:??? ->
?basicAuthCredentials:??? ->
?customRules:??? ->
?buildSpec:??? ->
?customHeaders:??? ->
?enableAutoBranchCreation:??? ->
?autoBranchCreationPatterns:??? ->
?autoBranchCreationConfig:??? ->
?repository:??? ->
?oauthToken:??? ->
?accessToken:??? ->
?jobConfig:??? ->
?cacheConfig:??? ->
appId:AppId.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of EnableAutoBuild.t
| `Enum of string
| `List of
[> `String of AutoBranchCreationPattern.t
| `Structure of (string * [> `String of Source.t ]) list ]
list
| `Map of
([> `String of EnvKey.t ] * [> `String of EnvValue.t ]) list
| `String of AppId.t
| `Structure of
(string
* [> `Boolean of EnableAutoBuild.t
| `Enum of string
| `Map of
([> `String of EnvKey.t ] * [> `String of EnvValue.t ]) list
| `String of Framework.t ])
list ])
list ]