software.amazon.awscdk.services.amplify

Interface CfnBranchProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBranchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.602Z")
 @Stability(value=Stable)
public interface CfnBranchProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Amplify::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.*;
 CfnBranchProps cfnBranchProps = CfnBranchProps.builder()
         .appId("appId")
         .branchName("branchName")
         // the properties below are optional
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .enableBasicAuth(false)
                 .build())
         .buildSpec("buildSpec")
         .description("description")
         .enableAutoBuild(false)
         .enablePerformanceMode(false)
         .enablePullRequestPreview(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .pullRequestEnvironmentName("pullRequestEnvironmentName")
         .stage("stage")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBranchProps.Builder	builder()
String	getAppId() `AWS::Amplify::Branch.AppId`.
default Object	getBasicAuthConfig() `AWS::Amplify::Branch.BasicAuthConfig`.
String	getBranchName() `AWS::Amplify::Branch.BranchName`.
default String	getBuildSpec() `AWS::Amplify::Branch.BuildSpec`.
default String	getDescription() `AWS::Amplify::Branch.Description`.
default Object	getEnableAutoBuild() `AWS::Amplify::Branch.EnableAutoBuild`.
default Object	getEnablePerformanceMode() `AWS::Amplify::Branch.EnablePerformanceMode`.
default Object	getEnablePullRequestPreview() `AWS::Amplify::Branch.EnablePullRequestPreview`.
default Object	getEnvironmentVariables() `AWS::Amplify::Branch.EnvironmentVariables`.
default String	getPullRequestEnvironmentName() `AWS::Amplify::Branch.PullRequestEnvironmentName`.
default String	getStage() `AWS::Amplify::Branch.Stage`.
default List<CfnTag>	getTags() `AWS::Amplify::Branch.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAppId

@Stability(value=Stable)
 @NotNull
String getAppId()

`AWS::Amplify::Branch.AppId`.

getBasicAuthConfig

@Stability(value=Stable)
 @Nullable
default Object getBasicAuthConfig()

`AWS::Amplify::Branch.BasicAuthConfig`.

getBranchName

@Stability(value=Stable)
 @NotNull
String getBranchName()

`AWS::Amplify::Branch.BranchName`.

getBuildSpec

@Stability(value=Stable)
 @Nullable
default String getBuildSpec()

`AWS::Amplify::Branch.BuildSpec`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Amplify::Branch.Description`.

getEnableAutoBuild

@Stability(value=Stable)
 @Nullable
default Object getEnableAutoBuild()

`AWS::Amplify::Branch.EnableAutoBuild`.

getEnablePerformanceMode

@Stability(value=Stable)
 @Nullable
default Object getEnablePerformanceMode()

`AWS::Amplify::Branch.EnablePerformanceMode`.

getEnablePullRequestPreview

@Stability(value=Stable)
 @Nullable
default Object getEnablePullRequestPreview()

`AWS::Amplify::Branch.EnablePullRequestPreview`.

getEnvironmentVariables

@Stability(value=Stable)
 @Nullable
default Object getEnvironmentVariables()

`AWS::Amplify::Branch.EnvironmentVariables`.

getPullRequestEnvironmentName

@Stability(value=Stable)
 @Nullable
default String getPullRequestEnvironmentName()

`AWS::Amplify::Branch.PullRequestEnvironmentName`.

getStage

@Stability(value=Stable)
 @Nullable
default String getStage()

`AWS::Amplify::Branch.Stage`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::Amplify::Branch.Tags`.

builder

@Stability(value=Stable)
static CfnBranchProps.Builder builder()

Returns:

a CfnBranchProps.Builder of CfnBranchProps