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.

Branch for an Amplify App, which maps to a 3rd 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.

Id of the active job for a branch, part of an Amplify App.

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

Gets and sets the property AssociatedResources.

List of custom resources that are linked to this branch.

Public Property BackendEnvironmentArn System.String

Gets and sets the property BackendEnvironmentArn.

ARN for a Backend Environment, part of an Amplify App.

Public Property BasicAuthCredentials System.String

Gets and sets the property BasicAuthCredentials.

Basic Authorization credentials for a branch, part of an Amplify App.

Public Property BranchArn System.String

Gets and sets the property BranchArn.

ARN for a branch, part of an Amplify App.

Public Property BranchName System.String

Gets and sets the property BranchName.

Name for a branch, part of an Amplify App.

Public Property BuildSpec System.String

Gets and sets the property BuildSpec.

BuildSpec content for branch for Amplify App.

Public Property CreateTime System.DateTime

Gets and sets the property CreateTime.

Creation date and time for a branch, part of an Amplify App.

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

Gets and sets the property CustomDomains.

Custom domains for a branch, part of an Amplify App.

Public Property Description System.String

Gets and sets the property Description.

Description for a branch, 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.

Display name for a branch, will use as the default domain prefix.

Public Property EnableAutoBuild System.Boolean

Gets and sets the property EnableAutoBuild.

Enables auto-building on push for a branch, part of an Amplify App.

Public Property EnableBasicAuth System.Boolean

Gets and sets the property EnableBasicAuth.

Enables Basic Authorization for a branch, part of an Amplify App.

Public Property EnableNotification System.Boolean

Gets and sets the property EnableNotification.

Enables notifications for a branch, part of an Amplify App.

Public Property EnablePullRequestPreview System.Boolean

Gets and sets the property EnablePullRequestPreview.

Enables Pull Request Preview for this branch.

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

Gets and sets the property EnvironmentVariables.

Environment Variables specific to a branch, part of an Amplify App.

Public Property Framework System.String

Gets and sets the property Framework.

Framework for a branch, part 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.

Stage for a branch, part of an Amplify App.

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

Gets and sets the property Tags.

Tag for branch for Amplify App.

Public Property ThumbnailUrl System.String

Gets and sets the property ThumbnailUrl.

Thumbnail URL for the branch.

Public Property TotalNumberOfJobs System.String

Gets and sets the property TotalNumberOfJobs.

Total number of Jobs part of an Amplify App.

Public Property Ttl System.String

Gets and sets the property Ttl.

The content TTL for the website in seconds.

Public Property UpdateTime System.DateTime

Gets and sets the property UpdateTime.

Last updated date and time for a branch, part of an Amplify App.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms