Class AutoBranchCreation
(experimental) Auto branch creation configuration.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public class AutoBranchCreation : Object, IAutoBranchCreation
Syntax (vb)
Public Class AutoBranchCreation
Inherits Object
Implements IAutoBranchCreation
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var amplifyApp = new App(this, "MyApp", new AppProps {
SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
Owner = "<user>",
Repository = "<repo>",
OauthToken = SecretValue.SecretsManager("my-github-token")
}),
AutoBranchCreation = new AutoBranchCreation { // Automatically connect branches that match a pattern set
Patterns = new [] { "feature/*", "test/*" } },
AutoBranchDeletion = true
});
Synopsis
Constructors
AutoBranchCreation() |
Properties
AutoBuild | (experimental) Whether to enable auto building for the auto created branch. |
BasicAuth | (experimental) The Basic Auth configuration. |
BuildSpec | (experimental) Build spec for the auto created branch. |
EnvironmentVariables | (experimental) Environment variables for the auto created branch. |
Patterns | (experimental) Automated branch creation glob patterns. |
PullRequestEnvironmentName | (experimental) The dedicated backend environment for the pull request previews of the auto created branch. |
PullRequestPreview | (experimental) Whether to enable pull request preview for the auto created branch. |
Stage | (experimental) Stage for the auto created branch. |
Constructors
AutoBranchCreation()
public AutoBranchCreation()
Properties
AutoBuild
(experimental) Whether to enable auto building for the auto created branch.
public Nullable<bool> AutoBuild { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
BasicAuth
(experimental) The Basic Auth configuration.
public BasicAuth BasicAuth { get; set; }
Property Value
Remarks
Use this to set password protection for the auto created branch.
Default: - no password protection
Stability: Experimental
BuildSpec
(experimental) Build spec for the auto created branch.
public BuildSpec BuildSpec { get; set; }
Property Value
Remarks
Default: - application build spec
Stability: Experimental
EnvironmentVariables
(experimental) Environment variables for the auto created branch.
public IDictionary<string, string> EnvironmentVariables { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.
Default: - application environment variables
Stability: Experimental
Patterns
(experimental) Automated branch creation glob patterns.
public string[] Patterns { get; set; }
Property Value
System.String[]
Remarks
Default: - all repository branches
Stability: Experimental
PullRequestEnvironmentName
(experimental) The dedicated backend environment for the pull request previews of the auto created branch.
public string PullRequestEnvironmentName { get; set; }
Property Value
System.String
Remarks
Default: - automatically provision a temporary backend
Stability: Experimental
PullRequestPreview
(experimental) Whether to enable pull request preview for the auto created branch.
public Nullable<bool> PullRequestPreview { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
Stage
(experimental) Stage for the auto created branch.
public string Stage { get; set; }
Property Value
System.String
Remarks
Default: - no stage
Stability: Experimental