software.amazon.awscdk.services.amplify

Class Branch

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.amplify.Branch

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.108Z")
 @Stability(value=Experimental)
public class Branch
extends Resource
implements IBranch

(experimental) An Amplify Console branch.

Example:

 App amplifyApp;
 Branch master = amplifyApp.addBranch("master"); // `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 and Description
static 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.IBranch

IBranch.Jsii$Default, IBranch.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Branch

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

Branch

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

Branch

@Stability(value=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 Detail

fromBranchName

@Stability(value=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(value=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(value=Experimental)
 @NotNull
public String getArn()

(experimental) The ARN of the branch.

getBranchName

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

(experimental) The name of the branch.

Specified by:

getBranchName in interface IBranch