Interface AppProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:11.595Z") @Stability(Experimental) public interface AppProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for an App.

Example:

 App amplifyApp = App.Builder.create(this, "MyApp")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(SecretValue.secretsManager("my-github-token"))
                 .build())
         .autoBranchCreation(AutoBranchCreation.builder() // Automatically connect branches that match a pattern set
                 .patterns(List.of("feature/*", "test/*")).build())
         .autoBranchDeletion(true)
         .build();
 
  • Method Details

    • getAppName

      @Stability(Experimental) @Nullable default String getAppName()
      (experimental) The name for the application.

      Default: - a CDK generated name

    • getAutoBranchCreation

      @Stability(Experimental) @Nullable default AutoBranchCreation getAutoBranchCreation()
      (experimental) The auto branch creation configuration.

      Use this to automatically create branches that match a certain pattern.

      Default: - no auto branch creation

    • getAutoBranchDeletion

      @Stability(Experimental) @Nullable default Boolean getAutoBranchDeletion()
      (experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

      Default: false

    • getBasicAuth

      @Stability(Experimental) @Nullable default BasicAuth getBasicAuth()
      (experimental) The Basic Auth configuration.

      Use this to set password protection at an app level to all your branches.

      Default: - no password protection

    • getBuildSpec

      @Stability(Experimental) @Nullable default BuildSpec getBuildSpec()
      (experimental) BuildSpec for the application.

      Alternatively, add a amplify.yml file to the repository.

      Default: - no build spec

      See Also:
    • getCustomResponseHeaders

      @Stability(Experimental) @Nullable default List<CustomResponseHeader> getCustomResponseHeaders()
      (experimental) The custom HTTP response headers for an Amplify app.

      Default: - no custom response headers

      See Also:
    • getCustomRules

      @Stability(Experimental) @Nullable default List<CustomRule> getCustomRules()
      (experimental) Custom rewrite/redirect rules for the application.

      Default: - no custom rewrite/redirect rules

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A description for the application.

      Default: - no description

    • getEnvironmentVariables

      @Stability(Experimental) @Nullable default Map<String,String> getEnvironmentVariables()
      (experimental) 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.

      Default: - no environment variables

    • getPlatform

      @Stability(Experimental) @Nullable default Platform getPlatform()
      (experimental) 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).

      Default: Platform.WEB

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (experimental) The IAM service role to associate with the application.

      The App implements IGrantable.

      Default: - a new role is created

    • getSourceCodeProvider

      @Stability(Experimental) @Nullable default ISourceCodeProvider getSourceCodeProvider()
      (experimental) The source code provider for this application.

      Default: - not connected to a source code provider

    • builder

      @Stability(Experimental) static AppProps.Builder builder()
      Returns:
      a AppProps.Builder of AppProps