Interface AppProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AppProps.Jsii$Proxy
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();
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AppProps.Builder
builder()
default String
(experimental) The name for the application.default AutoBranchCreation
(experimental) The auto branch creation configuration.default Boolean
(experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.default BasicAuth
(experimental) The Basic Auth configuration.default BuildSpec
(experimental) BuildSpec for the application.default CacheConfigType
(experimental) The type of cache configuration to use for an Amplify app.default List<CustomResponseHeader>
(experimental) The custom HTTP response headers for an Amplify app.default List<CustomRule>
(experimental) Custom rewrite/redirect rules for the application.default String
(experimental) A description for the application.(experimental) Environment variables for the application.default Platform
(experimental) Indicates the hosting platform to use.default IRole
getRole()
(experimental) The IAM service role to associate with the application.default ISourceCodeProvider
(experimental) The source code provider for this application.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAppName
(experimental) The name for the application.Default: - a CDK generated name
-
getAutoBranchCreation
(experimental) The auto branch creation configuration.Use this to automatically create branches that match a certain pattern.
Default: - no auto branch creation
-
getAutoBranchDeletion
(experimental) Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.Default: false
-
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
(experimental) BuildSpec for the application.Alternatively, add a
amplify.yml
file to the repository.Default: - no build spec
- See Also:
-
getCacheConfigType
(experimental) The type of cache configuration to use for an Amplify app.Default: CacheConfigType.AMPLIFY_MANAGED
-
getCustomResponseHeaders
(experimental) The custom HTTP response headers for an Amplify app.Default: - no custom response headers
- See Also:
-
getCustomRules
(experimental) Custom rewrite/redirect rules for the application.Default: - no custom rewrite/redirect rules
-
getDescription
(experimental) A description for the application.Default: - no description
-
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
(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
(experimental) The IAM service role to associate with the application.The App implements IGrantable.
Default: - a new role is created
-
getSourceCodeProvider
(experimental) The source code provider for this application.Default: - not connected to a source code provider
-
builder
- Returns:
- a
AppProps.Builder
ofAppProps
-