Class CfnAppMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAppMixinProps>
- Enclosing interface:
CfnAppMixinProps
CfnAppMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccessToken(String accessToken) Sets the value ofCfnAppMixinProps.getAccessToken()autoBranchCreationConfig(IResolvable autoBranchCreationConfig) Sets the value ofCfnAppMixinProps.getAutoBranchCreationConfig()autoBranchCreationConfig(CfnAppPropsMixin.AutoBranchCreationConfigProperty autoBranchCreationConfig) Sets the value ofCfnAppMixinProps.getAutoBranchCreationConfig()basicAuthConfig(IResolvable basicAuthConfig) Sets the value ofCfnAppMixinProps.getBasicAuthConfig()basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnAppMixinProps.getBasicAuthConfig()build()Builds the configured instance.Sets the value ofCfnAppMixinProps.getBuildSpec()cacheConfig(IResolvable cacheConfig) Sets the value ofCfnAppMixinProps.getCacheConfig()cacheConfig(CfnAppPropsMixin.CacheConfigProperty cacheConfig) Sets the value ofCfnAppMixinProps.getCacheConfig()computeRoleArn(String computeRoleArn) Sets the value ofCfnAppMixinProps.getComputeRoleArn()customHeaders(String customHeaders) Sets the value ofCfnAppMixinProps.getCustomHeaders()customRules(List<? extends Object> customRules) Sets the value ofCfnAppMixinProps.getCustomRules()customRules(IResolvable customRules) Sets the value ofCfnAppMixinProps.getCustomRules()description(String description) Sets the value ofCfnAppMixinProps.getDescription()enableBranchAutoDeletion(Boolean enableBranchAutoDeletion) Sets the value ofCfnAppMixinProps.getEnableBranchAutoDeletion()enableBranchAutoDeletion(IResolvable enableBranchAutoDeletion) Sets the value ofCfnAppMixinProps.getEnableBranchAutoDeletion()environmentVariables(List<? extends Object> environmentVariables) Sets the value ofCfnAppMixinProps.getEnvironmentVariables()environmentVariables(IResolvable environmentVariables) Sets the value ofCfnAppMixinProps.getEnvironmentVariables()iamServiceRole(String iamServiceRole) Sets the value ofCfnAppMixinProps.getIamServiceRole()jobConfig(IResolvable jobConfig) Sets the value ofCfnAppMixinProps.getJobConfig()jobConfig(CfnAppPropsMixin.JobConfigProperty jobConfig) Sets the value ofCfnAppMixinProps.getJobConfig()Sets the value ofCfnAppMixinProps.getName()oauthToken(String oauthToken) Sets the value ofCfnAppMixinProps.getOauthToken()Sets the value ofCfnAppMixinProps.getPlatform()repository(String repository) Sets the value ofCfnAppMixinProps.getRepository()Sets the value ofCfnAppMixinProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
accessToken
Sets the value ofCfnAppMixinProps.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
AccessTokenfor GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, useOauthToken.You must specify either
AccessTokenorOauthTokenwhen 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 ofCfnAppMixinProps.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 ofCfnAppMixinProps.getAutoBranchCreationConfig()- Parameters:
autoBranchCreationConfig- Sets the configuration for your automatic branch creation.- Returns:
this
-
basicAuthConfig
Sets the value ofCfnAppMixinProps.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 CfnAppMixinProps.Builder basicAuthConfig(CfnAppPropsMixin.BasicAuthConfigProperty basicAuthConfig) Sets the value ofCfnAppMixinProps.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 ofCfnAppMixinProps.getBuildSpec()- Parameters:
buildSpec- The build specification (build spec) for an Amplify app.- Returns:
this
-
cacheConfig
Sets the value ofCfnAppMixinProps.getCacheConfig()- Parameters:
cacheConfig- The cache configuration for the Amplify app. If you don't specify the cache configurationtype, Amplify uses the defaultAMPLIFY_MANAGEDsetting.- Returns:
this
-
cacheConfig
@Stability(Stable) public CfnAppMixinProps.Builder cacheConfig(CfnAppPropsMixin.CacheConfigProperty cacheConfig) Sets the value ofCfnAppMixinProps.getCacheConfig()- Parameters:
cacheConfig- The cache configuration for the Amplify app. If you don't specify the cache configurationtype, Amplify uses the defaultAMPLIFY_MANAGEDsetting.- Returns:
this
-
computeRoleArn
Sets the value ofCfnAppMixinProps.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
Sets the value ofCfnAppMixinProps.getCustomHeaders()- Parameters:
customHeaders- The custom HTTP headers for an Amplify app.- Returns:
this
-
customRules
Sets the value ofCfnAppMixinProps.getCustomRules()- Parameters:
customRules- The custom rewrite and redirect rules for an Amplify app.- Returns:
this
-
customRules
Sets the value ofCfnAppMixinProps.getCustomRules()- Parameters:
customRules- The custom rewrite and redirect rules for an Amplify app.- Returns:
this
-
description
Sets the value ofCfnAppMixinProps.getDescription()- Parameters:
description- The description of the Amplify app.- Returns:
this
-
enableBranchAutoDeletion
@Stability(Stable) public CfnAppMixinProps.Builder enableBranchAutoDeletion(Boolean enableBranchAutoDeletion) Sets the value ofCfnAppMixinProps.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 ofCfnAppMixinProps.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 ofCfnAppMixinProps.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 ofCfnAppMixinProps.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 ofCfnAppMixinProps.getIamServiceRole()- Parameters:
iamServiceRole- AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.- Returns:
this
-
jobConfig
Sets the value ofCfnAppMixinProps.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 ofCfnAppMixinProps.getJobConfig()- Parameters:
jobConfig- The configuration details that apply to the jobs for an Amplify app.- Returns:
this
-
name
Sets the value ofCfnAppMixinProps.getName()- Parameters:
name- The name of the Amplify app.- Returns:
this
-
oauthToken
Sets the value ofCfnAppMixinProps.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
OauthTokenfor repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, useAccessToken.You must specify either
OauthTokenorAccessTokenwhen 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 ofCfnAppMixinProps.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_COMPUTEand set the artifactsbaseDirectoryto.nextin 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 ofCfnAppMixinProps.getRepository()- Parameters:
repository- The Git repository for the Amplify app.- Returns:
this
-
tags
Sets the value ofCfnAppMixinProps.getTags()- Parameters:
tags- The tag for an Amplify app.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnAppMixinProps>- Returns:
- a new instance of
CfnAppMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-