Package software.amazon.awscdk.services.amplify

Class CfnApp.Builder

java.lang.Object

software.amazon.awscdk.services.amplify.CfnApp.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApp>

Enclosing class:

CfnApp

@Stability(Stable)
public static final class CfnApp.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApp>

A fluent builder for CfnApp.

Method Summary

Modifier and Type	Method	Description
CfnApp.Builder	accessToken(String accessToken)	The personal access token for a GitHub repository for an Amplify app.
CfnApp.Builder	autoBranchCreationConfig(IResolvable autoBranchCreationConfig)	Sets the configuration for your automatic branch creation.
CfnApp.Builder	autoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty autoBranchCreationConfig)	Sets the configuration for your automatic branch creation.
CfnApp.Builder	basicAuthConfig(IResolvable basicAuthConfig)	The credentials for basic authorization for an Amplify app.
CfnApp.Builder	basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig)	The credentials for basic authorization for an Amplify app.
CfnApp	build()
CfnApp.Builder	buildSpec(String buildSpec)	The build specification (build spec) for an Amplify app.
CfnApp.Builder	cacheConfig(IResolvable cacheConfig)	The cache configuration for the Amplify app.
CfnApp.Builder	cacheConfig(CfnApp.CacheConfigProperty cacheConfig)	The cache configuration for the Amplify app.
static CfnApp.Builder	create(software.constructs.Construct scope, String id)
CfnApp.Builder	customHeaders(String customHeaders)	The custom HTTP headers for an Amplify app.
CfnApp.Builder	customRules(List<? extends Object> customRules)	The custom rewrite and redirect rules for an Amplify app.
CfnApp.Builder	customRules(IResolvable customRules)	The custom rewrite and redirect rules for an Amplify app.
CfnApp.Builder	description(String description)	The description of the Amplify app.
CfnApp.Builder	enableBranchAutoDeletion(Boolean enableBranchAutoDeletion)	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
CfnApp.Builder	enableBranchAutoDeletion(IResolvable enableBranchAutoDeletion)	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
CfnApp.Builder	environmentVariables(List<? extends Object> environmentVariables)	The environment variables for the Amplify app.
CfnApp.Builder	environmentVariables(IResolvable environmentVariables)	The environment variables for the Amplify app.
CfnApp.Builder	iamServiceRole(String iamServiceRole)	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
CfnApp.Builder	name(String name)	The name of the Amplify app.
CfnApp.Builder	oauthToken(String oauthToken)	The OAuth token for a third-party source control system for an Amplify app.
CfnApp.Builder	platform(String platform)	The platform for the Amplify app.
CfnApp.Builder	repository(String repository)	The Git repository for the Amplify app.
CfnApp.Builder	tags(List<? extends CfnTag> tags)	The tag for an Amplify app.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnApp.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnApp.Builder.

name

@Stability(Stable)
public CfnApp.Builder name(String name)

The name of the Amplify app.

Parameters:

name - The name of the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name

accessToken

@Stability(Stable)
public CfnApp.Builder accessToken(String accessToken)

The personal access token for a GitHub repository for an Amplify app.

The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

You must specify either AccessToken or OauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Parameters:

accessToken - The personal access token for a GitHub repository for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken

autoBranchCreationConfig

@Stability(Stable)
public CfnApp.Builder autoBranchCreationConfig(IResolvable autoBranchCreationConfig)

Sets the configuration for your automatic branch creation.

Parameters:

autoBranchCreationConfig - Sets the configuration for your automatic branch creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig

autoBranchCreationConfig

@Stability(Stable)
public CfnApp.Builder autoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty autoBranchCreationConfig)

Sets the configuration for your automatic branch creation.

Parameters:

autoBranchCreationConfig - Sets the configuration for your automatic branch creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig

basicAuthConfig

@Stability(Stable)
public CfnApp.Builder basicAuthConfig(IResolvable basicAuthConfig)

The credentials for basic authorization for an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

Parameters:

basicAuthConfig - The credentials for basic authorization for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig

basicAuthConfig

@Stability(Stable)
public CfnApp.Builder basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig)

The credentials for basic authorization for an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

Parameters:

basicAuthConfig - The credentials for basic authorization for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig

buildSpec

@Stability(Stable)
public CfnApp.Builder buildSpec(String buildSpec)

The build specification (build spec) for an Amplify app.

Parameters:

buildSpec - The build specification (build spec) for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec

cacheConfig

@Stability(Stable)
public CfnApp.Builder cacheConfig(IResolvable cacheConfig)

The cache configuration for the Amplify app.

If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Parameters:

cacheConfig - The cache configuration for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-cacheconfig

cacheConfig

@Stability(Stable)
public CfnApp.Builder cacheConfig(CfnApp.CacheConfigProperty cacheConfig)

The cache configuration for the Amplify app.

If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Parameters:

cacheConfig - The cache configuration for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-cacheconfig

customHeaders

@Stability(Stable)
public CfnApp.Builder customHeaders(String customHeaders)

The custom HTTP headers for an Amplify app.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customheaders

customRules

@Stability(Stable)
public CfnApp.Builder customRules(IResolvable customRules)

The custom rewrite and redirect rules for an Amplify app.

Parameters:

customRules - The custom rewrite and redirect rules for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules

customRules

@Stability(Stable)
public CfnApp.Builder customRules(List<? extends Object> customRules)

The custom rewrite and redirect rules for an Amplify app.

Parameters:

customRules - The custom rewrite and redirect rules for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules

description

@Stability(Stable)
public CfnApp.Builder description(String description)

The description of the Amplify app.

Parameters:

description - The description of the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description

enableBranchAutoDeletion

@Stability(Stable)
public CfnApp.Builder enableBranchAutoDeletion(Boolean enableBranchAutoDeletion)

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Parameters:

enableBranchAutoDeletion - Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion

enableBranchAutoDeletion

@Stability(Stable)
public CfnApp.Builder enableBranchAutoDeletion(IResolvable enableBranchAutoDeletion)

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Parameters:

enableBranchAutoDeletion - Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion

environmentVariables

@Stability(Stable)
public CfnApp.Builder environmentVariables(IResolvable environmentVariables)

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

Parameters:

environmentVariables - The environment variables for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables

environmentVariables

@Stability(Stable)
public CfnApp.Builder environmentVariables(List<? extends Object> environmentVariables)

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

Parameters:

environmentVariables - The environment variables for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables

iamServiceRole

@Stability(Stable)
public CfnApp.Builder iamServiceRole(String iamServiceRole)

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

Parameters:

iamServiceRole - AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole

oauthToken

@Stability(Stable)
public CfnApp.Builder oauthToken(String oauthToken)

The OAuth token for a third-party source control system for an Amplify app.

The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .

You must specify either OauthToken or AccessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Parameters:

oauthToken - The OAuth token for a third-party source control system for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken

platform

@Stability(Stable)
public CfnApp.Builder platform(String platform)

The platform for the Amplify app.

For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

Parameters:

platform - The platform for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-platform

repository

@Stability(Stable)
public CfnApp.Builder repository(String repository)

The Git repository for the Amplify app.

Parameters:

repository - The Git repository for the Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository

tags

@Stability(Stable)
public CfnApp.Builder tags(List<? extends CfnTag> tags)

The tag for an Amplify app.

Parameters:

tags - The tag for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags

build

@Stability(Stable)
public CfnApp build()

Specified by:

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

Returns:

a newly built instance of CfnApp.