AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AppProps Struct ​

Properties for an App.

Stability
Experimental
Source
lib/app.ts

Example ​

ts
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 ​

appNameoptionalstringapp_nameoptionalstrappNameoptionalStringAppNameoptionalstringAppNameoptional*string#
The name for the application.

Default: a CDK generated name

autoBranchCreationoptionalAutoBranchCreationauto_branch_creationoptionalAutoBranchCreationautoBranchCreationoptionalAutoBranchCreationAutoBranchCreationoptionalAutoBranchCreationAutoBranchCreationoptionalAutoBranchCreation#
The auto branch creation configuration.

Default: no auto branch creation

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

autoBranchDeletionoptionalbooleanauto_branch_deletionoptionalboolautoBranchDeletionoptionalBooleanAutoBranchDeletionoptionalboolAutoBranchDeletionoptional*bool= false#
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
basicAuthoptionalBasicAuthbasic_authoptionalBasicAuthbasicAuthoptionalBasicAuthBasicAuthoptionalBasicAuthBasicAuthoptionalBasicAuth#
The Basic Auth configuration.

Default: no password protection

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

buildComputeTypeoptionalBuildComputeTypebuild_compute_typeoptionalBuildComputeTypebuildComputeTypeoptionalBuildComputeTypeBuildComputeTypeoptionalBuildComputeTypeBuildComputeTypeoptionalBuildComputeType#
Specifies the size of the build instance.

Default: undefined - Amplify default setting is BuildComputeType.STANDARD_8GB.

buildSpecoptionalBuildSpecbuild_specoptionalBuildSpecbuildSpecoptionalBuildSpecBuildSpecoptionalBuildSpecBuildSpecoptionalBuildSpec#
BuildSpec for the application.

Default: no build spec

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

cacheConfigTypeoptionalCacheConfigTypecache_config_typeoptionalCacheConfigTypecacheConfigTypeoptionalCacheConfigTypeCacheConfigTypeoptionalCacheConfigTypeCacheConfigTypeoptionalCacheConfigType= CacheConfigType.AMPLIFY_MANAGED#
The type of cache configuration to use for an Amplify app.
computeRoleoptionalIRolecompute_roleoptionalIRolecomputeRoleoptionalIRoleComputeRoleoptionalIRoleComputeRoleoptionalIRole#
The IAM role for an SSR app.

Default: undefined - a new role is created when platform is Platform.WEB_COMPUTE or Platform.WEB_DYNAMIC, otherwise no compute role

The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions.

customResponseHeadersoptionalCustomResponseHeader[]custom_response_headersoptionaltyping.List[CustomResponseHeader]customResponseHeadersoptionalList<CustomResponseHeader>CustomResponseHeadersoptionalCustomResponseHeader[]CustomResponseHeadersoptional*[]CustomResponseHeader#
The custom HTTP response headers for an Amplify app.

Default: no custom response headers

customRulesoptionalCustomRule[]custom_rulesoptionaltyping.List[CustomRule]customRulesoptionalList<CustomRule>CustomRulesoptionalCustomRule[]CustomRulesoptional*[]CustomRule#
Custom rewrite/redirect rules for the application.

Default: no custom rewrite/redirect rules

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description for the application.

Default: no description

environmentVariablesoptional{ [key: string]: string }environment_variablesoptionaltyping.Mapping[str, str]environmentVariablesoptionalMap<String, String>EnvironmentVariablesoptionalIDictionary<string, string>EnvironmentVariablesoptional*map[string]*string#
Environment variables for the application.

Default: no environment variables

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

platformoptionalPlatformplatformoptionalPlatformplatformoptionalPlatformPlatformoptionalPlatformPlatformoptionalPlatform= 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).

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
The IAM service role to associate with the application.

Default: a new role is created

The App implements IGrantable.

sourceCodeProvideroptionalISourceCodeProvidersource_code_provideroptionalISourceCodeProvidersourceCodeProvideroptionalISourceCodeProviderSourceCodeProvideroptionalISourceCodeProviderSourceCodeProvideroptionalISourceCodeProvider#
The source code provider for this application.

Default: not connected to a source code provider