Package software.amazon.awscdk.services.amplify.alpha

Class AppProps.Builder

java.lang.Object
software.amazon.awscdk.services.amplify.alpha.AppProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AppProps>
Enclosing interface:
AppProps
@Stability(Experimental) public static final class AppProps.Builder extends Object implements software.amazon.jsii.Builder<AppProps>
A builder for AppProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • appName

      @Stability(Experimental) public AppProps.Builder appName(String appName)
      Sets the value of AppProps.getAppName()
      Parameters:
      appName - The name for the application.
      Returns:
      this

    • autoBranchCreation

      @Stability(Experimental) public AppProps.Builder autoBranchCreation(AutoBranchCreation autoBranchCreation)
      Sets the value of AppProps.getAutoBranchCreation()
      Parameters:
      autoBranchCreation - The auto branch creation configuration. Use this to automatically create branches that match a certain pattern.
      Returns:
      this

    • autoBranchDeletion

      @Stability(Experimental) public AppProps.Builder autoBranchDeletion(Boolean autoBranchDeletion)
      Sets the value of AppProps.getAutoBranchDeletion()
      Parameters:
      autoBranchDeletion - Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
      Returns:
      this

    • basicAuth

      @Stability(Experimental) public AppProps.Builder basicAuth(BasicAuth basicAuth)
      Sets the value of AppProps.getBasicAuth()
      Parameters:
      basicAuth - The Basic Auth configuration. Use this to set password protection at an app level to all your branches.
      Returns:
      this

    • buildComputeType

      @Stability(Experimental) public AppProps.Builder buildComputeType(BuildComputeType buildComputeType)
      Sets the value of AppProps.getBuildComputeType()
      Parameters:
      buildComputeType - Specifies the size of the build instance.
      Returns:
      this

    • buildSpec

      @Stability(Experimental) public AppProps.Builder buildSpec(BuildSpec buildSpec)
      Sets the value of AppProps.getBuildSpec()
      Parameters:
      buildSpec - BuildSpec for the application. Alternatively, add a amplify.yml file to the repository.
      Returns:
      this

    • cacheConfigType

      @Stability(Experimental) public AppProps.Builder cacheConfigType(CacheConfigType cacheConfigType)
      Sets the value of AppProps.getCacheConfigType()
      Parameters:
      cacheConfigType - The type of cache configuration to use for an Amplify app.
      Returns:
      this

    • computeRole

      @Stability(Experimental) public AppProps.Builder computeRole(IRole computeRole)
      Sets the value of AppProps.getComputeRole()
      Parameters:
      computeRole - 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.
      Returns:
      this

    • customResponseHeaders

      @Stability(Experimental) public AppProps.Builder customResponseHeaders(List<? extends CustomResponseHeader> customResponseHeaders)
      Sets the value of AppProps.getCustomResponseHeaders()
      Parameters:
      customResponseHeaders - The custom HTTP response headers for an Amplify app.
      Returns:
      this

    • customRules

      @Stability(Experimental) public AppProps.Builder customRules(List<? extends CustomRule> customRules)
      Sets the value of AppProps.getCustomRules()
      Parameters:
      customRules - Custom rewrite/redirect rules for the application.
      Returns:
      this

    • description

      @Stability(Experimental) public AppProps.Builder description(String description)
      Sets the value of AppProps.getDescription()
      Parameters:
      description - A description for the application.
      Returns:
      this

    • environmentVariables

      @Stability(Experimental) public AppProps.Builder environmentVariables(Map<String,String> environmentVariables)
      Sets the value of AppProps.getEnvironmentVariables()
      Parameters:
      environmentVariables - Environment variables for the application. All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.
      Returns:
      this

    • platform

      @Stability(Experimental) public AppProps.Builder platform(Platform platform)
      Sets the value of AppProps.getPlatform()
      Parameters:
      platform - Indicates the hosting platform to use. Set to WEB for static site generated (SSG) apps (i.e. a Create React App or Gatsby) and WEB_COMPUTE for server side rendered (SSR) apps (i.e. NextJS).
      Returns:
      this

    • role

      @Stability(Experimental) public AppProps.Builder role(IRole role)
      Sets the value of AppProps.getRole()
      Parameters:
      role - The IAM service role to associate with the application. The App implements IGrantable.
      Returns:
      this

    • sourceCodeProvider

      @Stability(Experimental) public AppProps.Builder sourceCodeProvider(ISourceCodeProvider sourceCodeProvider)
      Sets the value of AppProps.getSourceCodeProvider()
      Parameters:
      sourceCodeProvider - The source code provider for this application.
      Returns:
      this

    • build

      @Stability(Experimental) public AppProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<AppProps>
      Returns:
      a new instance of AppProps
      Throws:
      NullPointerException - if any required attribute was not provided