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.58.0 (build f8ba112)",
           date="2022-05-11T19:24:22.867Z")
 @Stability(value=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 and Description
static class	BranchProps.Builder A builder for BranchProps
static class	BranchProps.Jsii$Proxy An implementation for BranchProps

Method Summary

Modifier and Type	Method and 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 Detail

getApp

@Stability(value=Experimental)
 @NotNull
IApp getApp()

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

builder

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

Specified by:

builder in interface BranchOptions

Returns:

a BranchProps.Builder of BranchProps