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.

The branch for an Amplify app, which maps to a third-party repository branch.

Inheritance Hierarchy

System.Object
  Amazon.Amplify.Model.Branch

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

Syntax

C#
public class Branch

The Branch type exposes the following members

Constructors

NameDescription
Public Method Branch()

Properties

NameTypeDescription
Public Property ActiveJobId System.String

Gets and sets the property ActiveJobId.

The ID of the active job for a branch of an Amplify app.

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

Gets and sets the property AssociatedResources.

A list of custom resources that are linked to this branch.

Public Property Backend Amazon.Amplify.Model.Backend

Gets and sets the property Backend.

Public Property BackendEnvironmentArn System.String

Gets and sets the property BackendEnvironmentArn.

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

Public Property BasicAuthCredentials System.String

Gets and sets the property BasicAuthCredentials.

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

Public Property BranchArn System.String

Gets and sets the property BranchArn.

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

Public Property BranchName System.String

Gets and sets the property BranchName.

The name for the branch that is part of an Amplify app.

Public Property BuildSpec System.String

Gets and sets the property BuildSpec.

The build specification (build spec) content for the branch of an Amplify app.

Public Property CreateTime System.DateTime

Gets and sets the property CreateTime.

The creation date and time for a branch that is part of an Amplify app.

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

Gets and sets the property CustomDomains.

The custom domains for a branch of an Amplify app.

Public Property Description System.String

Gets and sets the property Description.

The description for the branch that is part of an Amplify app.

Public Property DestinationBranch System.String

Gets and sets the property DestinationBranch.

The destination branch if the branch is a pull request branch.

Public Property DisplayName System.String

Gets and sets the property DisplayName.

The display name for the branch. This is used as the default domain prefix.

Public Property EnableAutoBuild System.Boolean

Gets and sets the property EnableAutoBuild.

Enables auto-building on push for a branch of an Amplify app.

Public Property EnableBasicAuth System.Boolean

Gets and sets the property EnableBasicAuth.

Enables basic authorization for a branch of an Amplify app.

Public Property EnableNotification System.Boolean

Gets and sets the property EnableNotification.

Enables notifications for a branch that is part of an Amplify app.

Public Property EnablePerformanceMode System.Boolean

Gets and sets the property EnablePerformanceMode.

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Public Property EnablePullRequestPreview System.Boolean

Gets and sets the property EnablePullRequestPreview.

Enables pull request previews for the branch.

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

Gets and sets the property EnvironmentVariables.

The environment variables specific to a branch of an Amplify app.

Public Property Framework System.String

Gets and sets the property Framework.

The framework for a branch of an Amplify app.

Public Property PullRequestEnvironmentName System.String

Gets and sets the property PullRequestEnvironmentName.

The Amplify environment name for the pull request.

Public Property SourceBranch System.String

Gets and sets the property SourceBranch.

The source branch if the branch is a pull request branch.

Public Property Stage Amazon.Amplify.Stage

Gets and sets the property Stage.

The current stage for the branch that is part of an Amplify app.

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

Gets and sets the property Tags.

The tag for the branch of an Amplify app.

Public Property ThumbnailUrl System.String

Gets and sets the property ThumbnailUrl.

The thumbnail URL for the branch of an Amplify app.

Public Property TotalNumberOfJobs System.String

Gets and sets the property TotalNumberOfJobs.

The total number of jobs that are part of an Amplify app.

Public Property Ttl System.String

Gets and sets the property Ttl.

The content Time to Live (TTL) for the website in seconds.

Public Property UpdateTime System.DateTime

Gets and sets the property UpdateTime.

The last updated date and time for a branch that is part of 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