software.amazon.awscdk.services.amplify

Class App.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.App.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<App>

Enclosing class:

App

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

(experimental) A fluent builder for App.

Method Summary

Modifier and Type	Method and Description
App.Builder	appName(String appName) (experimental) The name for the application.
App.Builder	autoBranchCreation(AutoBranchCreation autoBranchCreation) (experimental) The auto branch creation configuration.
App.Builder	autoBranchDeletion(Boolean autoBranchDeletion) (experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
App.Builder	basicAuth(BasicAuth basicAuth) (experimental) The Basic Auth configuration.
App	build()
App.Builder	buildSpec(BuildSpec buildSpec) (experimental) BuildSpec for the application.
static App.Builder	create(software.constructs.Construct scope, String id)
App.Builder	customResponseHeaders(List<? extends CustomResponseHeader> customResponseHeaders) (experimental) The custom HTTP response headers for an Amplify app.
App.Builder	customRules(List<? extends CustomRule> customRules) (experimental) Custom rewrite/redirect rules for the application.
App.Builder	description(String description) (experimental) A description for the application.
App.Builder	environmentVariables(Map<String,String> environmentVariables) (experimental) Environment variables for the application.
App.Builder	role(IRole role) (experimental) The IAM service role to associate with the application.
App.Builder	sourceCodeProvider(ISourceCodeProvider sourceCodeProvider) (experimental) The source code provider for this application.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static App.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of App.Builder.

appName

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

(experimental) The name for the application.

Default: - a CDK generated name

Parameters:

appName - The name for the application. This parameter is required.

Returns:

this

autoBranchCreation

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

(experimental) The auto branch creation configuration.

Use this to automatically create branches that match a certain pattern.

Default: - no auto branch creation

Parameters:

autoBranchCreation - The auto branch creation configuration. This parameter is required.

Returns:

this

autoBranchDeletion

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

(experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

Default: false

Parameters:

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

Returns:

this

basicAuth

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

(experimental) The Basic Auth configuration.

Use this to set password protection at an app level to all your branches.

Default: - no password protection

Parameters:

basicAuth - The Basic Auth configuration. This parameter is required.

Returns:

this

buildSpec

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

(experimental) BuildSpec for the application.

Alternatively, add a amplify.yml file to the repository.

Default: - no build spec

Parameters:

buildSpec - BuildSpec for the application. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

customResponseHeaders

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

(experimental) The custom HTTP response headers for an Amplify app.

Default: - no custom response headers

Parameters:

customResponseHeaders - The custom HTTP response headers for an Amplify app. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html

customRules

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

(experimental) Custom rewrite/redirect rules for the application.

Default: - no custom rewrite/redirect rules

Parameters:

customRules - Custom rewrite/redirect rules for the application. This parameter is required.

Returns:

this

description

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

(experimental) A description for the application.

Default: - no description

Parameters:

description - A description for the application. This parameter is required.

Returns:

this

environmentVariables

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

(experimental) 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.

Default: - no environment variables

Parameters:

environmentVariables - Environment variables for the application. This parameter is required.

Returns:

this

role

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

(experimental) The IAM service role to associate with the application.

The App implements IGrantable.

Default: - a new role is created

Parameters:

role - The IAM service role to associate with the application. This parameter is required.

Returns:

this

sourceCodeProvider

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

(experimental) The source code provider for this application.

Default: - not connected to a source code provider

Parameters:

sourceCodeProvider - The source code provider for this application. This parameter is required.

Returns:

this

build

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

Specified by:

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