Interface App.Builder

All Superinterfaces:
Buildable, CopyableBuilder<App.Builder,App>, SdkBuilder<App.Builder,App>, SdkPojo
Enclosing class:
App
@Mutable @NotThreadSafe public static interface App.Builder extends SdkPojo, CopyableBuilder<App.Builder,App>

  • Method Details

    • appId

      App.Builder appId(String 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

      App.Builder appArn(String 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

      App.Builder name(String 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

      App.Builder tags(Map<String,String> 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

      App.Builder description(String 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

      App.Builder repository(String 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

      App.Builder platform(String 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 14 or later, you must use the platform type WEB_COMPUTE.

      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 14 or later, you must use the platform type WEB_COMPUTE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      App.Builder platform(Platform 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 14 or later, you must use the platform type WEB_COMPUTE.

      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 14 or later, you must use the platform type WEB_COMPUTE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createTime

      App.Builder createTime(Instant createTime)

      A timestamp of when Amplify created the application.

      Parameters:
      createTime - A timestamp of when Amplify created the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateTime

      App.Builder updateTime(Instant updateTime)

      A timestamp of when Amplify updated the application.

      Parameters:
      updateTime - A timestamp of when Amplify updated the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeRoleArn

      App.Builder computeRoleArn(String 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 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 for an SSR app. The 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

      App.Builder iamServiceRoleArn(String 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.

    • environmentVariables

      App.Builder environmentVariables(Map<String,String> 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

      App.Builder defaultDomain(String 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

      App.Builder enableBranchAutoBuild(Boolean 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

      App.Builder enableBranchAutoDeletion(Boolean 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

      App.Builder enableBasicAuth(Boolean 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

      App.Builder basicAuthCredentials(String 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 format user:password.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customRules

      App.Builder customRules(Collection<CustomRule> 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

      App.Builder customRules(CustomRule... 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

      App.Builder customRules(Consumer<CustomRule.Builder>... customRules)

      Describes the custom redirect and rewrite rules for the Amplify app.

      This is a convenience method that creates an instance of the CustomRule.Builder avoiding the need to create one manually via CustomRule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customRules(List<CustomRule>).

      Parameters:
      customRules - a consumer that will call methods on CustomRule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • productionBranch

      App.Builder productionBranch(ProductionBranch 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

      default App.Builder productionBranch(Consumer<ProductionBranch.Builder> productionBranch)

      Describes the information about a production branch of the Amplify app.

      This is a convenience method that creates an instance of the ProductionBranch.Builder avoiding the need to create one manually via ProductionBranch.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to productionBranch(ProductionBranch).

      Parameters:
      productionBranch - a consumer that will call methods on ProductionBranch.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • buildSpec

      App.Builder buildSpec(String 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

      App.Builder customHeaders(String 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

      App.Builder enableAutoBranchCreation(Boolean 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

      App.Builder autoBranchCreationPatterns(Collection<String> 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

      App.Builder autoBranchCreationPatterns(String... 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

      App.Builder autoBranchCreationConfig(AutoBranchCreationConfig 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 the AutoBranchCreationConfig.Builder avoiding the need to create one manually via AutoBranchCreationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoBranchCreationConfig(AutoBranchCreationConfig).

      Parameters:
      autoBranchCreationConfig - a consumer that will call methods on AutoBranchCreationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • repositoryCloneMethod

      App.Builder repositoryCloneMethod(String 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, and SSH 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, and SSH for GitLab and Bitbucket repositories.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • repositoryCloneMethod

      App.Builder repositoryCloneMethod(RepositoryCloneMethod 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, and SSH 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, and SSH for GitLab and Bitbucket repositories.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cacheConfig

      App.Builder cacheConfig(CacheConfig cacheConfig)

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

      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:
      Returns a reference to this object so that method calls can be chained together.

    • cacheConfig

      default App.Builder cacheConfig(Consumer<CacheConfig.Builder> cacheConfig)

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

      This is a convenience method that creates an instance of the CacheConfig.Builder avoiding the need to create one manually via CacheConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cacheConfig(CacheConfig).

      Parameters:
      cacheConfig - a consumer that will call methods on CacheConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • webhookCreateTime

      App.Builder webhookCreateTime(Instant webhookCreateTime)

      A timestamp of when Amplify created the webhook in your Git repository.

      Parameters:
      webhookCreateTime - A timestamp of when Amplify created the webhook in your Git repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wafConfiguration

      App.Builder wafConfiguration(WafConfiguration wafConfiguration)

      Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

      Parameters:
      wafConfiguration - Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wafConfiguration

      default App.Builder wafConfiguration(Consumer<WafConfiguration.Builder> wafConfiguration)

      Describes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.

      This is a convenience method that creates an instance of the WafConfiguration.Builder avoiding the need to create one manually via WafConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wafConfiguration(WafConfiguration).

      Parameters:
      wafConfiguration - a consumer that will call methods on WafConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobConfig

      App.Builder jobConfig(JobConfig jobConfig)

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

      Parameters:
      jobConfig - 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

      default App.Builder jobConfig(Consumer<JobConfig.Builder> jobConfig)

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

      This is a convenience method that creates an instance of the JobConfig.Builder avoiding the need to create one manually via JobConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobConfig(JobConfig).

      Parameters:
      jobConfig - a consumer that will call methods on JobConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: