Package software.amazon.awscdk.services.amplify

Interface BranchProps

All Superinterfaces:

BranchOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BranchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.098Z")
@Stability(Experimental)
public interface BranchProps
extends software.amazon.jsii.JsiiSerializable, BranchOptions

(experimental) Properties for a Branch.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.s3.assets.*;
 App app;
 Asset asset;
 BasicAuth basicAuth;
 BuildSpec buildSpec;
 BranchProps branchProps = BranchProps.builder()
         .app(app)
         // the properties below are optional
         .asset(asset)
         .autoBuild(false)
         .basicAuth(basicAuth)
         .branchName("branchName")
         .buildSpec(buildSpec)
         .description("description")
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .performanceMode(false)
         .pullRequestEnvironmentName("pullRequestEnvironmentName")
         .pullRequestPreview(false)
         .stage("stage")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BranchProps.Builder	A builder for BranchProps
static final class	BranchProps.Jsii$Proxy	An implementation for BranchProps

Method Summary

Modifier and Type	Method	Description
static BranchProps.Builder	builder()
IApp	getApp()	(experimental) The application within which the branch must be created.

Methods inherited from interface software.amazon.awscdk.services.amplify.BranchOptions

getAsset, getAutoBuild, getBasicAuth, getBranchName, getBuildSpec, getDescription, getEnvironmentVariables, getPerformanceMode, getPullRequestEnvironmentName, getPullRequestPreview, getStage

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApp

@Stability(Experimental)
@NotNull
IApp getApp()

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

builder

@Stability(Experimental)
static BranchProps.Builder builder()

Returns:

a BranchProps.Builder of BranchProps