software.amazon.awscdk.services.amplify

Class AppProps.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.AppProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AppProps>

Enclosing interface:

AppProps

@Stability(value=Experimental)
public static final class AppProps.Builder
extends Object
implements software.amazon.jsii.Builder<AppProps>

A builder for AppProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AppProps.Builder	appName(String appName) Sets the value of AppProps.getAppName()
AppProps.Builder	autoBranchCreation(AutoBranchCreation autoBranchCreation) Sets the value of AppProps.getAutoBranchCreation()
AppProps.Builder	autoBranchDeletion(Boolean autoBranchDeletion) Sets the value of AppProps.getAutoBranchDeletion()
AppProps.Builder	basicAuth(BasicAuth basicAuth) Sets the value of AppProps.getBasicAuth()
AppProps	build() Builds the configured instance.
AppProps.Builder	buildSpec(BuildSpec buildSpec) Sets the value of AppProps.getBuildSpec()
AppProps.Builder	customResponseHeaders(List<? extends CustomResponseHeader> customResponseHeaders) Sets the value of AppProps.getCustomResponseHeaders()
AppProps.Builder	customRules(List<? extends CustomRule> customRules) Sets the value of AppProps.getCustomRules()
AppProps.Builder	description(String description) Sets the value of AppProps.getDescription()
AppProps.Builder	environmentVariables(Map<String,String> environmentVariables) Sets the value of AppProps.getEnvironmentVariables()
AppProps.Builder	role(IRole role) Sets the value of AppProps.getRole()
AppProps.Builder	sourceCodeProvider(ISourceCodeProvider sourceCodeProvider) Sets the value of AppProps.getSourceCodeProvider()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

appName

@Stability(value=Experimental)
public AppProps.Builder appName(String appName)

Sets the value of AppProps.getAppName()

Parameters:

appName - The name for the application.

Returns:

this

autoBranchCreation

@Stability(value=Experimental)
public AppProps.Builder autoBranchCreation(AutoBranchCreation autoBranchCreation)

Sets the value of AppProps.getAutoBranchCreation()

Parameters:

autoBranchCreation - The auto branch creation configuration. Use this to automatically create branches that match a certain pattern.

Returns:

this

autoBranchDeletion

@Stability(value=Experimental)
public AppProps.Builder autoBranchDeletion(Boolean autoBranchDeletion)

Sets the value of AppProps.getAutoBranchDeletion()

Parameters:

autoBranchDeletion - Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

Returns:

this

basicAuth

@Stability(value=Experimental)
public AppProps.Builder basicAuth(BasicAuth basicAuth)

Sets the value of AppProps.getBasicAuth()

Parameters:

basicAuth - The Basic Auth configuration. Use this to set password protection at an app level to all your branches.

Returns:

this

buildSpec

@Stability(value=Experimental)
public AppProps.Builder buildSpec(BuildSpec buildSpec)

Sets the value of AppProps.getBuildSpec()

Parameters:

buildSpec - BuildSpec for the application. Alternatively, add a amplify.yml file to the repository.

Returns:

this

customResponseHeaders

@Stability(value=Experimental)
public AppProps.Builder customResponseHeaders(List<? extends CustomResponseHeader> customResponseHeaders)

Sets the value of AppProps.getCustomResponseHeaders()

Parameters:

customResponseHeaders - The custom HTTP response headers for an Amplify app.

Returns:

this

customRules

@Stability(value=Experimental)
public AppProps.Builder customRules(List<? extends CustomRule> customRules)

Sets the value of AppProps.getCustomRules()

Parameters:

customRules - Custom rewrite/redirect rules for the application.

Returns:

this

description

@Stability(value=Experimental)
public AppProps.Builder description(String description)

Sets the value of AppProps.getDescription()

Parameters:

description - A description for the application.

Returns:

this

environmentVariables

@Stability(value=Experimental)
public AppProps.Builder environmentVariables(Map<String,String> environmentVariables)

Sets the value of AppProps.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables for the application. All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

Returns:

this

role

@Stability(value=Experimental)
public AppProps.Builder role(IRole role)

Sets the value of AppProps.getRole()

Parameters:

role - The IAM service role to associate with the application. The App implements IGrantable.

Returns:

this

sourceCodeProvider

@Stability(value=Experimental)
public AppProps.Builder sourceCodeProvider(ISourceCodeProvider sourceCodeProvider)

Sets the value of AppProps.getSourceCodeProvider()

Parameters:

sourceCodeProvider - The source code provider for this application.

Returns:

this

build

@Stability(value=Experimental)
public AppProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AppProps>

Returns:

a new instance of AppProps

Throws:

NullPointerException - if any required attribute was not provided