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.
Namespace: Amazon.Amplify.Model
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z
public class Branch
The Branch type exposes the following members
Name | Description | |
---|---|---|
Branch() |
Name | Type | Description | |
---|---|---|---|
ActiveJobId | System.String |
Gets and sets the property ActiveJobId. The ID of the active job for a branch of an Amplify app. |
|
AssociatedResources | System.Collections.Generic.List<System.String> |
Gets and sets the property AssociatedResources. A list of custom resources that are linked to this branch. |
|
Backend | Amazon.Amplify.Model.Backend |
Gets and sets the property Backend. |
|
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. |
|
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 |
|
BranchArn | System.String |
Gets and sets the property BranchArn. The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. |
|
BranchName | System.String |
Gets and sets the property BranchName. The name for the branch that is part of an Amplify app. |
|
BuildSpec | System.String |
Gets and sets the property BuildSpec. The build specification (build spec) content for the branch of an Amplify app. |
|
CreateTime | System.DateTime |
Gets and sets the property CreateTime. The creation date and time for a branch that is part of an Amplify app. |
|
CustomDomains | System.Collections.Generic.List<System.String> |
Gets and sets the property CustomDomains. The custom domains for a branch of an Amplify app. |
|
Description | System.String |
Gets and sets the property Description. The description for the branch that is part of an Amplify app. |
|
DestinationBranch | System.String |
Gets and sets the property DestinationBranch. The destination branch if the branch is a pull request branch. |
|
DisplayName | System.String |
Gets and sets the property DisplayName. The display name for the branch. This is used as the default domain prefix. |
|
EnableAutoBuild | System.Boolean |
Gets and sets the property EnableAutoBuild. Enables auto-building on push for a branch of an Amplify app. |
|
EnableBasicAuth | System.Boolean |
Gets and sets the property EnableBasicAuth. Enables basic authorization for a branch of an Amplify app. |
|
EnableNotification | System.Boolean |
Gets and sets the property EnableNotification. Enables notifications for a branch that is part of an Amplify app. |
|
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. |
|
EnablePullRequestPreview | System.Boolean |
Gets and sets the property EnablePullRequestPreview. Enables pull request previews for the branch. |
|
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. |
|
Framework | System.String |
Gets and sets the property Framework. The framework for a branch of an Amplify app. |
|
PullRequestEnvironmentName | System.String |
Gets and sets the property PullRequestEnvironmentName. The Amplify environment name for the pull request. |
|
SourceBranch | System.String |
Gets and sets the property SourceBranch. The source branch if the branch is a pull request branch. |
|
Stage | Amazon.Amplify.Stage |
Gets and sets the property Stage. The current stage for the branch that is part of an Amplify app. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. The tag for the branch of an Amplify app. |
|
ThumbnailUrl | System.String |
Gets and sets the property ThumbnailUrl. The thumbnail URL for the branch of an Amplify app. |
|
TotalNumberOfJobs | System.String |
Gets and sets the property TotalNumberOfJobs. The total number of jobs that are part of an Amplify app. |
|
Ttl | System.String |
Gets and sets the property Ttl. The content Time to Live (TTL) for the website in seconds. |
|
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5