software.amazon.awscdk.services.amplify

Class Branch

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.amplify.Branch

All Implemented Interfaces:

IConstruct, IDependable, IResource, IBranch

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.267Z")
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 interface software.amazon.awscdk.services.amplify.IBranch

IBranch.Jsii$Default, IBranch.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Branch	addEnvironment(java.lang.String name, java.lang.String value) (experimental) Adds an environment variable to this branch.
static IBranch	fromBranchName(software.constructs.Construct scope, java.lang.String id, java.lang.String branchName) (experimental) Import an existing branch.
java.lang.String	getArn() (experimental) The ARN of the branch.
java.lang.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

Branch

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

Branch

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

Branch

public Branch(software.constructs.Construct scope,
              java.lang.String id,
              BranchProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromBranchName

public static IBranch fromBranchName(software.constructs.Construct scope,
                                     java.lang.String id,
                                     java.lang.String branchName)

(experimental) Import an existing branch.

Parameters:

scope - This parameter is required.

id - This parameter is required.

branchName - This parameter is required.

addEnvironment

public Branch addEnvironment(java.lang.String name,
                             java.lang.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

public java.lang.String getArn()

(experimental) The ARN of the branch.

getBranchName

public java.lang.String getBranchName()

(experimental) The name of the branch.

Specified by:

getBranchName in interface IBranch