interface AppProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Amplify.Alpha.AppProps |
![]() | github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#AppProps |
![]() | software.amazon.awscdk.services.amplify.alpha.AppProps |
![]() | aws_cdk.aws_amplify_alpha.AppProps |
![]() | @aws-cdk/aws-amplify-alpha ยป AppProps |
Properties for an App.
Example
const amplifyApp = new amplify.App(this, 'MyApp', {
sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
owner: '<user>',
repository: '<repo>',
oauthToken: SecretValue.secretsManager('my-github-token'),
}),
autoBranchCreation: { // Automatically connect branches that match a pattern set
patterns: ['feature/*', 'test/*'],
},
autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository
});
Properties
Name | Type | Description |
---|---|---|
app | string | The name for the application. |
auto | Auto | The auto branch creation configuration. |
auto | boolean | Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. |
basic | Basic | The Basic Auth configuration. |
build | Build | BuildSpec for the application. |
cache | Cache | The type of cache configuration to use for an Amplify app. |
custom | Custom [] | The custom HTTP response headers for an Amplify app. |
custom | Custom [] | Custom rewrite/redirect rules for the application. |
description? | string | A description for the application. |
environment | { [string]: string } | Environment variables for the application. |
platform? | Platform | Indicates the hosting platform to use. |
role? | IRole | The IAM service role to associate with the application. |
source | ISource | The source code provider for this application. |
appName?
Type:
string
(optional, default: a CDK generated name)
The name for the application.
autoBranchCreation?
Type:
Auto
(optional, default: no auto branch creation)
The auto branch creation configuration.
Use this to automatically create branches that match a certain pattern.
autoBranchDeletion?
Type:
boolean
(optional, default: false)
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
basicAuth?
Type:
Basic
(optional, default: no password protection)
The Basic Auth configuration.
Use this to set password protection at an app level to all your branches.
buildSpec?
Type:
Build
(optional, default: no build spec)
BuildSpec for the application.
Alternatively, add a amplify.yml
file to the repository.
See also: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html
cacheConfigType?
Type:
Cache
(optional, default: CacheConfigType.AMPLIFY_MANAGED)
The type of cache configuration to use for an Amplify app.
customResponseHeaders?
Type:
Custom
[]
(optional, default: no custom response headers)
The custom HTTP response headers for an Amplify app.
See also: https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html
customRules?
Type:
Custom
[]
(optional, default: no custom rewrite/redirect rules)
Custom rewrite/redirect rules for the application.
description?
Type:
string
(optional, default: no description)
A description for the application.
environmentVariables?
Type:
{ [string]: string }
(optional, default: no environment variables)
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.
platform?
Type:
Platform
(optional, default: Platform.WEB)
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).
role?
Type:
IRole
(optional, default: a new role is created)
The IAM service role to associate with the application.
The App implements IGrantable.
sourceCodeProvider?
Type:
ISource
(optional, default: not connected to a source code provider)
The source code provider for this application.