@aws-cdk/aws-amplify-alpha.AppProps

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.

AppProps

used as props by

• App

Stability

Experimental

Source

lib/app.ts

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

appNamestringapp_namestrappNameStringAppNamestringAppName*string#

The name for the application.

Default: a CDK generated name

autoBranchCreationAutoBranchCreationauto_branch_creationAutoBranchCreationautoBranchCreationAutoBranchCreationAutoBranchCreationAutoBranchCreationAutoBranchCreationAutoBranchCreation#

The auto branch creation configuration.

Default: no auto branch creation

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

autoBranchDeletionbooleanauto_branch_deletionboolautoBranchDeletionBooleanAutoBranchDeletionboolAutoBranchDeletion*bool= false#

Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

basicAuthBasicAuthbasic_authBasicAuthbasicAuthBasicAuthBasicAuthBasicAuthBasicAuthBasicAuth#

The Basic Auth configuration.

Default: no password protection

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

buildComputeTypeBuildComputeTypebuild_compute_typeBuildComputeTypebuildComputeTypeBuildComputeTypeBuildComputeTypeBuildComputeTypeBuildComputeTypeBuildComputeType#

Specifies the size of the build instance.

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

buildSpecBuildSpecbuild_specBuildSpecbuildSpecBuildSpecBuildSpecBuildSpecBuildSpecBuildSpec#

BuildSpec for the application.

Default: no build spec

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

cacheConfigTypeCacheConfigTypecache_config_typeCacheConfigTypecacheConfigTypeCacheConfigTypeCacheConfigTypeCacheConfigTypeCacheConfigTypeCacheConfigType= CacheConfigType.AMPLIFY_MANAGED#

The type of cache configuration to use for an Amplify app.

computeRoleIRolecompute_roleIRolecomputeRoleIRoleComputeRoleIRoleComputeRoleIRole#

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.

customResponseHeadersCustomResponseHeader[]custom_response_headerstyping.List[CustomResponseHeader]customResponseHeadersList<CustomResponseHeader>CustomResponseHeadersCustomResponseHeader[]CustomResponseHeaders*[]CustomResponseHeader#

The custom HTTP response headers for an Amplify app.

Default: no custom response headers

customRulesCustomRule[]custom_rulestyping.List[CustomRule]customRulesList<CustomRule>CustomRulesCustomRule[]CustomRules*[]CustomRule#

Custom rewrite/redirect rules for the application.

Default: no custom rewrite/redirect rules

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description for the application.

Default: no description

environmentVariables{ [key: string]: string }environment_variablestyping.Mapping[str, str]environmentVariablesMap<String, String>EnvironmentVariablesIDictionary<string, string>EnvironmentVariables*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.

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

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#

The IAM service role to associate with the application.

Default: a new role is created

The App implements IGrantable.

sourceCodeProviderISourceCodeProvidersource_code_providerISourceCodeProvidersourceCodeProviderISourceCodeProviderSourceCodeProviderISourceCodeProviderSourceCodeProviderISourceCodeProvider#

The source code provider for this application.

Default: not connected to a source code provider