Container for the parameters to the CreateBranch operation. Creates a new branch for an Amplify app.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Amplify.AmazonAmplifyRequest
Amazon.Amplify.Model.CreateBranchRequest
Namespace: Amazon.Amplify.Model
Assembly: AWSSDK.Amplify.dll
Version: 3.x.y.z
Syntax
public class CreateBranchRequest : AmazonAmplifyRequest IAmazonWebServiceRequest
The CreateBranchRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateBranchRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AppId | System.String |
Gets and sets the property AppId. The unique ID for an Amplify app. |
|
|
Backend | Amazon.Amplify.Model.Backend |
Gets and sets the property Backend.
The backend for a |
|
|
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 the branch. You must base64-encode the authorization
credentials and provide them in the format |
|
|
BranchName | System.String |
Gets and sets the property BranchName. The name for the branch. |
|
|
BuildSpec | System.String |
Gets and sets the property BuildSpec. The build specification (build spec) for the branch. |
|
|
Description | System.String |
Gets and sets the property Description. The description for the branch. |
|
|
DisplayName | System.String |
Gets and sets the property DisplayName. The display name for a branch. This is used as the default domain prefix. |
|
|
EnableAutoBuild | System.Boolean |
Gets and sets the property EnableAutoBuild. Enables auto building for the branch. |
|
|
EnableBasicAuth | System.Boolean |
Gets and sets the property EnableBasicAuth. Enables basic authorization for the branch. |
|
|
EnableNotification | System.Boolean |
Gets and sets the property EnableNotification. Enables notifications for the branch. |
|
|
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 this branch. |
|
|
EnvironmentVariables | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property EnvironmentVariables. The environment variables for the branch. |
|
|
Framework | System.String |
Gets and sets the property Framework. The framework for the branch. |
|
|
PullRequestEnvironmentName | System.String |
Gets and sets the property PullRequestEnvironmentName. The Amplify environment name for the pull request. |
|
|
Stage | Amazon.Amplify.Stage |
Gets and sets the property Stage. Describes the current stage for the branch. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. The tag for the branch. |
|
|
Ttl | System.String |
Gets and sets the property Ttl. The content Time To Live (TTL) for the website in seconds. |
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