Package software.amazon.awscdk.mixins.preview.services.amplify.mixins

Class CfnAppMixinProps.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.amplify.mixins.CfnAppMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAppMixinProps>

Enclosing interface:

CfnAppMixinProps

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

A builder for CfnAppMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAppMixinProps.Builder	accessToken(String accessToken)	Sets the value of CfnAppMixinProps.getAccessToken()
CfnAppMixinProps.Builder	autoBranchCreationConfig(IResolvable autoBranchCreationConfig)	Sets the value of CfnAppMixinProps.getAutoBranchCreationConfig()
CfnAppMixinProps.Builder	autoBranchCreationConfig(CfnAppPropsMixin.AutoBranchCreationConfigProperty autoBranchCreationConfig)	Sets the value of CfnAppMixinProps.getAutoBranchCreationConfig()
CfnAppMixinProps.Builder	basicAuthConfig(IResolvable basicAuthConfig)	Sets the value of CfnAppMixinProps.getBasicAuthConfig()
CfnAppMixinProps.Builder	basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig)	Sets the value of CfnAppMixinProps.getBasicAuthConfig()
CfnAppMixinProps	build()	Builds the configured instance.
CfnAppMixinProps.Builder	buildSpec(String buildSpec)	Sets the value of CfnAppMixinProps.getBuildSpec()
CfnAppMixinProps.Builder	cacheConfig(IResolvable cacheConfig)	Sets the value of CfnAppMixinProps.getCacheConfig()
CfnAppMixinProps.Builder	cacheConfig(CfnAppPropsMixin.CacheConfigProperty cacheConfig)	Sets the value of CfnAppMixinProps.getCacheConfig()
CfnAppMixinProps.Builder	computeRoleArn(String computeRoleArn)	Sets the value of CfnAppMixinProps.getComputeRoleArn()
CfnAppMixinProps.Builder	customHeaders(String customHeaders)	Sets the value of CfnAppMixinProps.getCustomHeaders()
CfnAppMixinProps.Builder	customRules(List<? extends Object> customRules)	Sets the value of CfnAppMixinProps.getCustomRules()
CfnAppMixinProps.Builder	customRules(IResolvable customRules)	Sets the value of CfnAppMixinProps.getCustomRules()
CfnAppMixinProps.Builder	description(String description)	Sets the value of CfnAppMixinProps.getDescription()
CfnAppMixinProps.Builder	enableBranchAutoDeletion(Boolean enableBranchAutoDeletion)	Sets the value of CfnAppMixinProps.getEnableBranchAutoDeletion()
CfnAppMixinProps.Builder	enableBranchAutoDeletion(IResolvable enableBranchAutoDeletion)	Sets the value of CfnAppMixinProps.getEnableBranchAutoDeletion()
CfnAppMixinProps.Builder	environmentVariables(List<? extends Object> environmentVariables)	Sets the value of CfnAppMixinProps.getEnvironmentVariables()
CfnAppMixinProps.Builder	environmentVariables(IResolvable environmentVariables)	Sets the value of CfnAppMixinProps.getEnvironmentVariables()
CfnAppMixinProps.Builder	iamServiceRole(String iamServiceRole)	Sets the value of CfnAppMixinProps.getIamServiceRole()
CfnAppMixinProps.Builder	jobConfig(IResolvable jobConfig)	Sets the value of CfnAppMixinProps.getJobConfig()
CfnAppMixinProps.Builder	jobConfig(CfnAppPropsMixin.JobConfigProperty jobConfig)	Sets the value of CfnAppMixinProps.getJobConfig()
CfnAppMixinProps.Builder	name(String name)	Sets the value of CfnAppMixinProps.getName()
CfnAppMixinProps.Builder	oauthToken(String oauthToken)	Sets the value of CfnAppMixinProps.getOauthToken()
CfnAppMixinProps.Builder	platform(String platform)	Sets the value of CfnAppMixinProps.getPlatform()
CfnAppMixinProps.Builder	repository(String repository)	Sets the value of CfnAppMixinProps.getRepository()
CfnAppMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAppMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

accessToken

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

Sets the value of CfnAppMixinProps.getAccessToken()

Parameters:

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 .

Returns:

this

autoBranchCreationConfig

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

Sets the value of CfnAppMixinProps.getAutoBranchCreationConfig()

Parameters:

autoBranchCreationConfig - Sets the configuration for your automatic branch creation.

