Interface CreateAppRequest.Builder
- All Superinterfaces:
AmplifyRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAppRequest.Builder,
,CreateAppRequest> SdkBuilder<CreateAppRequest.Builder,
,CreateAppRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAppRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) The personal access token for a GitHub repository for an Amplify app.default CreateAppRequest.Builder
autoBranchCreationConfig
(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.autoBranchCreationConfig
(AutoBranchCreationConfig autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.autoBranchCreationPatterns
(String... autoBranchCreationPatterns) The automated branch creation glob patterns for an Amplify app.autoBranchCreationPatterns
(Collection<String> autoBranchCreationPatterns) The automated branch creation glob patterns for an Amplify app.basicAuthCredentials
(String basicAuthCredentials) The credentials for basic authorization for an Amplify app.The build specification (build spec) for an Amplify app.default CreateAppRequest.Builder
cacheConfig
(Consumer<CacheConfig.Builder> cacheConfig) The cache configuration for the Amplify app.cacheConfig
(CacheConfig cacheConfig) The cache configuration for the Amplify app.computeRoleArn
(String computeRoleArn) The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app.customHeaders
(String customHeaders) The custom HTTP headers for an Amplify app.customRules
(Collection<CustomRule> customRules) The custom rewrite and redirect rules for an Amplify app.customRules
(Consumer<CustomRule.Builder>... customRules) The custom rewrite and redirect rules for an Amplify app.customRules
(CustomRule... customRules) The custom rewrite and redirect rules for an Amplify app.description
(String description) The description of the Amplify app.enableAutoBranchCreation
(Boolean enableAutoBranchCreation) Enables automated branch creation for an Amplify app.enableBasicAuth
(Boolean enableBasicAuth) Enables basic authorization for an Amplify app.enableBranchAutoBuild
(Boolean enableBranchAutoBuild) Enables the auto building of branches for an Amplify app.enableBranchAutoDeletion
(Boolean enableBranchAutoDeletion) Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.environmentVariables
(Map<String, String> environmentVariables) The environment variables map for an Amplify app.iamServiceRoleArn
(String iamServiceRoleArn) The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.default CreateAppRequest.Builder
jobConfig
(Consumer<JobConfig.Builder> jobConfig) Describes the configuration details that apply to the jobs for an Amplify app.Describes the configuration details that apply to the jobs for an Amplify app.The name of the Amplify app.oauthToken
(String oauthToken) The OAuth token for a third-party source control system for an Amplify app.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The platform for the Amplify app.The platform for the Amplify app.repository
(String repository) The Git repository for the Amplify app.The tag for an Amplify app.Methods inherited from interface software.amazon.awssdk.services.amplify.model.AmplifyRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
name
The name of the Amplify app.
- Parameters:
name
- The name of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the Amplify app.
- Parameters:
description
- The description of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repository
The Git repository for the Amplify app.
- Parameters:
repository
- The Git repository for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 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.- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 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.- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
computeRoleArn
The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services 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.
- Parameters:
computeRoleArn
- The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services 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:
- Returns a reference to this object so that method calls can be chained together.
-
iamServiceRoleArn
The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
- Parameters:
iamServiceRoleArn
- The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 .
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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 .
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
environmentVariables
The environment variables map for an 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 map for an 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:
- Returns a reference to this object so that method calls can be chained together.
-
enableBranchAutoBuild
Enables the auto building of branches for an Amplify app.
- Parameters:
enableBranchAutoBuild
- Enables the auto building of branches for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableBranchAutoDeletion
Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
- Parameters:
enableBranchAutoDeletion
- Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableBasicAuth
Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
- Parameters:
enableBasicAuth
- Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
basicAuthCredentials
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:
basicAuthCredentials
- The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the formatuser:password
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRules
The custom rewrite and redirect rules for an Amplify app.
- Parameters:
customRules
- The custom rewrite and redirect rules for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRules
The custom rewrite and redirect rules for an Amplify app.
- Parameters:
customRules
- The custom rewrite and redirect rules for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRules
The custom rewrite and redirect rules for an Amplify app.
This is a convenience method that creates an instance of theCustomRule.Builder
avoiding the need to create one manually viaCustomRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomRules(List<CustomRule>)
.- Parameters:
customRules
- a consumer that will call methods onCustomRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tag for an Amplify app.
- Parameters:
tags
- The tag for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
buildSpec
The build specification (build spec) for an Amplify app.
- Parameters:
buildSpec
- The build specification (build spec) for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customHeaders
The custom HTTP headers for an Amplify app.
- Parameters:
customHeaders
- The custom HTTP headers for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableAutoBranchCreation
Enables automated branch creation for an Amplify app.
- Parameters:
enableAutoBranchCreation
- Enables automated branch creation for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationPatterns
The automated branch creation glob patterns for an Amplify app.
- Parameters:
autoBranchCreationPatterns
- The automated branch creation glob patterns for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationPatterns
The automated branch creation glob patterns for an Amplify app.
- Parameters:
autoBranchCreationPatterns
- The automated branch creation glob patterns for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationConfig
CreateAppRequest.Builder autoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.
- Parameters:
autoBranchCreationConfig
- The automated branch creation configuration for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationConfig
default CreateAppRequest.Builder autoBranchCreationConfig(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig) The automated branch creation configuration for an Amplify app.
This is a convenience method that creates an instance of theAutoBranchCreationConfig.Builder
avoiding the need to create one manually viaAutoBranchCreationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoBranchCreationConfig(AutoBranchCreationConfig)
.- Parameters:
autoBranchCreationConfig
- a consumer that will call methods onAutoBranchCreationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobConfig
Describes the configuration details that apply to the jobs for an Amplify app.
- Parameters:
jobConfig
- Describes the configuration details that apply to the jobs for an Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobConfig
Describes the configuration details that apply to the jobs for an Amplify app.
This is a convenience method that creates an instance of theJobConfig.Builder
avoiding the need to create one manually viaJobConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobConfig(JobConfig)
.- Parameters:
jobConfig
- a consumer that will call methods onJobConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cacheConfig
The cache configuration for the Amplify app.
- Parameters:
cacheConfig
- The cache configuration for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheConfig
The cache configuration for the Amplify app.
This is a convenience method that creates an instance of theCacheConfig.Builder
avoiding the need to create one manually viaCacheConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheConfig(CacheConfig)
.- Parameters:
cacheConfig
- a consumer that will call methods onCacheConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateAppRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAppRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-