@aws-cdk_aws-amplify-alpha.AppProps

interface AppProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Amplify.Alpha.AppProps
Gogithub.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#AppProps
Javasoftware.amazon.awscdk.services.amplify.alpha.AppProps
Pythonaws_cdk.aws_amplify_alpha.AppProps
TypeScript (source)@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

NameTypeDescription
appName?๐Ÿ”นstringThe name for the application.
autoBranchCreation?๐Ÿ”นAutoBranchCreationThe auto branch creation configuration.
autoBranchDeletion?๐Ÿ”นbooleanAutomatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
basicAuth?๐Ÿ”นBasicAuthThe Basic Auth configuration.
buildSpec?๐Ÿ”นBuildSpecBuildSpec for the application.
customResponseHeaders?๐Ÿ”นCustomResponseHeader[]The custom HTTP response headers for an Amplify app.
customRules?๐Ÿ”นCustomRule[]Custom rewrite/redirect rules for the application.
description?๐Ÿ”นstringA description for the application.
environmentVariables?๐Ÿ”น{ [string]: string }Environment variables for the application.
role?๐Ÿ”นIRoleThe IAM service role to associate with the application.
sourceCodeProvider?๐Ÿ”นISourceCodeProviderThe source code provider for this application.

appName?๐Ÿ”น

Type: string (optional, default: a CDK generated name)

The name for the application.


autoBranchCreation?๐Ÿ”น

Type: AutoBranchCreation (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: BasicAuth (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: BuildSpec (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


customResponseHeaders?๐Ÿ”น

Type: CustomResponseHeader[] (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: CustomRule[] (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.


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: ISourceCodeProvider (optional, default: not connected to a source code provider)

The source code provider for this application.