Show / Hide Table of Contents

Interface IBranchProps

(experimental) Properties for a Branch.

Inherited Members
IBranchOptions.Asset
IBranchOptions.AutoBuild
IBranchOptions.BasicAuth
IBranchOptions.BranchName
IBranchOptions.BuildSpec
IBranchOptions.ComputeRole
IBranchOptions.Description
IBranchOptions.EnvironmentVariables
IBranchOptions.PerformanceMode
IBranchOptions.PullRequestEnvironmentName
IBranchOptions.PullRequestPreview
IBranchOptions.SkewProtection
IBranchOptions.Stage
Namespace: Amazon.CDK.AWS.Amplify.Alpha
Assembly: Amazon.CDK.AWS.Amplify.Alpha.dll
Syntax (csharp)
public interface IBranchProps : IBranchOptions
Syntax (vb)
Public Interface IBranchProps Inherits IBranchOptions
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Amplify.Alpha;
             using Amazon.CDK.AWS.CodeBuild;
             using Amazon.CDK.AWS.IAM;
             using Amazon.CDK.AWS.S3.Assets;

             App app;
             Asset asset;
             BasicAuth basicAuth;
             BuildSpec buildSpec;
             Role role;

             var branchProps = new BranchProps {
                 App = app,

                 // the properties below are optional
                 Asset = asset,
                 AutoBuild = false,
                 BasicAuth = basicAuth,
                 BranchName = "branchName",
                 BuildSpec = buildSpec,
                 ComputeRole = role,
                 Description = "description",
                 EnvironmentVariables = new Dictionary<string, string> {
                     { "environmentVariablesKey", "environmentVariables" }
                 },
                 PerformanceMode = false,
                 PullRequestEnvironmentName = "pullRequestEnvironmentName",
                 PullRequestPreview = false,
                 SkewProtection = false,
                 Stage = "stage"
             };

Synopsis

Properties

App

(experimental) The application within which the branch must be created.

Properties

App

(experimental) The application within which the branch must be created.

IApp App { get; }
Property Value

IApp

Remarks

Stability: Experimental

Back to top Generated by DocFX