Package software.amazon.awscdk.services.amplify.alpha

Class Branch

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.amplify.alpha.Branch

All Implemented Interfaces:

IResource, IBranch, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.551Z")
@Stability(Experimental)
public class Branch
extends Resource
implements IBranch

(experimental) An Amplify Console branch.

Example:

 App amplifyApp;
 Branch main = amplifyApp.addBranch("main"); // `id` will be used as repo branch name
 Branch dev = amplifyApp.addBranch("dev", BranchOptions.builder()
         .performanceMode(true)
         .build());
 dev.addEnvironment("STAGE", "dev");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Branch.Builder	(experimental) A fluent builder for Branch.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.amplify.alpha.IBranch

IBranch.Jsii$Default, IBranch.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Branch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Branch(software.amazon.jsii.JsiiObjectRef objRef)
	Branch(software.constructs.Construct scope, String id, BranchProps props)

Method Summary

Modifier and Type	Method	Description
Branch	addEnvironment(String name, String value)	(experimental) Adds an environment variable to this branch.
static IBranch	fromBranchName(software.constructs.Construct scope, String id, String branchName)	(experimental) Import an existing branch.
String	getArn()	(experimental) The ARN of the branch.
String	getBranchName()	(experimental) The name of the branch.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Branch

protected Branch(software.amazon.jsii.JsiiObjectRef objRef)

Branch

protected Branch(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Branch

@Stability(Experimental)
public Branch(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BranchProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromBranchName

@Stability(Experimental)
@NotNull
public static IBranch fromBranchName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String branchName)

(experimental) Import an existing branch.

Parameters:

scope - This parameter is required.

id - This parameter is required.

branchName - This parameter is required.

addEnvironment

@Stability(Experimental)
@NotNull
public Branch addEnvironment(@NotNull
 String name,
 @NotNull
 String value)

(experimental) Adds an environment variable to this branch.

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

Parameters:

name - This parameter is required.

value - This parameter is required.

getArn

@Stability(Experimental)
@NotNull
public String getArn()

(experimental) The ARN of the branch.

getBranchName

@Stability(Experimental)
@NotNull
public String getBranchName()

(experimental) The name of the branch.

Specified by:

getBranchName in interface IBranch