Interface App.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<App.Builder,
,App> SdkBuilder<App.Builder,
,App> SdkPojo
- Enclosing class:
App
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the Amplify app.The unique ID of the Amplify app.default App.Builder
autoBranchCreationConfig
(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig) Describes the automated branch creation configuration for the Amplify app.autoBranchCreationConfig
(AutoBranchCreationConfig autoBranchCreationConfig) Describes the automated branch creation configuration for the Amplify app.autoBranchCreationPatterns
(String... autoBranchCreationPatterns) Describes the automated branch creation glob patterns for the Amplify app.autoBranchCreationPatterns
(Collection<String> autoBranchCreationPatterns) Describes the automated branch creation glob patterns for the Amplify app.basicAuthCredentials
(String basicAuthCredentials) The basic authorization credentials for branches for the Amplify app.Describes the content of the build specification (build spec) for the Amplify app.createTime
(Instant createTime) Creates a date and time for the Amplify app.customHeaders
(String customHeaders) Describes the custom HTTP headers for the Amplify app.customRules
(Collection<CustomRule> customRules) Describes the custom redirect and rewrite rules for the Amplify app.customRules
(Consumer<CustomRule.Builder>... customRules) Describes the custom redirect and rewrite rules for the Amplify app.customRules
(CustomRule... customRules) Describes the custom redirect and rewrite rules for the Amplify app.defaultDomain
(String defaultDomain) The default domain for the Amplify app.description
(String description) The description for the Amplify app.enableAutoBranchCreation
(Boolean enableAutoBranchCreation) Enables automated branch creation for the Amplify app.enableBasicAuth
(Boolean enableBasicAuth) Enables basic authorization for the Amplify app's branches.enableBranchAutoBuild
(Boolean enableBranchAutoBuild) Enables the auto-building of branches for the Amplify app.enableBranchAutoDeletion
(Boolean enableBranchAutoDeletion) Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.environmentVariables
(Map<String, String> environmentVariables) The environment variables for the Amplify app.iamServiceRoleArn
(String iamServiceRoleArn) The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.The name for the Amplify app.The platform for the Amplify app.The platform for the Amplify app.default App.Builder
productionBranch
(Consumer<ProductionBranch.Builder> productionBranch) Describes the information about a production branch of the Amplify app.productionBranch
(ProductionBranch productionBranch) Describes the information about a production branch of the Amplify app.repository
(String repository) The Git repository for the Amplify app.repositoryCloneMethod
(String repositoryCloneMethod) repositoryCloneMethod
(RepositoryCloneMethod repositoryCloneMethod) The tag for the Amplify app.updateTime
(Instant updateTime) Updates the date and time for the Amplify app.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, sdkFields
-
Method Details
-
appId
The unique ID of the Amplify app.
- Parameters:
appId
- The unique ID of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appArn
The Amazon Resource Name (ARN) of the Amplify app.
- Parameters:
appArn
- The Amazon Resource Name (ARN) of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name for the Amplify app.
- Parameters:
name
- The name for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tag for the Amplify app.
- Parameters:
tags
- The tag for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description for the Amplify app.
- Parameters:
description
- The description for 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
.- 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
.- 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
.- 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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createTime
Creates a date and time for the Amplify app.
- Parameters:
createTime
- Creates a date and time for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updateTime
Updates the date and time for the Amplify app.
- Parameters:
updateTime
- Updates the date and time for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamServiceRoleArn
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
- Parameters:
iamServiceRoleArn
- The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
-
defaultDomain
The default domain for the Amplify app.
- Parameters:
defaultDomain
- The default domain for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableBranchAutoBuild
Enables the auto-building of branches for the Amplify app.
- Parameters:
enableBranchAutoBuild
- Enables the auto-building of branches for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableBranchAutoDeletion
Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
- Parameters:
enableBranchAutoDeletion
- Automatically disconnect 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 the Amplify app's branches.
- Parameters:
enableBasicAuth
- Enables basic authorization for the Amplify app's branches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
basicAuthCredentials
The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format
user:password
.- Parameters:
basicAuthCredentials
- The basic authorization credentials for branches for the 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
Describes the custom redirect and rewrite rules for the Amplify app.
- Parameters:
customRules
- Describes the custom redirect and rewrite rules for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRules
Describes the custom redirect and rewrite rules for the Amplify app.
- Parameters:
customRules
- Describes the custom redirect and rewrite rules for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRules
Describes the custom redirect and rewrite rules for the 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:
-
productionBranch
Describes the information about a production branch of the Amplify app.
- Parameters:
productionBranch
- Describes the information about a production branch of the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productionBranch
Describes the information about a production branch of the Amplify app.
This is a convenience method that creates an instance of theProductionBranch.Builder
avoiding the need to create one manually viaProductionBranch.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toproductionBranch(ProductionBranch)
.- Parameters:
productionBranch
- a consumer that will call methods onProductionBranch.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
buildSpec
Describes the content of the build specification (build spec) for the Amplify app.
- Parameters:
buildSpec
- Describes the content of the build specification (build spec) for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customHeaders
Describes the custom HTTP headers for the Amplify app.
- Parameters:
customHeaders
- Describes the custom HTTP headers for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableAutoBranchCreation
Enables automated branch creation for the Amplify app.
- Parameters:
enableAutoBranchCreation
- Enables automated branch creation for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationPatterns
Describes the automated branch creation glob patterns for the Amplify app.
- Parameters:
autoBranchCreationPatterns
- Describes the automated branch creation glob patterns for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationPatterns
Describes the automated branch creation glob patterns for the Amplify app.
- Parameters:
autoBranchCreationPatterns
- Describes the automated branch creation glob patterns for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationConfig
Describes the automated branch creation configuration for the Amplify app.
- Parameters:
autoBranchCreationConfig
- Describes the automated branch creation configuration for the Amplify app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoBranchCreationConfig
default App.Builder autoBranchCreationConfig(Consumer<AutoBranchCreationConfig.Builder> autoBranchCreationConfig) Describes the automated branch creation configuration for the 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:
-
repositoryCloneMethod
This is for internal use.
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies
TOKEN
for a GitHub repository,SIGV4
for an Amazon Web Services CodeCommit repository, andSSH
for GitLab and Bitbucket repositories.- Parameters:
repositoryCloneMethod
-This is for internal use.
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies
TOKEN
for a GitHub repository,SIGV4
for an Amazon Web Services CodeCommit repository, andSSH
for GitLab and Bitbucket repositories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
repositoryCloneMethod
This is for internal use.
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies
TOKEN
for a GitHub repository,SIGV4
for an Amazon Web Services CodeCommit repository, andSSH
for GitLab and Bitbucket repositories.- Parameters:
repositoryCloneMethod
-This is for internal use.
The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies
TOKEN
for a GitHub repository,SIGV4
for an Amazon Web Services CodeCommit repository, andSSH
for GitLab and Bitbucket repositories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-