Returns:

this

autoBranchCreationConfig

@Stability(Stable)
public CfnAppMixinProps.Builder autoBranchCreationConfig(CfnAppPropsMixin.AutoBranchCreationConfigProperty autoBranchCreationConfig)

Sets the value of CfnAppMixinProps.getAutoBranchCreationConfig()

Parameters:

autoBranchCreationConfig - Sets the configuration for your automatic branch creation.

Returns:

this

basicAuthConfig

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

Sets the value of CfnAppMixinProps.getBasicAuthConfig()

Parameters:

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 .

Returns:

this

basicAuthConfig

@Stability(Stable)
public CfnAppMixinProps.Builder basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig)

Sets the value of CfnAppMixinProps.getBasicAuthConfig()

Parameters:

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 .

Returns:

this

buildSpec

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

Sets the value of CfnAppMixinProps.getBuildSpec()

Parameters:

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

Returns:

this

cacheConfig

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

Sets the value of CfnAppMixinProps.getCacheConfig()

Parameters:

cacheConfig - The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Returns:

this

cacheConfig

@Stability(Stable)
public CfnAppMixinProps.Builder cacheConfig(CfnAppPropsMixin.CacheConfigProperty cacheConfig)

Sets the value of CfnAppMixinProps.getCacheConfig()

Parameters:

cacheConfig - The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Returns:

this

computeRoleArn

@Stability(Stable)
public CfnAppMixinProps.Builder computeRoleArn(String computeRoleArn)

Sets the value of CfnAppMixinProps.getComputeRoleArn()

Parameters:

computeRoleArn - The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .

Returns:

this

customHeaders

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

Sets the value of CfnAppMixinProps.getCustomHeaders()

Parameters:

customHeaders - The custom HTTP headers for an Amplify app.

Returns:

this

customRules

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

Sets the value of CfnAppMixinProps.getCustomRules()

Parameters:

customRules - The custom rewrite and redirect rules for an Amplify app.

Returns:

this

customRules

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

Sets the value of CfnAppMixinProps.getCustomRules()

Parameters:

customRules - The custom rewrite and redirect rules for an Amplify app.

Returns:

this

description

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

Sets the value of CfnAppMixinProps.getDescription()

Parameters:

description - The description of the Amplify app.

Returns:

this

enableBranchAutoDeletion

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

Sets the value of CfnAppMixinProps.getEnableBranchAutoDeletion()

Parameters:

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

Returns:

this

enableBranchAutoDeletion

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

Sets the value of CfnAppMixinProps.getEnableBranchAutoDeletion()

Parameters:

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

Returns:

this

environmentVariables

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

Sets the value of CfnAppMixinProps.getEnvironmentVariables()

Parameters:

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 .

Returns:

this

environmentVariables

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

Sets the value of CfnAppMixinProps.getEnvironmentVariables()

Parameters:

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 .

Returns:

this

iamServiceRole

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

Sets the value of CfnAppMixinProps.getIamServiceRole()

Parameters:

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

Returns:

this

jobConfig

@Stability(Stable)
public CfnAppMixinProps.Builder jobConfig(IResolvable jobConfig)

Sets the value of CfnAppMixinProps.getJobConfig()

Parameters:

jobConfig - The configuration details that apply to the jobs for an Amplify app.

Returns:

this

jobConfig

@Stability(Stable)
public CfnAppMixinProps.Builder jobConfig(CfnAppPropsMixin.JobConfigProperty jobConfig)

Sets the value of CfnAppMixinProps.getJobConfig()

Parameters:

jobConfig - The configuration details that apply to the jobs for an Amplify app.

Returns:

this

name

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

Sets the value of CfnAppMixinProps.getName()

Parameters:

name - The name of the Amplify app.

Returns:

this

oauthToken

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

Sets the value of CfnAppMixinProps.getOauthToken()

Parameters:

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 .

Returns:

this

platform

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

Sets the value of CfnAppMixinProps.getPlatform()

Parameters:

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 .

Returns:

this

repository

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

Sets the value of CfnAppMixinProps.getRepository()

Parameters:

repository - The Git repository for the Amplify app.

Returns:

this

tags

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

Sets the value of CfnAppMixinProps.getTags()

Parameters:

tags - The tag for an Amplify app.

Returns:

this

build

@Stability(Stable)
public CfnAppMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAppMixinProps

Throws:

NullPointerException - if any required attribute was not provided