Class Branch

(experimental) An Amplify Console branch.

Inheritance
System.Object
Resource
Branch
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Amplify.Alpha
Assembly: Amazon.CDK.AWS.Amplify.Alpha.dll
Syntax (csharp)
public class Branch : Resource, IBranch, IResource
Syntax (vb)
Public Class Branch
    Inherits Resource
    Implements IBranch, IResource
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
App amplifyApp;


var main = amplifyApp.AddBranch("main"); // `id` will be used as repo branch name
var dev = amplifyApp.AddBranch("dev", new BranchOptions {
    PerformanceMode = true
});
dev.AddEnvironment("STAGE", "dev");

Synopsis

Constructors

Branch(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
Branch(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
Branch(Construct, String, IBranchProps)

Properties

Arn

(experimental) The ARN of the branch.
BranchName

(experimental) The name of the branch.

Methods

AddEnvironment(String, String)

(experimental) Adds an environment variable to this branch.
FromBranchName(Construct, String, String)

(experimental) Import an existing branch.

Constructors

Branch(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Branch(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Branch(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Branch(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Branch(Construct, String, IBranchProps)

public Branch(Construct scope, string id, IBranchProps props)
Parameters
scope Constructs.Construct
id System.String
props IBranchProps
Remarks

Stability: Experimental

Properties

Arn

(experimental) The ARN of the branch.

public virtual string Arn { get; }
Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

BranchName

(experimental) The name of the branch.

public virtual string BranchName { get; }
Property Value

System.String

Remarks

Stability: Experimental

Methods

AddEnvironment(String, String)

(experimental) Adds an environment variable to this branch.

public virtual Branch AddEnvironment(string name, string value)
Parameters
name System.String
value System.String
Returns

Branch

Remarks

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

Stability: Experimental

FromBranchName(Construct, String, String)

(experimental) Import an existing branch.

public static IBranch FromBranchName(Construct scope, string id, string branchName)
Parameters
scope Constructs.Construct
id System.String
branchName System.String
Returns

IBranch

Remarks

Stability: Experimental

Implements

Constructs.IConstruct
Constructs.IDependable