1.204.0

interface CfnAppProps

LanguageType name
.NETAmazon.CDK.AWS.Amplify.CfnAppProps
Javasoftware.amazon.awscdk.services.amplify.CfnAppProps
Pythonaws_cdk.aws_amplify.CfnAppProps
TypeScript @aws-cdk/aws-amplify » CfnAppProps

Properties for defining a CfnApp.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify from '@aws-cdk/aws-amplify';
const cfnAppProps: amplify.CfnAppProps = {
  name: 'name',

  // the properties below are optional
  accessToken: 'accessToken',
  autoBranchCreationConfig: {
    autoBranchCreationPatterns: ['autoBranchCreationPatterns'],
    basicAuthConfig: {
      enableBasicAuth: false,
      password: 'password',
      username: 'username',
    },
    buildSpec: 'buildSpec',
    enableAutoBranchCreation: false,
    enableAutoBuild: false,
    enablePerformanceMode: false,
    enablePullRequestPreview: false,
    environmentVariables: [{
      name: 'name',
      value: 'value',
    }],
    framework: 'framework',
    pullRequestEnvironmentName: 'pullRequestEnvironmentName',
    stage: 'stage',
  },
  basicAuthConfig: {
    enableBasicAuth: false,
    password: 'password',
    username: 'username',
  },
  buildSpec: 'buildSpec',
  customHeaders: 'customHeaders',
  customRules: [{
    source: 'source',
    target: 'target',

    // the properties below are optional
    condition: 'condition',
    status: 'status',
  }],
  description: 'description',
  enableBranchAutoDeletion: false,
  environmentVariables: [{
    name: 'name',
    value: 'value',
  }],
  iamServiceRole: 'iamServiceRole',
  oauthToken: 'oauthToken',
  platform: 'platform',
  repository: 'repository',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name for an Amplify app.
accessToken?stringThe personal access token for a GitHub repository for an Amplify app.
autoBranchCreationConfig?IResolvable | AutoBranchCreationConfigPropertySets the configuration for your automatic branch creation.
basicAuthConfig?IResolvable | BasicAuthConfigPropertyThe credentials for basic authorization for an Amplify app.
buildSpec?stringThe build specification (build spec) for an Amplify app.
customHeaders?stringThe custom HTTP headers for an Amplify app.
customRules?IResolvable | IResolvable | CustomRuleProperty[]The custom rewrite and redirect rules for an Amplify app.
description?stringThe description for an Amplify app.
enableBranchAutoDeletion?boolean | IResolvableAutomatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables?IResolvable | IResolvable | EnvironmentVariableProperty[]The environment variables map for an Amplify app.
iamServiceRole?stringThe AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
oauthToken?stringThe OAuth token for a third-party source control system for an Amplify app.
platform?stringThe platform for the Amplify app.
repository?stringThe repository for an Amplify app.
tags?CfnTag[]The tag for an Amplify app.

name

Type: string

The name for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

accessToken?

Type: string (optional)

The personal access token for a GitHub repository for an Amplify app.

The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

You must specify either AccessToken or OauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Length Constraints: Minimum length of 1. Maximum length of 255.

autoBranchCreationConfig?

Type: IResolvable | AutoBranchCreationConfigProperty (optional)

Sets the configuration for your automatic branch creation.

basicAuthConfig?

Type: IResolvable | BasicAuthConfigProperty (optional)

The credentials for basic authorization for an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

buildSpec?

Type: string (optional)

The build specification (build spec) for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

customHeaders?

Type: string (optional)

The custom HTTP headers for an Amplify app.

Length Constraints: Minimum length of 0. Maximum length of 25000.

Pattern: (?s).*

customRules?

Type: IResolvable | IResolvable | CustomRuleProperty[] (optional)

The custom rewrite and redirect rules for an Amplify app.

description?

Type: string (optional)

The description for an Amplify app.

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

enableBranchAutoDeletion?

Type: boolean | IResolvable (optional)

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

environmentVariables?

Type: IResolvable | IResolvable | EnvironmentVariableProperty[] (optional)

The environment variables map for an Amplify app.

iamServiceRole?

Type: string (optional)

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: (?s).*

oauthToken?

Type: string (optional)

The OAuth token for a third-party source control system for an Amplify app.

The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .

You must specify either OauthToken or AccessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

platform?

Type: string (optional)

The platform for the Amplify app.

For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

repository?

Type: string (optional)

The repository for an Amplify app.

Pattern: (?s).*

tags?

Type: CfnTag[] (optional)

The tag for an Amplify app.

← PreviousNext →