{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-codebuild": "1.204.0", "@aws-cdk/aws-codecommit": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-kms": "1.204.0", "@aws-cdk/aws-lambda": "1.204.0", "@aws-cdk/aws-lambda-nodejs": "1.204.0", "@aws-cdk/aws-s3-assets": "1.204.0", "@aws-cdk/aws-secretsmanager": "1.204.0", "@aws-cdk/core": "1.204.0", "@aws-cdk/custom-resources": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets" }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-applicationautoscaling": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling", "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "maven": { "artifactId": "applicationautoscaling", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.applicationautoscaling" }, "js": { "npm": "@aws-cdk/aws-applicationautoscaling" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-applicationautoscaling", "module": "aws_cdk.aws_applicationautoscaling" } } }, "@aws-cdk/aws-autoscaling-common": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AutoScaling.Common", "packageId": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "maven": { "artifactId": "autoscaling-common", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.autoscaling.common" }, "js": { "npm": "@aws-cdk/aws-autoscaling-common" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-autoscaling-common", "module": "aws_cdk.aws_autoscaling_common" } } }, "@aws-cdk/aws-cloudformation": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudFormation", "packageId": "Amazon.CDK.AWS.CloudFormation" }, "java": { "maven": { "artifactId": "cloudformation", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudformation" }, "js": { "npm": "@aws-cdk/aws-cloudformation" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudformation", "module": "aws_cdk.aws_cloudformation" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch" }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-codebuild": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeBuild", "packageId": "Amazon.CDK.AWS.CodeBuild" }, "java": { "maven": { "artifactId": "codebuild", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codebuild" }, "js": { "npm": "@aws-cdk/aws-codebuild" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codebuild", "module": "aws_cdk.aws_codebuild" } } }, "@aws-cdk/aws-codecommit": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeCommit", "packageId": "Amazon.CDK.AWS.CodeCommit" }, "java": { "maven": { "artifactId": "codecommit", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codecommit" }, "js": { "npm": "@aws-cdk/aws-codecommit" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codecommit", "module": "aws_cdk.aws_codecommit" } } }, "@aws-cdk/aws-codeguruprofiler": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeGuruProfiler", "packageId": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "maven": { "artifactId": "codeguruprofiler", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeguruprofiler" }, "js": { "npm": "@aws-cdk/aws-codeguruprofiler" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codeguruprofiler", "module": "aws_cdk.aws_codeguruprofiler" } } }, "@aws-cdk/aws-codestarnotifications": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeStarNotifications", "packageId": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "maven": { "artifactId": "codestarnotifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codestarnotifications" }, "js": { "npm": "@aws-cdk/aws-codestarnotifications" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codestarnotifications", "module": "aws_cdk.aws_codestarnotifications" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2" }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-ecr": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ECR", "packageId": "Amazon.CDK.AWS.ECR" }, "java": { "maven": { "artifactId": "ecr", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr" }, "js": { "npm": "@aws-cdk/aws-ecr" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr", "module": "aws_cdk.aws_ecr" } } }, "@aws-cdk/aws-ecr-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Ecr.Assets", "packageId": "Amazon.CDK.ECR.Assets" }, "java": { "maven": { "artifactId": "ecr-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr.assets" }, "js": { "npm": "@aws-cdk/aws-ecr-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr-assets", "module": "aws_cdk.aws_ecr_assets" } } }, "@aws-cdk/aws-efs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EFS", "packageId": "Amazon.CDK.AWS.EFS" }, "java": { "maven": { "artifactId": "efs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.efs" }, "js": { "npm": "@aws-cdk/aws-efs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-efs", "module": "aws_cdk.aws_efs" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-lambda": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda", "packageId": "Amazon.CDK.AWS.Lambda" }, "java": { "maven": { "artifactId": "lambda", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda" }, "js": { "npm": "@aws-cdk/aws-lambda" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lambda", "module": "aws_cdk.aws_lambda" } } }, "@aws-cdk/aws-lambda-nodejs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda.Nodejs", "packageId": "Amazon.CDK.AWS.Lambda.Nodejs" }, "java": { "maven": { "artifactId": "lambda-nodejs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda.nodejs" }, "js": { "npm": "@aws-cdk/aws-lambda-nodejs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lambda-nodejs", "module": "aws_cdk.aws_lambda_nodejs" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs" }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3" }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets" }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-sam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SAM", "packageId": "Amazon.CDK.AWS.SAM" }, "java": { "maven": { "artifactId": "sam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sam" }, "js": { "npm": "@aws-cdk/aws-sam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sam", "module": "aws_cdk.aws_sam" } } }, "@aws-cdk/aws-secretsmanager": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SecretsManager", "packageId": "Amazon.CDK.AWS.SecretsManager" }, "java": { "maven": { "artifactId": "secretsmanager", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.secretsmanager" }, "js": { "npm": "@aws-cdk/aws-secretsmanager" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-secretsmanager", "module": "aws_cdk.aws_secretsmanager" } } }, "@aws-cdk/aws-signer": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Signer", "packageId": "Amazon.CDK.AWS.Signer" }, "java": { "maven": { "artifactId": "signer", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.signer" }, "js": { "npm": "@aws-cdk/aws-signer" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-signer", "module": "aws_cdk.aws_signer" } } }, "@aws-cdk/aws-sns": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SNS", "packageId": "Amazon.CDK.AWS.SNS" }, "java": { "maven": { "artifactId": "sns", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sns" }, "js": { "npm": "@aws-cdk/aws-sns" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sns", "module": "aws_cdk.aws_sns" } } }, "@aws-cdk/aws-sqs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SQS", "packageId": "Amazon.CDK.AWS.SQS" }, "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sqs", "module": "aws_cdk.aws_sqs" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/custom-resources": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CustomResources", "packageId": "Amazon.CDK.AWS.CustomResources" }, "java": { "maven": { "artifactId": "cdk-customresources", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.customresources" }, "js": { "npm": "@aws-cdk/custom-resources" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.custom-resources", "module": "aws_cdk.custom_resources" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::Amplify", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::Amplify", "aws-amplify" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-amplify", "readme": { "markdown": "# AWS Amplify Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThe AWS Amplify Console provides a Git-based workflow for deploying and hosting fullstack serverless web applications. A fullstack serverless app consists of a backend built with cloud resources such as GraphQL or REST APIs, file and data storage, and a frontend built with single page application frameworks such as React, Angular, Vue, or Gatsby.\n\n## Setting up an app with branches, custom rules and a domain\n\nTo set up an Amplify Console app, define an `App`:\n\n```ts\nimport * as codebuild from '@aws-cdk/aws-codebuild';\n\nconst amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n buildSpec: codebuild.BuildSpec.fromObjectToYaml({\n // Alternatively add a `amplify.yml` to the repo\n version: '1.0',\n frontend: {\n phases: {\n preBuild: {\n commands: [\n 'yarn',\n ],\n },\n build: {\n commands: [\n 'yarn build',\n ],\n },\n },\n artifacts: {\n baseDirectory: 'public',\n files:\n - '**/*',\n },\n },\n }),\n});\n```\n\nTo connect your `App` to GitLab, use the `GitLabSourceCodeProvider`:\n\n```ts\nconst amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitLabSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-gitlab-token'),\n }),\n});\n```\n\nTo connect your `App` to CodeCommit, use the `CodeCommitSourceCodeProvider`:\n\n```ts\nimport * as codecommit from '@aws-cdk/aws-codecommit';\n\nconst repository = new codecommit.Repository(this, 'Repo', {\n repositoryName: 'my-repo',\n});\n\nconst amplifyApp = new amplify.App(this, 'App', {\n sourceCodeProvider: new amplify.CodeCommitSourceCodeProvider({ repository }),\n});\n```\n\nThe IAM role associated with the `App` will automatically be granted the permission\nto pull the CodeCommit repository.\n\nAdd branches:\n\n```ts\ndeclare const amplifyApp: amplify.App;\n\nconst master = amplifyApp.addBranch('master'); // `id` will be used as repo branch name\nconst dev = amplifyApp.addBranch('dev', {\n performanceMode: true, // optional, enables performance mode\n});\ndev.addEnvironment('STAGE', 'dev');\n```\n\nAuto build and pull request preview are enabled by default.\n\nAdd custom rules for redirection:\n\n```ts\ndeclare const amplifyApp: amplify.App;\namplifyApp.addCustomRule({\n source: '/docs/specific-filename.html',\n target: '/documents/different-filename.html',\n status: amplify.RedirectStatus.TEMPORARY_REDIRECT,\n});\n```\n\nWhen working with a single page application (SPA), use the\n`CustomRule.SINGLE_PAGE_APPLICATION_REDIRECT` to set up a 200\nrewrite for all files to `index.html` except for the following\nfile extensions: css, gif, ico, jpg, js, png, txt, svg, woff,\nttf, map, json, webmanifest.\n\n```ts\ndeclare const mySinglePageApp: amplify.App;\n\nmySinglePageApp.addCustomRule(amplify.CustomRule.SINGLE_PAGE_APPLICATION_REDIRECT);\n```\n\nAdd a domain and map sub domains to branches:\n\n```ts\ndeclare const amplifyApp: amplify.App;\ndeclare const master: amplify.Branch;\ndeclare const dev: amplify.Branch;\n\nconst domain = amplifyApp.addDomain('example.com', {\n enableAutoSubdomain: true, // in case subdomains should be auto registered for branches\n autoSubdomainCreationPatterns: ['*', 'pr*'], // regex for branches that should auto register subdomains\n});\ndomain.mapRoot(master); // map master branch to domain root\ndomain.mapSubDomain(master, 'www');\ndomain.mapSubDomain(dev); // sub domain prefix defaults to branch name\n```\n\n## Restricting access\n\nPassword protect the app with basic auth by specifying the `basicAuth` prop.\n\nUse `BasicAuth.fromCredentials` when referencing an existing secret:\n\n```ts\nconst amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n basicAuth: amplify.BasicAuth.fromCredentials('username', SecretValue.secretsManager('my-github-token')),\n});\n```\n\nUse `BasicAuth.fromGeneratedPassword` to generate a password in Secrets Manager:\n\n```ts\nconst amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n basicAuth: amplify.BasicAuth.fromGeneratedPassword('username'),\n});\n```\n\nBasic auth can be added to specific branches:\n\n```ts\ndeclare const amplifyApp: amplify.App;\namplifyApp.addBranch('feature/next', {\n basicAuth: amplify.BasicAuth.fromGeneratedPassword('username'),\n});\n```\n\n## Automatically creating and deleting branches\n\nUse the `autoBranchCreation` and `autoBranchDeletion` props to control creation/deletion\nof branches:\n\n```ts\nconst amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});\n```\n\n## Adding custom response headers\n\nUse the `customResponseHeaders` prop to configure custom response headers for an Amplify app:\n\n```ts\nconst amplifyApp = new amplify.App(this, 'App', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n customResponseHeaders: [\n {\n pattern: '*.json',\n headers: {\n 'custom-header-name-1': 'custom-header-value-1',\n 'custom-header-name-2': 'custom-header-value-2',\n },\n },\n {\n pattern: '/path/*',\n headers: {\n 'custom-header-name-1': 'custom-header-value-2',\n },\n },\n ],\n});\n```\n\n## Deploying Assets\n\n`sourceCodeProvider` is optional; when this is not specified the Amplify app can be deployed to using `.zip` packages. The `asset` property can be used to deploy S3 assets to Amplify as part of the CDK:\n\n```ts\nimport * as assets from '@aws-cdk/aws-s3-assets';\n\ndeclare const asset: assets.Asset;\ndeclare const amplifyApp: amplify.App;\nconst branch = amplifyApp.addBranch(\"dev\", { asset: asset });\n```\n" }, "repository": { "directory": "packages/@aws-cdk/aws-amplify", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Amplify", "packageId": "Amazon.CDK.AWS.Amplify" }, "java": { "maven": { "artifactId": "amplify", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.amplify" }, "js": { "npm": "@aws-cdk/aws-amplify" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-amplify", "module": "aws_cdk.aws_amplify" } }, "types": { "@aws-cdk/aws-amplify.App": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.Resource", "docs": { "stability": "experimental", "summary": "An Amplify Console application.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.App", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/app.ts", "line": 210 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.AppProps" } } ] }, "interfaces": [ "@aws-cdk/aws-amplify.IApp", "@aws-cdk/aws-iam.IGrantable" ], "kind": "class", "locationInModule": { "filename": "lib/app.ts", "line": 167 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Import an existing application." }, "locationInModule": { "filename": "lib/app.ts", "line": 171 }, "name": "fromAppId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "appId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.IApp" } }, "static": true }, { "docs": { "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Adds an environment variable to the auto created branch." }, "locationInModule": { "filename": "lib/app.ts", "line": 285 }, "name": "addAutoBranchEnvironment", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.App" } } }, { "docs": { "stability": "experimental", "summary": "Adds a branch to this application." }, "locationInModule": { "filename": "lib/app.ts", "line": 293 }, "name": "addBranch", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.BranchOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.Branch" } } }, { "docs": { "stability": "experimental", "summary": "Adds a custom rewrite/redirect rule to this application." }, "locationInModule": { "filename": "lib/app.ts", "line": 263 }, "name": "addCustomRule", "parameters": [ { "name": "rule", "type": { "fqn": "@aws-cdk/aws-amplify.CustomRule" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.App" } } }, { "docs": { "stability": "experimental", "summary": "Adds a domain to this application." }, "locationInModule": { "filename": "lib/app.ts", "line": 303 }, "name": "addDomain", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.DomainOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.Domain" } } }, { "docs": { "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Adds an environment variable to this application." }, "locationInModule": { "filename": "lib/app.ts", "line": 274 }, "name": "addEnvironment", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.App" } } } ], "name": "App", "properties": [ { "docs": { "stability": "experimental", "summary": "The application id." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 178 }, "name": "appId", "overrides": "@aws-cdk/aws-amplify.IApp", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The name of the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 185 }, "name": "appName", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The ARN of the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 192 }, "name": "arn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The default domain of the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 199 }, "name": "defaultDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental", "summary": "The principal to grant permissions to." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 204 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-iam.IGrantable", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } } ], "symbolId": "lib/app:App" }, "@aws-cdk/aws-amplify.AppProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for an App.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.AppProps", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 72 }, "name": "AppProps", "properties": [ { "abstract": true, "docs": { "default": "- a CDK generated name", "stability": "experimental", "summary": "The name for the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 78 }, "name": "appName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no auto branch creation", "remarks": "Use this to automatically create\nbranches that match a certain pattern.", "stability": "experimental", "summary": "The auto branch creation configuration." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 93 }, "name": "autoBranchCreation", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.AutoBranchCreation" } }, { "abstract": true, "docs": { "default": "false", "stability": "experimental", "summary": "Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 101 }, "name": "autoBranchDeletion", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no password protection", "remarks": "Use this to set password protection at an\napp level to all your branches.", "stability": "experimental", "summary": "The Basic Auth configuration." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 109 }, "name": "basicAuth", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuth" } }, { "abstract": true, "docs": { "default": "- no build spec", "remarks": "Alternatively, add a `amplify.yml`\nfile to the repository.", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html", "stability": "experimental", "summary": "BuildSpec for the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 119 }, "name": "buildSpec", "optional": true, "type": { "fqn": "@aws-cdk/aws-codebuild.BuildSpec" } }, { "abstract": true, "docs": { "default": "- no custom response headers", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html", "stability": "experimental", "summary": "The custom HTTP response headers for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 129 }, "name": "customResponseHeaders", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-amplify.CustomResponseHeader" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no custom rewrite/redirect rules", "stability": "experimental", "summary": "Custom rewrite/redirect rules for the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 136 }, "name": "customRules", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-amplify.CustomRule" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no description", "stability": "experimental", "summary": "A description for the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 143 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no environment variables", "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Environment variables for the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 153 }, "name": "environmentVariables", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- a new role is created", "remarks": "The App\nimplements IGrantable.", "stability": "experimental", "summary": "The IAM service role to associate with the application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 161 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- not connected to a source code provider", "stability": "experimental", "summary": "The source code provider for this application." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 85 }, "name": "sourceCodeProvider", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.ISourceCodeProvider" } } ], "symbolId": "lib/app:AppProps" }, "@aws-cdk/aws-amplify.AutoBranchCreation": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Auto branch creation configuration.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.AutoBranchCreation", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 315 }, "name": "AutoBranchCreation", "properties": [ { "abstract": true, "docs": { "default": "true", "stability": "experimental", "summary": "Whether to enable auto building for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 343 }, "name": "autoBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no password protection", "remarks": "Use this to set password protection for\nthe auto created branch.", "stability": "experimental", "summary": "The Basic Auth configuration." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 329 }, "name": "basicAuth", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuth" } }, { "abstract": true, "docs": { "default": "- application build spec", "stability": "experimental", "summary": "Build spec for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 336 }, "name": "buildSpec", "optional": true, "type": { "fqn": "@aws-cdk/aws-codebuild.BuildSpec" } }, { "abstract": true, "docs": { "default": "- application environment variables", "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Environment variables for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 360 }, "name": "environmentVariables", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- all repository branches", "stability": "experimental", "summary": "Automated branch creation glob patterns." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 321 }, "name": "patterns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- automatically provision a temporary backend", "stability": "experimental", "summary": "The dedicated backend environment for the pull request previews of the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 368 }, "name": "pullRequestEnvironmentName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "experimental", "summary": "Whether to enable pull request preview for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 350 }, "name": "pullRequestPreview", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no stage", "stability": "experimental", "summary": "Stage for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 375 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/app:AutoBranchCreation" }, "@aws-cdk/aws-amplify.BasicAuth": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "Basic Auth configuration.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n basicAuth: amplify.BasicAuth.fromGeneratedPassword('username'),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.BasicAuth", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 80 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuthProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/basic-auth.ts", "line": 57 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Creates a Basic Auth configuration from a username and a password." }, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 64 }, "name": "fromCredentials", "parameters": [ { "docs": { "summary": "The username." }, "name": "username", "type": { "primitive": "string" } }, { "docs": { "summary": "The password." }, "name": "password", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuth" } }, "static": true }, { "docs": { "stability": "experimental", "summary": "Creates a Basic Auth configuration with a password generated in Secrets Manager." }, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 76 }, "name": "fromGeneratedPassword", "parameters": [ { "docs": { "summary": "The username." }, "name": "username", "type": { "primitive": "string" } }, { "docs": { "summary": "The encryption key to use to encrypt the password in Secrets Manager." }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuth" } }, "static": true }, { "docs": { "stability": "experimental", "summary": "Binds this Basic Auth configuration to an App." }, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 85 }, "name": "bind", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuthConfig" } } } ], "name": "BasicAuth", "symbolId": "lib/basic-auth:BasicAuth" }, "@aws-cdk/aws-amplify.BasicAuthConfig": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "A Basic Auth configuration.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst basicAuthConfig: amplify.BasicAuthConfig = {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.BasicAuthConfig", "kind": "interface", "locationInModule": { "filename": "lib/basic-auth.ts", "line": 37 }, "name": "BasicAuthConfig", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Whether to enable Basic Auth." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 41 }, "name": "enableBasicAuth", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The password." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 51 }, "name": "password", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The username." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 46 }, "name": "username", "type": { "primitive": "string" } } ], "symbolId": "lib/basic-auth:BasicAuthConfig" }, "@aws-cdk/aws-amplify.BasicAuthProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a BasicAuth.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const key: kms.Key;\ndeclare const secretValue: cdk.SecretValue;\nconst basicAuthProps: amplify.BasicAuthProps = {\n username: 'username',\n\n // the properties below are optional\n encryptionKey: key,\n password: secretValue,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.BasicAuthProps", "kind": "interface", "locationInModule": { "filename": "lib/basic-auth.ts", "line": 12 }, "name": "BasicAuthProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The username." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 16 }, "name": "username", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default master key", "stability": "experimental", "summary": "The encryption key to use to encrypt the password when it's generated in Secrets Manager." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 31 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "- A Secrets Manager generated password", "stability": "experimental", "summary": "The password." }, "immutable": true, "locationInModule": { "filename": "lib/basic-auth.ts", "line": 23 }, "name": "password", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "symbolId": "lib/basic-auth:BasicAuthProps" }, "@aws-cdk/aws-amplify.Branch": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.Resource", "docs": { "stability": "experimental", "summary": "An Amplify Console branch.", "example": "declare const amplifyApp: amplify.App;\n\nconst master = amplifyApp.addBranch('master'); // `id` will be used as repo branch name\nconst dev = amplifyApp.addBranch('dev', {\n performanceMode: true, // optional, enables performance mode\n});\ndev.addEnvironment('STAGE', 'dev');", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.Branch", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/branch.ts", "line": 165 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.BranchProps" } } ] }, "interfaces": [ "@aws-cdk/aws-amplify.IBranch" ], "kind": "class", "locationInModule": { "filename": "lib/branch.ts", "line": 143 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Import an existing branch." }, "locationInModule": { "filename": "lib/branch.ts", "line": 147 }, "name": "fromBranchName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "branchName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.IBranch" } }, "static": true }, { "docs": { "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Adds an environment variable to this branch." }, "locationInModule": { "filename": "lib/branch.ts", "line": 208 }, "name": "addEnvironment", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.Branch" } } } ], "name": "Branch", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The ARN of the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 159 }, "name": "arn", "type": { "primitive": "string" } }, { "docs": { "stability": "experimental", "summary": "The name of the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 161 }, "name": "branchName", "overrides": "@aws-cdk/aws-amplify.IBranch", "type": { "primitive": "string" } } ], "symbolId": "lib/branch:Branch" }, "@aws-cdk/aws-amplify.BranchOptions": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Options to add a branch to an application.", "example": "declare const amplifyApp: amplify.App;\n\nconst master = amplifyApp.addBranch('master'); // `id` will be used as repo branch name\nconst dev = amplifyApp.addBranch('dev', {\n performanceMode: true, // optional, enables performance mode\n});\ndev.addEnvironment('STAGE', 'dev');", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.BranchOptions", "kind": "interface", "locationInModule": { "filename": "lib/branch.ts", "line": 38 }, "name": "BranchOptions", "properties": [ { "abstract": true, "docs": { "default": "- no asset", "remarks": "The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's\nstartDeployment API to initiate and deploy a S3 asset onto the App.", "stability": "experimental", "summary": "Asset for deployment." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 116 }, "name": "asset", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.Asset" } }, { "abstract": true, "docs": { "default": "true", "stability": "experimental", "summary": "Whether to enable auto building for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 75 }, "name": "autoBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no password protection", "remarks": "Use this to set password protection for\nthe branch", "stability": "experimental", "summary": "The Basic Auth configuration." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 45 }, "name": "basicAuth", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.BasicAuth" } }, { "abstract": true, "docs": { "default": "- the construct's id", "stability": "experimental", "summary": "The name of the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 52 }, "name": "branchName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no build spec", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html", "stability": "experimental", "summary": "BuildSpec for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 61 }, "name": "buildSpec", "optional": true, "type": { "fqn": "@aws-cdk/aws-codebuild.BuildSpec" } }, { "abstract": true, "docs": { "default": "- no description", "stability": "experimental", "summary": "A description for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 68 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- application environment variables", "remarks": "All environment variables that you add are encrypted to prevent rogue\naccess so you can use them to store secret information.", "stability": "experimental", "summary": "Environment variables for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 92 }, "name": "environmentVariables", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge\nfor a longer interval. When performance mode is enabled, hosting configuration or code changes\ncan take up to 10 minutes to roll out.", "stability": "experimental", "summary": "Enables performance mode for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 127 }, "name": "performanceMode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- automatically provision a temporary backend", "stability": "experimental", "summary": "The dedicated backend environment for the pull request previews." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 99 }, "name": "pullRequestEnvironmentName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "experimental", "summary": "Whether to enable pull request preview for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 82 }, "name": "pullRequestPreview", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no stage", "stability": "experimental", "summary": "Stage for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 106 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/branch:BranchOptions" }, "@aws-cdk/aws-amplify.BranchProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a Branch.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nimport * as codebuild from '@aws-cdk/aws-codebuild';\nimport * as s3_assets from '@aws-cdk/aws-s3-assets';\n\ndeclare const app: amplify.App;\ndeclare const asset: s3_assets.Asset;\ndeclare const basicAuth: amplify.BasicAuth;\ndeclare const buildSpec: codebuild.BuildSpec;\nconst branchProps: amplify.BranchProps = {\n app: app,\n\n // the properties below are optional\n asset: asset,\n autoBuild: false,\n basicAuth: basicAuth,\n branchName: 'branchName',\n buildSpec: buildSpec,\n description: 'description',\n environmentVariables: {\n environmentVariablesKey: 'environmentVariables',\n },\n performanceMode: false,\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n pullRequestPreview: false,\n stage: 'stage',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.BranchProps", "interfaces": [ "@aws-cdk/aws-amplify.BranchOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/branch.ts", "line": 133 }, "name": "BranchProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The application within which the branch must be created." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 137 }, "name": "app", "type": { "fqn": "@aws-cdk/aws-amplify.IApp" } } ], "symbolId": "lib/branch:BranchProps" }, "@aws-cdk/aws-amplify.CfnApp": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Amplify::App", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The AWS::Amplify::App resource specifies Apps in Amplify Hosting. An App is a collection of branches.", "stability": "external", "summary": "A CloudFormation `AWS::Amplify::App`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnApp = new amplify.CfnApp(this, 'MyCfnApp', {\n name: 'name',\n\n // the properties below are optional\n accessToken: 'accessToken',\n autoBranchCreationConfig: {\n autoBranchCreationPatterns: ['autoBranchCreationPatterns'],\n basicAuthConfig: {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n },\n buildSpec: 'buildSpec',\n enableAutoBranchCreation: false,\n enableAutoBuild: false,\n enablePerformanceMode: false,\n enablePullRequestPreview: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n framework: 'framework',\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n stage: 'stage',\n },\n basicAuthConfig: {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n },\n buildSpec: 'buildSpec',\n customHeaders: 'customHeaders',\n customRules: [{\n source: 'source',\n target: 'target',\n\n // the properties below are optional\n condition: 'condition',\n status: 'status',\n }],\n description: 'description',\n enableBranchAutoDeletion: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n iamServiceRole: 'iamServiceRole',\n oauthToken: 'oauthToken',\n platform: 'platform',\n repository: 'repository',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-amplify.CfnApp", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Amplify::App`." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 466 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.CfnAppProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 265 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 497 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 522 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnApp", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 269 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "AppId" }, "stability": "external", "summary": "Unique Id for the Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 294 }, "name": "attrAppId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "AppName" }, "stability": "external", "summary": "Name for the Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 300 }, "name": "attrAppName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "ARN for the Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 306 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DefaultDomain" }, "stability": "external", "summary": "Default domain for the Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 312 }, "name": "attrDefaultDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 502 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags" }, "stability": "external", "summary": "The tag for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 457 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The name for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 323 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken" }, "remarks": "The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.\n\nUse `AccessToken` for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken` .\n\nYou must specify either `AccessToken` or `OauthToken` when you create a new app.\n\nExisting 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](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .\n\n*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The personal access token for a GitHub repository for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 338 }, "name": "accessToken", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig" }, "stability": "external", "summary": "Sets the configuration for your automatic branch creation." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 345 }, "name": "autoBranchCreationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.AutoBranchCreationConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig" }, "remarks": "You must base64-encode the authorization credentials and provide them in the format `user:password` .", "stability": "external", "summary": "The credentials for basic authorization for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 352 }, "name": "basicAuthConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.BasicAuthConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The build specification (build spec) for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 363 }, "name": "buildSpec", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customheaders" }, "remarks": "*Length Constraints:* Minimum length of 0. Maximum length of 25000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The custom HTTP headers for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 374 }, "name": "customHeaders", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules" }, "stability": "external", "summary": "The custom rewrite and redirect rules for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 381 }, "name": "customRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.CustomRuleProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The description for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 392 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion" }, "stability": "external", "summary": "Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 399 }, "name": "enableBranchAutoDeletion", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables" }, "stability": "external", "summary": "The environment variables map for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 406 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.EnvironmentVariableProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole" }, "remarks": "*Length Constraints:* Minimum length of 0. Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 417 }, "name": "iamServiceRole", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken" }, "remarks": "The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.\n\nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use `AccessToken` .\n\nYou must specify either `OauthToken` or `AccessToken` when you create a new app.\n\nExisting 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](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .\n\n*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The OAuth token for a third-party source control system for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 434 }, "name": "oauthToken", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-platform" }, "remarks": "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` .", "stability": "external", "summary": "The platform for the Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 441 }, "name": "platform", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository" }, "remarks": "*Pattern:* (?s).*", "stability": "external", "summary": "The repository for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 450 }, "name": "repository", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnApp" }, "@aws-cdk/aws-amplify.CfnApp.AutoBranchCreationConfigProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst autoBranchCreationConfigProperty: amplify.CfnApp.AutoBranchCreationConfigProperty = {\n autoBranchCreationPatterns: ['autoBranchCreationPatterns'],\n basicAuthConfig: {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n },\n buildSpec: 'buildSpec',\n enableAutoBranchCreation: false,\n enableAutoBuild: false,\n enablePerformanceMode: false,\n enablePullRequestPreview: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n framework: 'framework',\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n stage: 'stage',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnApp.AutoBranchCreationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 536 }, "name": "AutoBranchCreationConfigProperty", "namespace": "CfnApp", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-autobranchcreationpatterns" }, "stability": "external", "summary": "Automated branch creation glob patterns for the Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 542 }, "name": "autoBranchCreationPatterns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-basicauthconfig" }, "stability": "external", "summary": "Sets password protection for your auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 548 }, "name": "basicAuthConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.BasicAuthConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-buildspec" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 25000.", "stability": "external", "summary": "The build specification (build spec) for the autocreated branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 556 }, "name": "buildSpec", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobranchcreation" }, "stability": "external", "summary": "Enables automated branch creation for the Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 562 }, "name": "enableAutoBranchCreation", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableautobuild" }, "stability": "external", "summary": "Enables auto building for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 568 }, "name": "enableAutoBuild", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enableperformancemode" }, "remarks": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.", "stability": "external", "summary": "Enables performance mode for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 576 }, "name": "enablePerformanceMode", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-enablepullrequestpreview" }, "remarks": "Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.\n\nTo provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.\n\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .", "stability": "external", "summary": "Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 586 }, "name": "enablePullRequestPreview", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-environmentvariables" }, "stability": "external", "summary": "Environment variables for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 592 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.EnvironmentVariableProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-framework" }, "stability": "external", "summary": "The framework for the autocreated branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 598 }, "name": "framework", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-pullrequestenvironmentname" }, "remarks": "For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.\n\nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true` .\n\nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.\n\nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .\n\n*Length Constraints:* Maximum length of 20.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 614 }, "name": "pullRequestEnvironmentName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html#cfn-amplify-app-autobranchcreationconfig-stage" }, "stability": "external", "summary": "Stage for the auto created branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 620 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnApp.AutoBranchCreationConfigProperty" }, "@aws-cdk/aws-amplify.CfnApp.BasicAuthConfigProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Use the BasicAuthConfig property type to set password protection at an app level to all your branches.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst basicAuthConfigProperty: amplify.CfnApp.BasicAuthConfigProperty = {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnApp.BasicAuthConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 711 }, "name": "BasicAuthConfigProperty", "namespace": "CfnApp", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-enablebasicauth" }, "stability": "external", "summary": "Enables basic authorization for the Amplify app's branches." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 717 }, "name": "enableBasicAuth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-password" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The password for basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 725 }, "name": "password", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-username" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The user name for basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 733 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnApp.BasicAuthConfigProperty" }, "@aws-cdk/aws-amplify.CfnApp.CustomRuleProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Redirects enable a web app to reroute navigation from one URL to another.", "stability": "external", "summary": "The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst customRuleProperty: amplify.CfnApp.CustomRuleProperty = {\n source: 'source',\n target: 'target',\n\n // the properties below are optional\n condition: 'condition',\n status: 'status',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnApp.CustomRuleProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 800 }, "name": "CustomRuleProperty", "namespace": "CfnApp", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-source" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 2048.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The source pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 820 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-target" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 2048.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The target pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 846 }, "name": "target", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-condition" }, "remarks": "*Length Constraints:* Minimum length of 0. Maximum length of 2048.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The condition for a URL rewrite or redirect rule, such as a country code." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 810 }, "name": "condition", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-status" }, "remarks": "- **200** - Represents a 200 rewrite rule.\n- **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.\n- **302** - Represents a 302 temporary redirect rule.\n- **404** - Represents a 404 redirect rule.\n- **404-200** - Represents a 404 rewrite rule.\n\n*Length Constraints:* Minimum length of 3. Maximum length of 7.\n\n*Pattern:* .{3,7}", "stability": "external", "summary": "The status code for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 836 }, "name": "status", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnApp.CustomRuleProperty" }, "@aws-cdk/aws-amplify.CfnApp.EnvironmentVariableProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Set environment variables for all branches in your app.", "stability": "external", "summary": "Environment variables are key-value pairs that are available at build time.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst environmentVariableProperty: amplify.CfnApp.EnvironmentVariableProperty = {\n name: 'name',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnApp.EnvironmentVariableProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 918 }, "name": "EnvironmentVariableProperty", "namespace": "CfnApp", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-name" }, "remarks": "*Length Constraints:* Maximum length of 255.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The environment variable name." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 928 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html#cfn-amplify-app-environmentvariable-value" }, "remarks": "*Length Constraints:* Maximum length of 5500.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The environment variable value." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 938 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnApp.EnvironmentVariableProperty" }, "@aws-cdk/aws-amplify.CfnAppProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnApp`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnAppProps: amplify.CfnAppProps = {\n name: 'name',\n\n // the properties below are optional\n accessToken: 'accessToken',\n autoBranchCreationConfig: {\n autoBranchCreationPatterns: ['autoBranchCreationPatterns'],\n basicAuthConfig: {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n },\n buildSpec: 'buildSpec',\n enableAutoBranchCreation: false,\n enableAutoBuild: false,\n enablePerformanceMode: false,\n enablePullRequestPreview: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n framework: 'framework',\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n stage: 'stage',\n },\n basicAuthConfig: {\n enableBasicAuth: false,\n password: 'password',\n username: 'username',\n },\n buildSpec: 'buildSpec',\n customHeaders: 'customHeaders',\n customRules: [{\n source: 'source',\n target: 'target',\n\n // the properties below are optional\n condition: 'condition',\n status: 'status',\n }],\n description: 'description',\n enableBranchAutoDeletion: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n iamServiceRole: 'iamServiceRole',\n oauthToken: 'oauthToken',\n platform: 'platform',\n repository: 'repository',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnAppProps", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 19 }, "name": "CfnAppProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The name for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 30 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken" }, "remarks": "The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.\n\nUse `AccessToken` for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken` .\n\nYou must specify either `AccessToken` or `OauthToken` when you create a new app.\n\nExisting 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](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .\n\n*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The personal access token for a GitHub repository for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 45 }, "name": "accessToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig" }, "stability": "external", "summary": "Sets the configuration for your automatic branch creation." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 52 }, "name": "autoBranchCreationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.AutoBranchCreationConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig" }, "remarks": "You must base64-encode the authorization credentials and provide them in the format `user:password` .", "stability": "external", "summary": "The credentials for basic authorization for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 59 }, "name": "basicAuthConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.BasicAuthConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The build specification (build spec) for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 70 }, "name": "buildSpec", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customheaders" }, "remarks": "*Length Constraints:* Minimum length of 0. Maximum length of 25000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The custom HTTP headers for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 81 }, "name": "customHeaders", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules" }, "stability": "external", "summary": "The custom rewrite and redirect rules for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 88 }, "name": "customRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.CustomRuleProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The description for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 99 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion" }, "stability": "external", "summary": "Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 106 }, "name": "enableBranchAutoDeletion", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables" }, "stability": "external", "summary": "The environment variables map for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 113 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnApp.EnvironmentVariableProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole" }, "remarks": "*Length Constraints:* Minimum length of 0. Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 124 }, "name": "iamServiceRole", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken" }, "remarks": "The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.\n\nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use `AccessToken` .\n\nYou must specify either `OauthToken` or `AccessToken` when you create a new app.\n\nExisting 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](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .\n\n*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The OAuth token for a third-party source control system for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 141 }, "name": "oauthToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-platform" }, "remarks": "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` .", "stability": "external", "summary": "The platform for the Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 148 }, "name": "platform", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository" }, "remarks": "*Pattern:* (?s).*", "stability": "external", "summary": "The repository for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 157 }, "name": "repository", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags" }, "stability": "external", "summary": "The tag for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 164 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/amplify.generated:CfnAppProps" }, "@aws-cdk/aws-amplify.CfnBranch": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Amplify::Branch", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The AWS::Amplify::Branch resource specifies a new branch within an app.", "stability": "external", "summary": "A CloudFormation `AWS::Amplify::Branch`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnBranch = new amplify.CfnBranch(this, 'MyCfnBranch', {\n appId: 'appId',\n branchName: 'branchName',\n\n // the properties below are optional\n basicAuthConfig: {\n password: 'password',\n username: 'username',\n\n // the properties below are optional\n enableBasicAuth: false,\n },\n buildSpec: 'buildSpec',\n description: 'description',\n enableAutoBuild: false,\n enablePerformanceMode: false,\n enablePullRequestPreview: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n framework: 'framework',\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n stage: 'stage',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-amplify.CfnBranch", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Amplify::Branch`." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1393 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.CfnBranchProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1224 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1421 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1444 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnBranch", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1228 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "ARN for a branch, part of an Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1253 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "BranchName" }, "stability": "external", "summary": "Name for a branch, part of an Amplify App." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1259 }, "name": "attrBranchName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1426 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags" }, "stability": "external", "summary": "The tag for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1384 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 20.\n\n*Pattern:* d[a-z0-9]+", "stability": "external", "summary": "The unique ID for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1270 }, "name": "appId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The name for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1281 }, "name": "branchName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig" }, "remarks": "You must base64-encode the authorization credentials and provide them in the format `user:password` .", "stability": "external", "summary": "The basic authorization credentials for a branch of an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1288 }, "name": "basicAuthConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnBranch.BasicAuthConfigProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The build specification (build spec) for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1299 }, "name": "buildSpec", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The description for the branch that is part of an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1310 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild" }, "stability": "external", "summary": "Enables auto building for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1317 }, "name": "enableAutoBuild", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode" }, "remarks": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.", "stability": "external", "summary": "Enables performance mode for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1326 }, "name": "enablePerformanceMode", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview" }, "remarks": "If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.\n\nTo provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.\n\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .", "stability": "external", "summary": "Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1337 }, "name": "enablePullRequestPreview", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables" }, "stability": "external", "summary": "The environment variables for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1344 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnBranch.EnvironmentVariableProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-framework" }, "stability": "external", "summary": "The framework for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1351 }, "name": "framework", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname" }, "remarks": "For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.\n\nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true` .\n\nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.\n\nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .\n\n*Length Constraints:* Maximum length of 20.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1368 }, "name": "pullRequestEnvironmentName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage" }, "remarks": "*Valid Values:* PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST", "stability": "external", "summary": "Describes the current stage for the branch." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1377 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnBranch" }, "@aws-cdk/aws-amplify.CfnBranch.BasicAuthConfigProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Use the BasicAuthConfig property type to set password protection for a specific branch.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst basicAuthConfigProperty: amplify.CfnBranch.BasicAuthConfigProperty = {\n password: 'password',\n username: 'username',\n\n // the properties below are optional\n enableBasicAuth: false,\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnBranch.BasicAuthConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1458 }, "name": "BasicAuthConfigProperty", "namespace": "CfnBranch", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-password" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The password for basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1472 }, "name": "password", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-username" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.", "stability": "external", "summary": "The user name for basic authorization." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1480 }, "name": "username", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-enablebasicauth" }, "stability": "external", "summary": "Enables basic authorization for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1464 }, "name": "enableBasicAuth", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/amplify.generated:CfnBranch.BasicAuthConfigProperty" }, "@aws-cdk/aws-amplify.CfnBranch.EnvironmentVariableProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Environment variables are key-value pairs that are available at build time.", "stability": "external", "summary": "The EnvironmentVariable property type sets environment variables for a specific branch.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst environmentVariableProperty: amplify.CfnBranch.EnvironmentVariableProperty = {\n name: 'name',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnBranch.EnvironmentVariableProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1549 }, "name": "EnvironmentVariableProperty", "namespace": "CfnBranch", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-name" }, "remarks": "*Length Constraints:* Maximum length of 255.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The environment variable name." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1559 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html#cfn-amplify-branch-environmentvariable-value" }, "remarks": "*Length Constraints:* Maximum length of 5500.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The environment variable value." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1569 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnBranch.EnvironmentVariableProperty" }, "@aws-cdk/aws-amplify.CfnBranchProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnBranch`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnBranchProps: amplify.CfnBranchProps = {\n appId: 'appId',\n branchName: 'branchName',\n\n // the properties below are optional\n basicAuthConfig: {\n password: 'password',\n username: 'username',\n\n // the properties below are optional\n enableBasicAuth: false,\n },\n buildSpec: 'buildSpec',\n description: 'description',\n enableAutoBuild: false,\n enablePerformanceMode: false,\n enablePullRequestPreview: false,\n environmentVariables: [{\n name: 'name',\n value: 'value',\n }],\n framework: 'framework',\n pullRequestEnvironmentName: 'pullRequestEnvironmentName',\n stage: 'stage',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnBranchProps", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1003 }, "name": "CfnBranchProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 20.\n\n*Pattern:* d[a-z0-9]+", "stability": "external", "summary": "The unique ID for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1014 }, "name": "appId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The name for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1025 }, "name": "branchName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-basicauthconfig" }, "remarks": "You must base64-encode the authorization credentials and provide them in the format `user:password` .", "stability": "external", "summary": "The basic authorization credentials for a branch of an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1032 }, "name": "basicAuthConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnBranch.BasicAuthConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-buildspec" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 25000.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The build specification (build spec) for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1043 }, "name": "buildSpec", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-description" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The description for the branch that is part of an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1054 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild" }, "stability": "external", "summary": "Enables auto building for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1061 }, "name": "enableAutoBuild", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableperformancemode" }, "remarks": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.", "stability": "external", "summary": "Enables performance mode for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1070 }, "name": "enablePerformanceMode", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview" }, "remarks": "If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.\n\nTo provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.\n\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .", "stability": "external", "summary": "Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1081 }, "name": "enablePullRequestPreview", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-environmentvariables" }, "stability": "external", "summary": "The environment variables for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1088 }, "name": "environmentVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnBranch.EnvironmentVariableProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-framework" }, "stability": "external", "summary": "The framework for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1095 }, "name": "framework", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname" }, "remarks": "For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.\n\nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true` .\n\nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.\n\nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .\n\n*Length Constraints:* Maximum length of 20.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1112 }, "name": "pullRequestEnvironmentName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage" }, "remarks": "*Valid Values:* PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST", "stability": "external", "summary": "Describes the current stage for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1121 }, "name": "stage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-tags" }, "stability": "external", "summary": "The tag for the branch." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1128 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/amplify.generated:CfnBranchProps" }, "@aws-cdk/aws-amplify.CfnDomain": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Amplify::Domain", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.", "stability": "external", "summary": "A CloudFormation `AWS::Amplify::Domain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnDomain = new amplify.CfnDomain(this, 'MyCfnDomain', {\n appId: 'appId',\n domainName: 'domainName',\n subDomainSettings: [{\n branchName: 'branchName',\n prefix: 'prefix',\n }],\n\n // the properties below are optional\n autoSubDomainCreationPatterns: ['autoSubDomainCreationPatterns'],\n autoSubDomainIamRole: 'autoSubDomainIamRole',\n enableAutoSubDomain: false,\n});" }, "fqn": "@aws-cdk/aws-amplify.CfnDomain", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Amplify::Domain`." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1898 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.CfnDomainProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1764 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1926 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1942 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDomain", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1768 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "ARN for the Domain Association." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1793 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "AutoSubDomainCreationPatterns" }, "stability": "external", "summary": "Branch patterns for the automatically created subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1799 }, "name": "attrAutoSubDomainCreationPatterns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "cloudformationAttribute": "AutoSubDomainIAMRole" }, "stability": "external", "summary": "The IAM service role for the subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1805 }, "name": "attrAutoSubDomainIamRole", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "CertificateRecord" }, "stability": "external", "summary": "DNS Record for certificate verification." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1811 }, "name": "attrCertificateRecord", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DomainName" }, "stability": "external", "summary": "Name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1817 }, "name": "attrDomainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DomainStatus" }, "stability": "external", "summary": "Status for the Domain Association." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1823 }, "name": "attrDomainStatus", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "EnableAutoSubDomain" }, "stability": "external", "summary": "Specifies whether the automated creation of subdomains for branches is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1829 }, "name": "attrEnableAutoSubDomain", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "cloudformationAttribute": "StatusReason" }, "stability": "external", "summary": "Reason for the current status of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1835 }, "name": "attrStatusReason", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1931 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 20.\n\n*Pattern:* d[a-z0-9]+", "stability": "external", "summary": "The unique ID for an Amplify app." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1846 }, "name": "appId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname" }, "remarks": "*Length Constraints:* Maximum length of 255.\n\n*Pattern:* ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$", "stability": "external", "summary": "The domain name for the domain association." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1857 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings" }, "stability": "external", "summary": "The setting for the subdomain." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1864 }, "name": "subDomainSettings", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnDomain.SubDomainSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns" }, "stability": "external", "summary": "Sets the branch patterns for automatic subdomain creation." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1871 }, "name": "autoSubDomainCreationPatterns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* ^$|^arn:aws:iam::\\d{12}:role.+", "stability": "external", "summary": "The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1882 }, "name": "autoSubDomainIamRole", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain" }, "stability": "external", "summary": "Enables the automated creation of subdomains for branches." }, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1889 }, "name": "enableAutoSubDomain", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/amplify.generated:CfnDomain" }, "@aws-cdk/aws-amplify.CfnDomain.SubDomainSettingProperty": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst subDomainSettingProperty: amplify.CfnDomain.SubDomainSettingProperty = {\n branchName: 'branchName',\n prefix: 'prefix',\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnDomain.SubDomainSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1956 }, "name": "SubDomainSettingProperty", "namespace": "CfnDomain", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+", "stability": "external", "summary": "The branch name setting for the subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1966 }, "name": "branchName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix" }, "remarks": "*Length Constraints:* Maximum length of 255.\n\n*Pattern:* (?s).*", "stability": "external", "summary": "The prefix setting for the subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1976 }, "name": "prefix", "type": { "primitive": "string" } } ], "symbolId": "lib/amplify.generated:CfnDomain.SubDomainSettingProperty" }, "@aws-cdk/aws-amplify.CfnDomainProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDomain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst cfnDomainProps: amplify.CfnDomainProps = {\n appId: 'appId',\n domainName: 'domainName',\n subDomainSettings: [{\n branchName: 'branchName',\n prefix: 'prefix',\n }],\n\n // the properties below are optional\n autoSubDomainCreationPatterns: ['autoSubDomainCreationPatterns'],\n autoSubDomainIamRole: 'autoSubDomainIamRole',\n enableAutoSubDomain: false,\n};" }, "fqn": "@aws-cdk/aws-amplify.CfnDomainProps", "kind": "interface", "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1634 }, "name": "CfnDomainProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid" }, "remarks": "*Length Constraints:* Minimum length of 1. Maximum length of 20.\n\n*Pattern:* d[a-z0-9]+", "stability": "external", "summary": "The unique ID for an Amplify app." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1645 }, "name": "appId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname" }, "remarks": "*Length Constraints:* Maximum length of 255.\n\n*Pattern:* ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$", "stability": "external", "summary": "The domain name for the domain association." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1656 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings" }, "stability": "external", "summary": "The setting for the subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1663 }, "name": "subDomainSettings", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-amplify.CfnDomain.SubDomainSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns" }, "stability": "external", "summary": "Sets the branch patterns for automatic subdomain creation." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1670 }, "name": "autoSubDomainCreationPatterns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole" }, "remarks": "*Length Constraints:* Maximum length of 1000.\n\n*Pattern:* ^$|^arn:aws:iam::\\d{12}:role.+", "stability": "external", "summary": "The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1681 }, "name": "autoSubDomainIamRole", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain" }, "stability": "external", "summary": "Enables the automated creation of subdomains for branches." }, "immutable": true, "locationInModule": { "filename": "lib/amplify.generated.ts", "line": 1688 }, "name": "enableAutoSubDomain", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/amplify.generated:CfnDomainProps" }, "@aws-cdk/aws-amplify.CodeCommitSourceCodeProvider": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "CodeCommit source code provider.", "example": "import * as codecommit from '@aws-cdk/aws-codecommit';\n\nconst repository = new codecommit.Repository(this, 'Repo', {\n repositoryName: 'my-repo',\n});\n\nconst amplifyApp = new amplify.App(this, 'App', {\n sourceCodeProvider: new amplify.CodeCommitSourceCodeProvider({ repository }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.CodeCommitSourceCodeProvider", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 87 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.CodeCommitSourceCodeProviderProps" } } ] }, "interfaces": [ "@aws-cdk/aws-amplify.ISourceCodeProvider" ], "kind": "class", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 86 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Binds the source code provider to an app." }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 89 }, "name": "bind", "overrides": "@aws-cdk/aws-amplify.ISourceCodeProvider", "parameters": [ { "name": "app", "type": { "fqn": "@aws-cdk/aws-amplify.App" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.SourceCodeProviderConfig" } } } ], "name": "CodeCommitSourceCodeProvider", "symbolId": "lib/source-code-providers:CodeCommitSourceCodeProvider" }, "@aws-cdk/aws-amplify.CodeCommitSourceCodeProviderProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a CodeCommit source code provider.", "example": "import * as codecommit from '@aws-cdk/aws-codecommit';\n\nconst repository = new codecommit.Repository(this, 'Repo', {\n repositoryName: 'my-repo',\n});\n\nconst amplifyApp = new amplify.App(this, 'App', {\n sourceCodeProvider: new amplify.CodeCommitSourceCodeProvider({ repository }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.CodeCommitSourceCodeProviderProps", "kind": "interface", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 76 }, "name": "CodeCommitSourceCodeProviderProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The CodeCommit repository." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 80 }, "name": "repository", "type": { "fqn": "@aws-cdk/aws-codecommit.IRepository" } } ], "symbolId": "lib/source-code-providers:CodeCommitSourceCodeProviderProps" }, "@aws-cdk/aws-amplify.CustomResponseHeader": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Custom response header of an Amplify App.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst customResponseHeader: amplify.CustomResponseHeader = {\n headers: {\n headersKey: 'headers',\n },\n pattern: 'pattern',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.CustomResponseHeader", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 504 }, "name": "CustomResponseHeader", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The map of custom headers to be applied." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 513 }, "name": "headers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "These custom headers will be applied to all URL file paths that match this pattern." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 508 }, "name": "pattern", "type": { "primitive": "string" } } ], "symbolId": "lib/app:CustomResponseHeader" }, "@aws-cdk/aws-amplify.CustomRule": { "assembly": "@aws-cdk/aws-amplify", "docs": { "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "Custom rewrite/redirect rule for an Amplify App.", "example": "declare const amplifyApp: amplify.App;\namplifyApp.addCustomRule({\n source: '/docs/specific-filename.html',\n target: '/documents/different-filename.html',\n status: amplify.RedirectStatus.TEMPORARY_REDIRECT,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.CustomRule", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/app.ts", "line": 493 }, "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-amplify.CustomRuleOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/app.ts", "line": 450 }, "name": "CustomRule", "properties": [ { "const": true, "docs": { "stability": "experimental", "summary": "Sets up a 200 rewrite for all paths to `index.html` except for path containing a file extension." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 455 }, "name": "SINGLE_PAGE_APPLICATION_REDIRECT", "static": true, "type": { "fqn": "@aws-cdk/aws-amplify.CustomRule" } }, { "docs": { "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The source pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 466 }, "name": "source", "type": { "primitive": "string" } }, { "docs": { "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The target pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 473 }, "name": "target", "type": { "primitive": "string" } }, { "docs": { "default": "- no condition", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The condition for a URL rewrite or redirect rule, e.g. country code." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 491 }, "name": "condition", "optional": true, "type": { "primitive": "string" } }, { "docs": { "default": "PERMANENT_REDIRECT", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The status code for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 482 }, "name": "status", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.RedirectStatus" } } ], "symbolId": "lib/app:CustomRule" }, "@aws-cdk/aws-amplify.CustomRuleOptions": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Options for a custom rewrite/redirect rule for an Amplify App.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nconst customRuleOptions: amplify.CustomRuleOptions = {\n source: 'source',\n target: 'target',\n\n // the properties below are optional\n condition: 'condition',\n status: amplify.RedirectStatus.REWRITE,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.CustomRuleOptions", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 411 }, "name": "CustomRuleOptions", "properties": [ { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The source pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 417 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The target pattern for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 424 }, "name": "target", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no condition", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The condition for a URL rewrite or redirect rule, e.g. country code." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 442 }, "name": "condition", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "PERMANENT_REDIRECT", "see": "https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html", "stability": "experimental", "summary": "The status code for a URL rewrite or redirect rule." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 433 }, "name": "status", "optional": true, "type": { "fqn": "@aws-cdk/aws-amplify.RedirectStatus" } } ], "symbolId": "lib/app:CustomRuleOptions" }, "@aws-cdk/aws-amplify.Domain": { "assembly": "@aws-cdk/aws-amplify", "base": "@aws-cdk/core.Resource", "docs": { "stability": "experimental", "summary": "An Amplify Console domain.", "example": "declare const amplifyApp: amplify.App;\ndeclare const master: amplify.Branch;\ndeclare const dev: amplify.Branch;\n\nconst domain = amplifyApp.addDomain('example.com', {\n enableAutoSubdomain: true, // in case subdomains should be auto registered for branches\n autoSubdomainCreationPatterns: ['*', 'pr*'], // regex for branches that should auto register subdomains\n});\ndomain.mapRoot(master); // map master branch to domain root\ndomain.mapSubDomain(master, 'www');\ndomain.mapSubDomain(dev); // sub domain prefix defaults to branch name", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.Domain", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/domain.ts", "line": 120 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.DomainProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/domain.ts", "line": 60 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Maps a branch to the domain root." }, "locationInModule": { "filename": "lib/domain.ts", "line": 159 }, "name": "mapRoot", "parameters": [ { "name": "branch", "type": { "fqn": "@aws-cdk/aws-amplify.IBranch" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.Domain" } } }, { "docs": { "stability": "experimental", "summary": "Maps a branch to a sub domain." }, "locationInModule": { "filename": "lib/domain.ts", "line": 151 }, "name": "mapSubDomain", "parameters": [ { "docs": { "summary": "The branch." }, "name": "branch", "type": { "fqn": "@aws-cdk/aws-amplify.IBranch" } }, { "docs": { "remarks": "Use '' to map to the root of the domain. Defaults to branch name.", "summary": "The prefix." }, "name": "prefix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.Domain" } } }, { "docs": { "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.", "stability": "experimental", "summary": "Validate the current construct." }, "locationInModule": { "filename": "lib/domain.ts", "line": 163 }, "name": "validate", "overrides": "@aws-cdk/core.Construct", "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "Domain", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The ARN of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 67 }, "name": "arn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The DNS Record for certificate verification." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 74 }, "name": "certificateRecord", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "Branch patterns for the automatically created subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 102 }, "name": "domainAutoSubDomainCreationPatterns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The IAM service role for the subdomain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 109 }, "name": "domainAutoSubDomainIamRole", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "Specifies whether the automated creation of subdomains for branches is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 116 }, "name": "domainEnableAutoSubDomain", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 81 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The status of the domain association." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 88 }, "name": "domainStatus", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The reason for the current status of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 95 }, "name": "statusReason", "type": { "primitive": "string" } } ], "symbolId": "lib/domain:Domain" }, "@aws-cdk/aws-amplify.DomainOptions": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Options to add a domain to an application.", "example": "declare const amplifyApp: amplify.App;\ndeclare const master: amplify.Branch;\ndeclare const dev: amplify.Branch;\n\nconst domain = amplifyApp.addDomain('example.com', {\n enableAutoSubdomain: true, // in case subdomains should be auto registered for branches\n autoSubdomainCreationPatterns: ['*', 'pr*'], // regex for branches that should auto register subdomains\n});\ndomain.mapRoot(master); // map master branch to domain root\ndomain.mapSubDomain(master, 'www');\ndomain.mapSubDomain(dev); // sub domain prefix defaults to branch name", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.DomainOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 11 }, "name": "DomainOptions", "properties": [ { "abstract": true, "docs": { "default": "- all repository branches ['*', 'pr*']", "stability": "experimental", "summary": "Branches which should automatically create subdomains." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 38 }, "name": "autoSubdomainCreationPatterns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the construct's id", "stability": "experimental", "summary": "The name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 17 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "experimental", "summary": "Automatically create subdomains for connected branches." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 31 }, "name": "enableAutoSubdomain", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- use `addSubDomain()` to add subdomains", "stability": "experimental", "summary": "Subdomains." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 24 }, "name": "subDomains", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-amplify.SubDomain" }, "kind": "array" } } } ], "symbolId": "lib/domain:DomainOptions" }, "@aws-cdk/aws-amplify.DomainProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a Domain.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nimport * as iam from '@aws-cdk/aws-iam';\n\ndeclare const app: amplify.App;\ndeclare const branch: amplify.Branch;\ndeclare const role: iam.Role;\nconst domainProps: amplify.DomainProps = {\n app: app,\n\n // the properties below are optional\n autoSubdomainCreationPatterns: ['autoSubdomainCreationPatterns'],\n autoSubDomainIamRole: role,\n domainName: 'domainName',\n enableAutoSubdomain: false,\n subDomains: [{\n branch: branch,\n\n // the properties below are optional\n prefix: 'prefix',\n }],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.DomainProps", "interfaces": [ "@aws-cdk/aws-amplify.DomainOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 44 }, "name": "DomainProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The application to which the domain must be connected." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 48 }, "name": "app", "type": { "fqn": "@aws-cdk/aws-amplify.IApp" } }, { "abstract": true, "docs": { "default": "the IAM role from App.grantPrincipal", "stability": "experimental", "summary": "The IAM role with access to Route53 when using enableAutoSubdomain." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 54 }, "name": "autoSubDomainIamRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ], "symbolId": "lib/domain:DomainProps" }, "@aws-cdk/aws-amplify.GitHubSourceCodeProvider": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "GitHub source code provider.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.GitHubSourceCodeProvider", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 29 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.GitHubSourceCodeProviderProps" } } ] }, "interfaces": [ "@aws-cdk/aws-amplify.ISourceCodeProvider" ], "kind": "class", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 28 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Binds the source code provider to an app." }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 31 }, "name": "bind", "overrides": "@aws-cdk/aws-amplify.ISourceCodeProvider", "parameters": [ { "name": "_app", "type": { "fqn": "@aws-cdk/aws-amplify.App" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.SourceCodeProviderConfig" } } } ], "name": "GitHubSourceCodeProvider", "symbolId": "lib/source-code-providers:GitHubSourceCodeProvider" }, "@aws-cdk/aws-amplify.GitHubSourceCodeProviderProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a GitHub source code provider.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitHubSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-github-token'),\n }),\n autoBranchCreation: { // Automatically connect branches that match a pattern set\n patterns: ['feature/*', 'test/*'],\n },\n autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.GitHubSourceCodeProviderProps", "kind": "interface", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 8 }, "name": "GitHubSourceCodeProviderProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "A personal access token with the `repo` scope." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 22 }, "name": "oauthToken", "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The user or organization owning the repository." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 12 }, "name": "owner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the repository." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 17 }, "name": "repository", "type": { "primitive": "string" } } ], "symbolId": "lib/source-code-providers:GitHubSourceCodeProviderProps" }, "@aws-cdk/aws-amplify.GitLabSourceCodeProvider": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "GitLab source code provider.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitLabSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-gitlab-token'),\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.GitLabSourceCodeProvider", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 63 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-amplify.GitLabSourceCodeProviderProps" } } ] }, "interfaces": [ "@aws-cdk/aws-amplify.ISourceCodeProvider" ], "kind": "class", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 62 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Binds the source code provider to an app." }, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 65 }, "name": "bind", "overrides": "@aws-cdk/aws-amplify.ISourceCodeProvider", "parameters": [ { "name": "_app", "type": { "fqn": "@aws-cdk/aws-amplify.App" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.SourceCodeProviderConfig" } } } ], "name": "GitLabSourceCodeProvider", "symbolId": "lib/source-code-providers:GitLabSourceCodeProvider" }, "@aws-cdk/aws-amplify.GitLabSourceCodeProviderProps": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Properties for a GitLab source code provider.", "example": "const amplifyApp = new amplify.App(this, 'MyApp', {\n sourceCodeProvider: new amplify.GitLabSourceCodeProvider({\n owner: '',\n repository: '',\n oauthToken: SecretValue.secretsManager('my-gitlab-token'),\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.GitLabSourceCodeProviderProps", "kind": "interface", "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 42 }, "name": "GitLabSourceCodeProviderProps", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "A personal access token with the `repo` scope." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 56 }, "name": "oauthToken", "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The user or organization owning the repository." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 46 }, "name": "owner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "The name of the repository." }, "immutable": true, "locationInModule": { "filename": "lib/source-code-providers.ts", "line": 51 }, "name": "repository", "type": { "primitive": "string" } } ], "symbolId": "lib/source-code-providers:GitLabSourceCodeProviderProps" }, "@aws-cdk/aws-amplify.IApp": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "An Amplify Console application." }, "fqn": "@aws-cdk/aws-amplify.IApp", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 14 }, "name": "IApp", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The application id." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 20 }, "name": "appId", "type": { "primitive": "string" } } ], "symbolId": "lib/app:IApp" }, "@aws-cdk/aws-amplify.IBranch": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "A branch." }, "fqn": "@aws-cdk/aws-amplify.IBranch", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/branch.ts", "line": 26 }, "name": "IBranch", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "experimental", "summary": "The name of the branch." }, "immutable": true, "locationInModule": { "filename": "lib/branch.ts", "line": 32 }, "name": "branchName", "type": { "primitive": "string" } } ], "symbolId": "lib/branch:IBranch" }, "@aws-cdk/aws-amplify.ISourceCodeProvider": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "A source code provider." }, "fqn": "@aws-cdk/aws-amplify.ISourceCodeProvider", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 60 }, "methods": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "Binds the source code provider to an app." }, "locationInModule": { "filename": "lib/app.ts", "line": 66 }, "name": "bind", "parameters": [ { "docs": { "summary": "The app [disable-awslint:ref-via-interface]." }, "name": "app", "type": { "fqn": "@aws-cdk/aws-amplify.App" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-amplify.SourceCodeProviderConfig" } } } ], "name": "ISourceCodeProvider", "symbolId": "lib/app:ISourceCodeProvider" }, "@aws-cdk/aws-amplify.RedirectStatus": { "assembly": "@aws-cdk/aws-amplify", "docs": { "stability": "experimental", "summary": "The status code for a URL rewrite or redirect rule.", "example": "declare const amplifyApp: amplify.App;\namplifyApp.addCustomRule({\n source: '/docs/specific-filename.html',\n target: '/documents/different-filename.html',\n status: amplify.RedirectStatus.TEMPORARY_REDIRECT,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-amplify.RedirectStatus", "kind": "enum", "locationInModule": { "filename": "lib/app.ts", "line": 381 }, "members": [ { "docs": { "stability": "experimental", "summary": "Rewrite (200)." }, "name": "REWRITE" }, { "docs": { "stability": "experimental", "summary": "Permanent redirect (301)." }, "name": "PERMANENT_REDIRECT" }, { "docs": { "stability": "experimental", "summary": "Temporary redirect (302)." }, "name": "TEMPORARY_REDIRECT" }, { "docs": { "stability": "experimental", "summary": "Not found (404)." }, "name": "NOT_FOUND" }, { "docs": { "stability": "experimental", "summary": "Not found rewrite (404)." }, "name": "NOT_FOUND_REWRITE" } ], "name": "RedirectStatus", "symbolId": "lib/app:RedirectStatus" }, "@aws-cdk/aws-amplify.SourceCodeProviderConfig": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Configuration for the source code provider.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const secretValue: cdk.SecretValue;\nconst sourceCodeProviderConfig: amplify.SourceCodeProviderConfig = {\n repository: 'repository',\n\n // the properties below are optional\n accessToken: secretValue,\n oauthToken: secretValue,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.SourceCodeProviderConfig", "kind": "interface", "locationInModule": { "filename": "lib/app.ts", "line": 26 }, "name": "SourceCodeProviderConfig", "properties": [ { "abstract": true, "docs": { "remarks": "For example, `https://github.com/aws/aws-cdk`.", "stability": "experimental", "summary": "The repository for the application. Must use the `HTTPS` protocol." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 32 }, "name": "repository", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- do not use a token", "remarks": "Token is not stored.\n\nEither `accessToken` or `oauthToken` must be specified if `repository`\nis sepcified.", "stability": "experimental", "summary": "Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 54 }, "name": "accessToken", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "default": "- do not use a token", "remarks": "OAuth token is not stored.\n\nEither `accessToken` or `oauthToken` must be specified if `repository`\nis specified.", "stability": "experimental", "summary": "OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key." }, "immutable": true, "locationInModule": { "filename": "lib/app.ts", "line": 43 }, "name": "oauthToken", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "symbolId": "lib/app:SourceCodeProviderConfig" }, "@aws-cdk/aws-amplify.SubDomain": { "assembly": "@aws-cdk/aws-amplify", "datatype": true, "docs": { "stability": "experimental", "summary": "Sub domain settings.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as amplify from '@aws-cdk/aws-amplify';\n\ndeclare const branch: amplify.Branch;\nconst subDomain: amplify.SubDomain = {\n branch: branch,\n\n // the properties below are optional\n prefix: 'prefix',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-amplify.SubDomain", "kind": "interface", "locationInModule": { "filename": "lib/domain.ts", "line": 182 }, "name": "SubDomain", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "The branch." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 186 }, "name": "branch", "type": { "fqn": "@aws-cdk/aws-amplify.IBranch" } }, { "abstract": true, "docs": { "default": "- the branch name", "remarks": "Use '' to map to the root of the domain", "stability": "experimental", "summary": "The prefix." }, "immutable": true, "locationInModule": { "filename": "lib/domain.ts", "line": 193 }, "name": "prefix", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/domain:SubDomain" } }, "version": "1.204.0", "fingerprint": "**********" }