AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateApp operation. Updates an existing Amplify app.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Amplify.AmazonAmplifyRequest
      Amazon.Amplify.Model.UpdateAppRequest

Namespace: Amazon.Amplify.Model
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateAppRequest : AmazonAmplifyRequest
         IAmazonWebServiceRequest

The UpdateAppRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateAppRequest()

Properties

NameTypeDescription
Public Property AccessToken System.String

Gets and sets the property 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 .

Public Property AppId System.String

Gets and sets the property AppId.

The unique ID for an Amplify app.

Public Property AutoBranchCreationConfig Amazon.Amplify.Model.AutoBranchCreationConfig

Gets and sets the property AutoBranchCreationConfig.

The automated branch creation configuration for an Amplify app.

Public Property AutoBranchCreationPatterns System.Collections.Generic.List<System.String>

Gets and sets the property AutoBranchCreationPatterns.

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

Public Property BasicAuthCredentials System.String

Gets and sets the property BasicAuthCredentials.

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

Public Property BuildSpec System.String

Gets and sets the property BuildSpec.

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

Public Property CustomHeaders System.String

Gets and sets the property CustomHeaders.

The custom HTTP headers for an Amplify app.

Public Property CustomRules System.Collections.Generic.List<Amazon.Amplify.Model.CustomRule>

Gets and sets the property CustomRules.

The custom redirect and rewrite rules for an Amplify app.

Public Property Description System.String

Gets and sets the property Description.

The description for an Amplify app.

Public Property EnableAutoBranchCreation System.Boolean

Gets and sets the property EnableAutoBranchCreation.

Enables automated branch creation for an Amplify app.

Public Property EnableBasicAuth System.Boolean

Gets and sets the property EnableBasicAuth.

Enables basic authorization for an Amplify app.

Public Property EnableBranchAutoBuild System.Boolean

Gets and sets the property EnableBranchAutoBuild.

Enables branch auto-building for an Amplify app.

Public Property EnableBranchAutoDeletion System.Boolean

Gets and sets the property EnableBranchAutoDeletion.

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

Public Property EnvironmentVariables System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property EnvironmentVariables.

The environment variables for an Amplify app.

Public Property IamServiceRoleArn System.String

Gets and sets the property IamServiceRoleArn.

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

Public Property Name System.String

Gets and sets the property Name.

The name for an Amplify app.

Public Property OauthToken System.String

Gets and sets the property 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 .

Public Property Platform Amazon.Amplify.Platform

Gets and sets the property 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.

Public Property Repository System.String

Gets and sets the property Repository.

The name of the Git repository for an Amplify app.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5