Class CfnAppProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAppProps>
- Enclosing interface:
CfnAppProps
CfnAppProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) Sets the value ofCfnAppProps.getAccessToken()
autoBranchCreationConfig
(IResolvable autoBranchCreationConfig) Sets the value ofCfnAppProps.getAutoBranchCreationConfig()
autoBranchCreationConfig
(CfnApp.AutoBranchCreationConfigProperty autoBranchCreationConfig) Sets the value ofCfnAppProps.getAutoBranchCreationConfig()
basicAuthConfig
(IResolvable basicAuthConfig) Sets the value ofCfnAppProps.getBasicAuthConfig()
basicAuthConfig
(CfnApp.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnAppProps.getBasicAuthConfig()
build()
Builds the configured instance.Sets the value ofCfnAppProps.getBuildSpec()
cacheConfig
(IResolvable cacheConfig) Sets the value ofCfnAppProps.getCacheConfig()
cacheConfig
(CfnApp.CacheConfigProperty cacheConfig) Sets the value ofCfnAppProps.getCacheConfig()
customHeaders
(String customHeaders) Sets the value ofCfnAppProps.getCustomHeaders()
customRules
(List<? extends Object> customRules) Sets the value ofCfnAppProps.getCustomRules()
customRules
(IResolvable customRules) Sets the value ofCfnAppProps.getCustomRules()
description
(String description) Sets the value ofCfnAppProps.getDescription()
enableBranchAutoDeletion
(Boolean enableBranchAutoDeletion) Sets the value ofCfnAppProps.getEnableBranchAutoDeletion()
enableBranchAutoDeletion
(IResolvable enableBranchAutoDeletion) Sets the value ofCfnAppProps.getEnableBranchAutoDeletion()
environmentVariables
(List<? extends Object> environmentVariables) Sets the value ofCfnAppProps.getEnvironmentVariables()
environmentVariables
(IResolvable environmentVariables) Sets the value ofCfnAppProps.getEnvironmentVariables()
iamServiceRole
(String iamServiceRole) Sets the value ofCfnAppProps.getIamServiceRole()
Sets the value ofCfnAppProps.getName()
oauthToken
(String oauthToken) Sets the value ofCfnAppProps.getOauthToken()
Sets the value ofCfnAppProps.getPlatform()
repository
(String repository) Sets the value ofCfnAppProps.getRepository()
Sets the value ofCfnAppProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnAppProps.getName()
- Parameters:
name
- The name of the Amplify app. This parameter is required.- Returns:
this
-
accessToken
Sets the value ofCfnAppProps.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, useOauthToken
.You must specify either
AccessToken
orOauthToken
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 CfnAppProps.Builder autoBranchCreationConfig(IResolvable autoBranchCreationConfig) Sets the value ofCfnAppProps.getAutoBranchCreationConfig()
- Parameters:
autoBranchCreationConfig
- Sets the configuration for your automatic branch creation.- Returns:
this
-
autoBranchCreationConfig
@Stability(Stable) public CfnAppProps.Builder autoBranchCreationConfig(CfnApp.AutoBranchCreationConfigProperty autoBranchCreationConfig) Sets the value ofCfnAppProps.getAutoBranchCreationConfig()
- Parameters:
autoBranchCreationConfig
- Sets the configuration for your automatic branch creation.- Returns:
this
-
basicAuthConfig
Sets the value ofCfnAppProps.getBasicAuthConfig()
- Parameters:
basicAuthConfig
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the formatuser:password
.- Returns:
this
-
basicAuthConfig
@Stability(Stable) public CfnAppProps.Builder basicAuthConfig(CfnApp.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnAppProps.getBasicAuthConfig()
- Parameters:
basicAuthConfig
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the formatuser:password
.- Returns:
this
-
buildSpec
Sets the value ofCfnAppProps.getBuildSpec()
- Parameters:
buildSpec
- The build specification (build spec) for an Amplify app.- Returns:
this
-
cacheConfig
Sets the value ofCfnAppProps.getCacheConfig()
- Parameters:
cacheConfig
- The cache configuration for the Amplify app. If you don't specify the cache configurationtype
, Amplify uses the defaultAMPLIFY_MANAGED
setting.- Returns:
this
-
cacheConfig
Sets the value ofCfnAppProps.getCacheConfig()
- Parameters:
cacheConfig
- The cache configuration for the Amplify app. If you don't specify the cache configurationtype
, Amplify uses the defaultAMPLIFY_MANAGED
setting.- Returns:
this
-
customHeaders
Sets the value ofCfnAppProps.getCustomHeaders()
- Parameters:
customHeaders
- The custom HTTP headers for an Amplify app.- Returns:
this
-
customRules
Sets the value ofCfnAppProps.getCustomRules()
- Parameters:
customRules
- The custom rewrite and redirect rules for an Amplify app.- Returns:
this
-
customRules
Sets the value ofCfnAppProps.getCustomRules()
- Parameters:
customRules
- The custom rewrite and redirect rules for an Amplify app.- Returns:
this
-
description
Sets the value ofCfnAppProps.getDescription()
- Parameters:
description
- The description of the Amplify app.- Returns:
this
-
enableBranchAutoDeletion
@Stability(Stable) public CfnAppProps.Builder enableBranchAutoDeletion(Boolean enableBranchAutoDeletion) Sets the value ofCfnAppProps.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 CfnAppProps.Builder enableBranchAutoDeletion(IResolvable enableBranchAutoDeletion) Sets the value ofCfnAppProps.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 CfnAppProps.Builder environmentVariables(IResolvable environmentVariables) Sets the value ofCfnAppProps.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 CfnAppProps.Builder environmentVariables(List<? extends Object> environmentVariables) Sets the value ofCfnAppProps.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
Sets the value ofCfnAppProps.getIamServiceRole()
- Parameters:
iamServiceRole
- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.- Returns:
this
-
oauthToken
Sets the value ofCfnAppProps.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, useAccessToken
.You must specify either
OauthToken
orAccessToken
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
Sets the value ofCfnAppProps.getPlatform()
- Parameters:
platform
- The platform for the Amplify app. For a static app, set the platform type toWEB
. For a dynamic server-side rendered (SSR) app, set the platform type toWEB_COMPUTE
. For an app requiring Amplify Hosting's original SSR support only, set the platform type toWEB_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 artifactsbaseDirectory
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
Sets the value ofCfnAppProps.getRepository()
- Parameters:
repository
- The Git repository for the Amplify app.- Returns:
this
-
tags
Sets the value ofCfnAppProps.getTags()
- Parameters:
tags
- The tag for an Amplify app.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAppProps>
- Returns:
- a new instance of
CfnAppProps
- Throws:
NullPointerException
- if any required attribute was not provided
-