{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-certificatemanager": "1.204.0", "@aws-cdk/aws-cloudwatch": "1.204.0", "@aws-cdk/aws-cognito": "1.204.0", "@aws-cdk/aws-ec2": "1.204.0", "@aws-cdk/aws-elasticloadbalancingv2": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-lambda": "1.204.0", "@aws-cdk/aws-logs": "1.204.0", "@aws-cdk/aws-s3": "1.204.0", "@aws-cdk/aws-s3-assets": "1.204.0", "@aws-cdk/aws-stepfunctions": "1.204.0", "@aws-cdk/core": "1.204.0", "@aws-cdk/cx-api": "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-acmpca": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ACMPCA", "packageId": "Amazon.CDK.AWS.ACMPCA" }, "java": { "maven": { "artifactId": "acmpca", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.acmpca" }, "js": { "npm": "@aws-cdk/aws-acmpca" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-acmpca", "module": "aws_cdk.aws_acmpca" } } }, "@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-certificatemanager": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CertificateManager", "packageId": "Amazon.CDK.AWS.CertificateManager" }, "java": { "maven": { "artifactId": "certificatemanager", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.certificatemanager" }, "js": { "npm": "@aws-cdk/aws-certificatemanager" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-certificatemanager", "module": "aws_cdk.aws_certificatemanager" } } }, "@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-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-cognito": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Cognito", "packageId": "Amazon.CDK.AWS.Cognito" }, "java": { "maven": { "artifactId": "cognito", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cognito" }, "js": { "npm": "@aws-cdk/aws-cognito" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cognito", "module": "aws_cdk.aws_cognito" } } }, "@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-elasticloadbalancingv2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2", "packageId": "Amazon.CDK.AWS.ElasticLoadBalancingV2" }, "java": { "maven": { "artifactId": "elasticloadbalancingv2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.elasticloadbalancingv2" }, "js": { "npm": "@aws-cdk/aws-elasticloadbalancingv2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-elasticloadbalancingv2", "module": "aws_cdk.aws_elasticloadbalancingv2" } } }, "@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-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-route53": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Route53", "packageId": "Amazon.CDK.AWS.Route53" }, "java": { "maven": { "artifactId": "route53", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.route53" }, "js": { "npm": "@aws-cdk/aws-route53" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-route53", "module": "aws_cdk.aws_route53" } } }, "@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-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/aws-stepfunctions": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.StepFunctions", "packageId": "Amazon.CDK.AWS.StepFunctions" }, "java": { "maven": { "artifactId": "stepfunctions", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.stepfunctions" }, "js": { "npm": "@aws-cdk/aws-stepfunctions" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-stepfunctions", "module": "aws_cdk.aws_stepfunctions" } } }, "@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::ApiGateway", "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": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "apigateway" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-apigateway", "readme": { "markdown": "# Amazon API Gateway 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\nAmazon API Gateway is a fully managed service that makes it easy for developers\nto publish, maintain, monitor, and secure APIs at any scale. Create an API to\naccess data, business logic, or functionality from your back-end services, such\nas applications running on Amazon Elastic Compute Cloud (Amazon EC2), code\nrunning on AWS Lambda, or any web application.\n\n## Table of Contents\n\n- [Defining APIs](#defining-apis)\n - [Breaking up Methods and Resources across Stacks](#breaking-up-methods-and-resources-across-stacks)\n- [AWS Lambda-backed APIs](#aws-lambda-backed-apis)\n- [AWS StepFunctions backed APIs](#aws-stepfunctions-backed-APIs)\n- [Integration Targets](#integration-targets)\n- [Usage Plan & API Keys](#usage-plan--api-keys)\n- [Working with models](#working-with-models)\n- [Default Integration and Method Options](#default-integration-and-method-options)\n- [Proxy Routes](#proxy-routes)\n- [Authorizers](#authorizers)\n - [IAM-based authorizer](#iam-based-authorizer)\n - [Lambda-based token authorizer](#lambda-based-token-authorizer)\n - [Lambda-based request authorizer](#lambda-based-request-authorizer)\n - [Cognito User Pools authorizer](#cognito-user-pools-authorizer)\n- [Mutual TLS](#mutal-tls-mtls)\n- [Deployments](#deployments)\n - [Deep dive: Invalidation of deployments](#deep-dive-invalidation-of-deployments)\n- [Custom Domains](#custom-domains)\n- [Access Logging](#access-logging)\n- [Cross Origin Resource Sharing (CORS)](#cross-origin-resource-sharing-cors)\n- [Endpoint Configuration](#endpoint-configuration)\n- [Private Integrations](#private-integrations)\n- [Gateway Response](#gateway-response)\n- [OpenAPI Definition](#openapi-definition)\n - [Endpoint configuration](#endpoint-configuration)\n- [Metrics](#metrics)\n- [APIGateway v2](#apigateway-v2)\n\n## Defining APIs\n\nAPIs are defined as a hierarchy of resources and methods. `addResource` and\n`addMethod` can be used to build this hierarchy. The root resource is\n`api.root`.\n\nFor example, the following code defines an API that includes the following HTTP\nendpoints: `ANY /`, `GET /books`, `POST /books`, `GET /books/{book_id}`, `DELETE /books/{book_id}`.\n\n```ts\nconst api = new apigateway.RestApi(this, 'books-api');\n\napi.root.addMethod('ANY');\n\nconst books = api.root.addResource('books');\nbooks.addMethod('GET');\nbooks.addMethod('POST');\n\nconst book = books.addResource('{book_id}');\nbook.addMethod('GET');\nbook.addMethod('DELETE');\n```\n\n## AWS Lambda-backed APIs\n\nA very common practice is to use Amazon API Gateway with AWS Lambda as the\nbackend integration. The `LambdaRestApi` construct makes it easy:\n\nThe following code defines a REST API that routes all requests to the\nspecified AWS Lambda function:\n\n```ts\ndeclare const backend: lambda.Function;\nnew apigateway.LambdaRestApi(this, 'myapi', {\n handler: backend,\n});\n```\n\nYou can also supply `proxy: false`, in which case you will have to explicitly\ndefine the API model:\n\n```ts\ndeclare const backend: lambda.Function;\nconst api = new apigateway.LambdaRestApi(this, 'myapi', {\n handler: backend,\n proxy: false\n});\n\nconst items = api.root.addResource('items');\nitems.addMethod('GET'); // GET /items\nitems.addMethod('POST'); // POST /items\n\nconst item = items.addResource('{item}');\nitem.addMethod('GET'); // GET /items/{item}\n\n// the default integration for methods is \"handler\", but one can\n// customize this behavior per method or even a sub path.\nitem.addMethod('DELETE', new apigateway.HttpIntegration('http://amazon.com'));\n```\n\n## AWS StepFunctions backed APIs\n\nYou can use Amazon API Gateway with AWS Step Functions as the backend integration, specifically Synchronous Express Workflows.\n\nThe `StepFunctionsRestApi` only supports integration with Synchronous Express state machine. The `StepFunctionsRestApi` construct makes this easy by setting up input, output and error mapping.\n\nThe construct sets up an API endpoint and maps the `ANY` HTTP method and any calls to the API endpoint starts an express workflow execution for the underlying state machine.\n\nInvoking the endpoint with any HTTP method (`GET`, `POST`, `PUT`, `DELETE`, ...) in the example below will send the request to the state machine as a new execution. On success, an HTTP code `200` is returned with the execution output as the Response Body.\n\nIf the execution fails, an HTTP `500` response is returned with the `error` and `cause` from the execution output as the Response Body. If the request is invalid (ex. bad execution input) HTTP code `400` is returned.\n\nThe response from the invocation contains only the `output` field from the\n[StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html#API_StartSyncExecution_ResponseSyntax) API.\nIn case of failures, the fields `error` and `cause` are returned as part of the response.\nOther metadata such as billing details, AWS account ID and resource ARNs are not returned in the API response.\n\nBy default, a `prod` stage is provisioned.\n\nIn order to reduce the payload size sent to AWS Step Functions, `headers` are not forwarded to the Step Functions execution input. It is possible to choose whether `headers`, `requestContext`, `path`, `querystring`, and `authorizer` are included or not. By default, `headers` are excluded in all requests.\n\nMore details about AWS Step Functions payload limit can be found at https://docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-task-executions.\n\nThe following code defines a REST API that routes all requests to the specified AWS StepFunctions state machine:\n\n```ts\nconst stateMachineDefinition = new stepfunctions.Pass(this, 'PassState');\n\nconst stateMachine: stepfunctions.IStateMachine = new stepfunctions.StateMachine(this, 'StateMachine', {\n definition: stateMachineDefinition,\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n});\n\nnew apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {\n deploy: true,\n stateMachine: stateMachine,\n});\n```\n\nWhen the REST API endpoint configuration above is invoked using POST, as follows -\n\n```bash\ncurl -X POST -d '{ \"customerId\": 1 }' https://example.com/\n```\n\nAWS Step Functions will receive the request body in its input as follows:\n\n```json\n{\n \"body\": {\n \"customerId\": 1\n },\n \"path\": \"/\",\n \"querystring\": {}\n}\n```\n\nWhen the endpoint is invoked at path '/users/5' using the HTTP GET method as below:\n\n```bash\ncurl -X GET https://example.com/users/5?foo=bar\n```\n\nAWS Step Functions will receive the following execution input:\n\n```json\n{\n \"body\": {},\n \"path\": {\n \"users\": \"5\"\n },\n \"querystring\": {\n \"foo\": \"bar\"\n }\n}\n```\n\nAdditional information around the request such as the request context, authorizer context, and headers can be included as part of the input\nforwarded to the state machine. The following example enables headers to be included in the input but not query string.\n\n```ts fixture=stepfunctions\nnew apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {\n stateMachine: machine,\n headers: true,\n path: false,\n querystring: false,\n authorizer: false,\n requestContext: {\n caller: true,\n user: true,\n },\n});\n```\n\nIn such a case, when the endpoint is invoked as below:\n\n```bash\ncurl -X GET https://example.com/\n```\n\nAWS Step Functions will receive the following execution input:\n\n```json\n{\n \"headers\": {\n \"Accept\": \"...\",\n \"CloudFront-Forwarded-Proto\": \"...\",\n },\n \"requestContext\": {\n \"accountId\": \"...\",\n \"apiKey\": \"...\",\n },\n \"body\": {}\n}\n```\n\n### Breaking up Methods and Resources across Stacks\n\nIt is fairly common for REST APIs with a large number of Resources and Methods to hit the [CloudFormation\nlimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) of 500 resources per\nstack.\n\nTo help with this, Resources and Methods for the same REST API can be re-organized across multiple stacks. A common\nway to do this is to have a stack per Resource or groups of Resources, but this is not the only possible way.\nThe following example uses sets up two Resources '/pets' and '/books' in separate stacks using nested stacks:\n\n```ts lit=test/integ.restapi-import.lit.ts\nimport { App, CfnOutput, NestedStack, NestedStackProps, Stack } from '@aws-cdk/core';\nimport { Construct } from 'constructs';\nimport { Deployment, Method, MockIntegration, PassthroughBehavior, RestApi, Stage } from '../lib';\n\n/**\n * This file showcases how to split up a RestApi's Resources and Methods across nested stacks.\n *\n * The root stack 'RootStack' first defines a RestApi.\n * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.\n * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.\n *\n * To verify this worked, go to the APIGateway\n */\n\nclass RootStack extends Stack {\n constructor(scope: Construct) {\n super(scope, 'integ-restapi-import-RootStack');\n\n const restApi = new RestApi(this, 'RestApi', {\n deploy: false,\n });\n restApi.root.addMethod('ANY');\n\n const petsStack = new PetsStack(this, {\n restApiId: restApi.restApiId,\n rootResourceId: restApi.restApiRootResourceId,\n });\n const booksStack = new BooksStack(this, {\n restApiId: restApi.restApiId,\n rootResourceId: restApi.restApiRootResourceId,\n });\n new DeployStack(this, {\n restApiId: restApi.restApiId,\n methods: petsStack.methods.concat(booksStack.methods),\n });\n\n new CfnOutput(this, 'PetsURL', {\n value: `https://${restApi.restApiId}.execute-api.${this.region}.amazonaws.com/prod/pets`,\n });\n\n new CfnOutput(this, 'BooksURL', {\n value: `https://${restApi.restApiId}.execute-api.${this.region}.amazonaws.com/prod/books`,\n });\n }\n}\n\ninterface ResourceNestedStackProps extends NestedStackProps {\n readonly restApiId: string;\n\n readonly rootResourceId: string;\n}\n\nclass PetsStack extends NestedStack {\n public readonly methods: Method[] = [];\n\n constructor(scope: Construct, props: ResourceNestedStackProps) {\n super(scope, 'integ-restapi-import-PetsStack', props);\n\n const api = RestApi.fromRestApiAttributes(this, 'RestApi', {\n restApiId: props.restApiId,\n rootResourceId: props.rootResourceId,\n });\n\n const method = api.root.addResource('pets').addMethod('GET', new MockIntegration({\n integrationResponses: [{\n statusCode: '200',\n }],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n }), {\n methodResponses: [{ statusCode: '200' }],\n });\n\n this.methods.push(method);\n }\n}\n\nclass BooksStack extends NestedStack {\n public readonly methods: Method[] = [];\n\n constructor(scope: Construct, props: ResourceNestedStackProps) {\n super(scope, 'integ-restapi-import-BooksStack', props);\n\n const api = RestApi.fromRestApiAttributes(this, 'RestApi', {\n restApiId: props.restApiId,\n rootResourceId: props.rootResourceId,\n });\n\n const method = api.root.addResource('books').addMethod('GET', new MockIntegration({\n integrationResponses: [{\n statusCode: '200',\n }],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n }), {\n methodResponses: [{ statusCode: '200' }],\n });\n\n this.methods.push(method);\n }\n}\n\ninterface DeployStackProps extends NestedStackProps {\n readonly restApiId: string;\n\n readonly methods?: Method[];\n}\n\nclass DeployStack extends NestedStack {\n constructor(scope: Construct, props: DeployStackProps) {\n super(scope, 'integ-restapi-import-DeployStack', props);\n\n const deployment = new Deployment(this, 'Deployment', {\n api: RestApi.fromRestApiId(this, 'RestApi', props.restApiId),\n });\n if (props.methods) {\n for (const method of props.methods) {\n deployment.node.addDependency(method);\n }\n }\n new Stage(this, 'Stage', { deployment });\n }\n}\n\nnew RootStack(new App());\n```\n\n## Integration Targets\n\nMethods are associated with backend integrations, which are invoked when this\nmethod is called. API Gateway supports the following integrations:\n\n- `MockIntegration` - can be used to test APIs. This is the default\n integration if one is not specified.\n- `LambdaIntegration` - can be used to invoke an AWS Lambda function.\n- `AwsIntegration` - can be used to invoke arbitrary AWS service APIs.\n- `HttpIntegration` - can be used to invoke HTTP endpoints.\n\nThe following example shows how to integrate the `GET /book/{book_id}` method to\nan AWS Lambda function:\n\n```ts\ndeclare const getBookHandler: lambda.Function;\ndeclare const book: apigateway.Resource;\n\nconst getBookIntegration = new apigateway.LambdaIntegration(getBookHandler);\nbook.addMethod('GET', getBookIntegration);\n```\n\nIntegration options can be optionally be specified:\n\n```ts\ndeclare const getBookHandler: lambda.Function;\ndeclare const getBookIntegration: apigateway.LambdaIntegration;\n\nconst getBookIntegration = new apigateway.LambdaIntegration(getBookHandler, {\n contentHandling: apigateway.ContentHandling.CONVERT_TO_TEXT, // convert to base64\n credentialsPassthrough: true, // use caller identity to invoke the function\n});\n```\n\nMethod options can optionally be specified when adding methods:\n\n```ts\ndeclare const book: apigateway.Resource;\ndeclare const getBookIntegration: apigateway.LambdaIntegration;\n\nbook.addMethod('GET', getBookIntegration, {\n authorizationType: apigateway.AuthorizationType.IAM,\n apiKeyRequired: true\n});\n```\n\nIt is possible to also integrate with AWS services in a different region. The following code integrates with Amazon SQS in the\n`eu-west-1` region.\n\n```ts\nconst getMessageIntegration = new apigateway.AwsIntegration({\n service: 'sqs',\n path: 'queueName',\n region: 'eu-west-1'\n});\n```\n\n## Usage Plan & API Keys\n\nA usage plan specifies who can access one or more deployed API stages and methods, and the rate at which they can be\naccessed. The plan uses API keys to identify API clients and meters access to the associated API stages for each key.\nUsage plans also allow configuring throttling limits and quota limits that are enforced on individual client API keys.\n\nThe following example shows how to create and asscociate a usage plan and an API key:\n\n```ts\ndeclare const integration: apigateway.LambdaIntegration;\n\nconst api = new apigateway.RestApi(this, 'hello-api');\n\nconst v1 = api.root.addResource('v1');\nconst echo = v1.addResource('echo');\nconst echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });\n\nconst plan = api.addUsagePlan('UsagePlan', {\n name: 'Easy',\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n});\n\nconst key = api.addApiKey('ApiKey');\nplan.addApiKey(key);\n```\n\nTo associate a plan to a given RestAPI stage:\n\n```ts\ndeclare const plan: apigateway.UsagePlan;\ndeclare const api: apigateway.RestApi;\ndeclare const echoMethod: apigateway.Method;\n\nplan.addApiStage({\n stage: api.deploymentStage,\n throttle: [\n {\n method: echoMethod,\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n }\n ]\n});\n```\n\nExisting usage plans can be imported into a CDK app using its id.\n\n```ts\nconst importedUsagePlan = apigateway.UsagePlan.fromUsagePlanId(this, 'imported-usage-plan', '');\n```\n\nThe name and value of the API Key can be specified at creation; if not\nprovided, a name and value will be automatically generated by API Gateway.\n\n```ts\ndeclare const api: apigateway.RestApi;\nconst key = api.addApiKey('ApiKey', {\n apiKeyName: 'myApiKey1',\n value: 'MyApiKeyThatIsAtLeast20Characters',\n});\n```\n\nExisting API keys can also be imported into a CDK app using its id.\n\n```ts\nconst importedKey = apigateway.ApiKey.fromApiKeyId(this, 'imported-key', '');\n```\n\nThe \"grant\" methods can be used to give prepackaged sets of permissions to other resources. The\nfollowing code provides read permission to an API key.\n\n```ts\ndeclare const importedKey: apigateway.ApiKey;\ndeclare const lambdaFn: lambda.Function;\nimportedKey.grantRead(lambdaFn);\n```\n\n### ⚠️ Multiple API Keys\n\nIt is possible to specify multiple API keys for a given Usage Plan, by calling `usagePlan.addApiKey()`.\n\nWhen using multiple API keys, a past bug of the CDK prevents API key associations to a Usage Plan to be deleted.\nIf the CDK app had the [feature flag] - `@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId` - enabled when the API\nkeys were created, then the app will not be affected by this bug.\n\nIf this is not the case, you will need to ensure that the CloudFormation [logical ids] of the API keys that are not\nbeing deleted remain unchanged.\nMake note of the logical ids of these API keys before removing any, and set it as part of the `addApiKey()` method:\n\n```ts\ndeclare const usageplan: apigateway.UsagePlan;\ndeclare const apiKey: apigateway.ApiKey;\n\nusageplan.addApiKey(apiKey, {\n overrideLogicalId: '...',\n});\n```\n\n[feature flag]: https://docs.aws.amazon.com/cdk/latest/guide/featureflags.html\n[logical ids]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html\n\n### Rate Limited API Key\n\nIn scenarios where you need to create a single api key and configure rate limiting for it, you can use `RateLimitedApiKey`.\nThis construct lets you specify rate limiting properties which should be applied only to the api key being created.\nThe API key created has the specified rate limits, such as quota and throttles, applied.\n\nThe following example shows how to use a rate limited api key :\n\n```ts\ndeclare const api: apigateway.RestApi;\n\nconst key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {\n customerId: 'hello-customer',\n resources: [api],\n quota: {\n limit: 10000,\n period: apigateway.Period.MONTH\n }\n});\n```\n\n## Working with models\n\nWhen you work with Lambda integrations that are not Proxy integrations, you\nhave to define your models and mappings for the request, response, and integration.\n\n```ts\nconst hello = new lambda.Function(this, 'hello', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'hello.handler',\n code: lambda.Code.fromAsset('lambda')\n});\n\nconst api = new apigateway.RestApi(this, 'hello-api', { });\nconst resource = api.root.addResource('v1');\n```\n\nYou can define more parameters on the integration to tune the behavior of API Gateway\n\n```ts\ndeclare const hello: lambda.Function;\n\nconst integration = new apigateway.LambdaIntegration(hello, {\n proxy: false,\n requestParameters: {\n // You can define mapping parameters from your method to your integration\n // - Destination parameters (the key) are the integration parameters (used in mappings)\n // - Source parameters (the value) are the source request parameters or expressions\n // @see: https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html\n 'integration.request.querystring.who': 'method.request.querystring.who'\n },\n allowTestInvoke: true,\n requestTemplates: {\n // You can define a mapping that will build a payload for your integration, based\n // on the integration parameters that you have specified\n // Check: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html\n 'application/json': JSON.stringify({ action: 'sayHello', pollId: \"$util.escapeJavaScript($input.params('who'))\" })\n },\n // This parameter defines the behavior of the engine is no suitable response template is found\n passthroughBehavior: apigateway.PassthroughBehavior.NEVER,\n integrationResponses: [\n {\n // Successful response from the Lambda function, no filter defined\n // - the selectionPattern filter only tests the error message\n // We will set the response status code to 200\n statusCode: \"200\",\n responseTemplates: {\n // This template takes the \"message\" result from the Lambda function, and embeds it in a JSON response\n // Check https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html\n 'application/json': JSON.stringify({ state: 'ok', greeting: '$util.escapeJavaScript($input.body)' })\n },\n responseParameters: {\n // We can map response parameters\n // - Destination parameters (the key) are the response parameters (used in mappings)\n // - Source parameters (the value) are the integration response parameters or expressions\n 'method.response.header.Content-Type': \"'application/json'\",\n 'method.response.header.Access-Control-Allow-Origin': \"'*'\",\n 'method.response.header.Access-Control-Allow-Credentials': \"'true'\"\n }\n },\n {\n // For errors, we check if the error message is not empty, get the error data\n selectionPattern: '(\\n|.)+',\n // We will set the response status code to 200\n statusCode: \"400\",\n responseTemplates: {\n 'application/json': JSON.stringify({ state: 'error', message: \"$util.escapeJavaScript($input.path('$.errorMessage'))\" })\n },\n responseParameters: {\n 'method.response.header.Content-Type': \"'application/json'\",\n 'method.response.header.Access-Control-Allow-Origin': \"'*'\",\n 'method.response.header.Access-Control-Allow-Credentials': \"'true'\"\n }\n }\n ]\n});\n\n```\n\nYou can define models for your responses (and requests)\n\n```ts\ndeclare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n```\n\nAnd reference all on your method definition.\n\n```ts\ndeclare const integration: apigateway.LambdaIntegration;\ndeclare const resource: apigateway.Resource;\ndeclare const responseModel: apigateway.Model;\ndeclare const errorResponseModel: apigateway.Model;\n\nresource.addMethod('GET', integration, {\n // We can mark the parameters as required\n requestParameters: {\n 'method.request.querystring.who': true\n },\n // we can set request validator options like below\n requestValidatorOptions: {\n requestValidatorName: 'test-validator',\n validateRequestBody: true,\n validateRequestParameters: false\n },\n methodResponses: [\n {\n // Successful response from the integration\n statusCode: '200',\n // Define what parameters are allowed or not\n responseParameters: {\n 'method.response.header.Content-Type': true,\n 'method.response.header.Access-Control-Allow-Origin': true,\n 'method.response.header.Access-Control-Allow-Credentials': true\n },\n // Validate the schema on the response\n responseModels: {\n 'application/json': responseModel\n }\n },\n {\n // Same thing for the error responses\n statusCode: '400',\n responseParameters: {\n 'method.response.header.Content-Type': true,\n 'method.response.header.Access-Control-Allow-Origin': true,\n 'method.response.header.Access-Control-Allow-Credentials': true\n },\n responseModels: {\n 'application/json': errorResponseModel\n }\n }\n ]\n});\n```\n\nSpecifying `requestValidatorOptions` automatically creates the RequestValidator construct with the given options.\nHowever, if you have your RequestValidator already initialized or imported, use the `requestValidator` option instead.\n\n## Default Integration and Method Options\n\nThe `defaultIntegration` and `defaultMethodOptions` properties can be used to\nconfigure a default integration at any resource level. These options will be\nused when defining method under this resource (recursively) with undefined\nintegration or options.\n\n> If not defined, the default integration is `MockIntegration`. See reference\ndocumentation for default method options.\n\nThe following example defines the `booksBackend` integration as a default\nintegration. This means that all API methods that do not explicitly define an\nintegration will be routed to this AWS Lambda function.\n\n```ts\ndeclare const booksBackend: apigateway.LambdaIntegration;\nconst api = new apigateway.RestApi(this, 'books', {\n defaultIntegration: booksBackend\n});\n\nconst books = api.root.addResource('books');\nbooks.addMethod('GET'); // integrated with `booksBackend`\nbooks.addMethod('POST'); // integrated with `booksBackend`\n\nconst book = books.addResource('{book_id}');\nbook.addMethod('GET'); // integrated with `booksBackend`\n```\n\nA Method can be configured with authorization scopes. Authorization scopes are\nused in conjunction with an [authorizer that uses Amazon Cognito user\npools](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool).\nRead more about authorization scopes\n[here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes).\n\nAuthorization scopes for a Method can be configured using the `authorizationScopes` property as shown below -\n\n```ts\ndeclare const books: apigateway.Resource;\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizationType: apigateway.AuthorizationType.COGNITO,\n authorizationScopes: ['Scope1','Scope2']\n});\n```\n\n## Proxy Routes\n\nThe `addProxy` method can be used to install a greedy `{proxy+}` resource\non a path. By default, this also installs an `\"ANY\"` method:\n\n```ts\ndeclare const resource: apigateway.Resource;\ndeclare const handler: lambda.Function;\nconst proxy = resource.addProxy({\n defaultIntegration: new apigateway.LambdaIntegration(handler),\n\n // \"false\" will require explicitly adding methods on the `proxy` resource\n anyMethod: true // \"true\" is the default\n});\n```\n\n## Authorizers\n\nAPI Gateway [supports several different authorization types](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.html)\nthat can be used for controlling access to your REST APIs.\n\n### IAM-based authorizer\n\nThe following CDK code provides 'execute-api' permission to an IAM user, via IAM policies, for the 'GET' method on the `books` resource:\n\n```ts\ndeclare const books: apigateway.Resource;\ndeclare const iamUser: iam.User;\n\nconst getBooks = books.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizationType: apigateway.AuthorizationType.IAM\n});\n\niamUser.attachInlinePolicy(new iam.Policy(this, 'AllowBooks', {\n statements: [\n new iam.PolicyStatement({\n actions: [ 'execute-api:Invoke' ],\n effect: iam.Effect.ALLOW,\n resources: [ getBooks.methodArn ]\n })\n ]\n}))\n```\n\n### Lambda-based token authorizer\n\nAPI Gateway also allows [lambda functions to be used as authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html).\n\nThis module provides support for token-based Lambda authorizers. When a client makes a request to an API's methods configured with such\nan authorizer, API Gateway calls the Lambda authorizer, which takes the caller's identity as input and returns an IAM policy as output.\nA token-based Lambda authorizer (also called a token authorizer) receives the caller's identity in a bearer token, such as\na JSON Web Token (JWT) or an OAuth token.\n\nAPI Gateway interacts with the authorizer Lambda function handler by passing input and expecting the output in a specific format.\nThe event object that the handler is called with contains the `authorizationToken` and the `methodArn` from the request to the\nAPI Gateway endpoint. The handler is expected to return the `principalId` (i.e. the client identifier) and a `policyDocument` stating\nwhat the client is authorizer to perform.\nSee [here](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) for a detailed specification on\ninputs and outputs of the Lambda handler.\n\nThe following code attaches a token-based Lambda authorizer to the 'GET' Method of the Book resource:\n\n```ts\ndeclare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.TokenAuthorizer(this, 'booksAuthorizer', {\n handler: authFn\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});\n```\n\nA full working example is shown below.\n\n!cdk-integ pragma:ignore-assets\n```ts lit=test/authorizers/integ.token-authorizer.lit.ts\nimport * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi, TokenAuthorizer } from '../../lib';\n\n/*\n * Stack verification steps:\n * * `curl -s -o /dev/null -w \"%{http_code}\" ` should return 401\n * * `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' ` should return 403\n * * `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' ` should return 200\n */\n\nconst app = new App();\nconst stack = new Stack(app, 'TokenAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.token-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new TokenAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});\n\n```\n\nBy default, the `TokenAuthorizer` looks for the authorization token in the request header with the key 'Authorization'. This can,\nhowever, be modified by changing the `identitySource` property.\n\nAuthorizers can also be passed via the `defaultMethodOptions` property within the `RestApi` construct or the `Method` construct. Unless\nexplicitly overridden, the specified defaults will be applied across all `Method`s across the `RestApi` or across all `Resource`s,\ndepending on where the defaults were specified.\n\n### Lambda-based request authorizer\n\nThis module provides support for request-based Lambda authorizers. When a client makes a request to an API's methods configured with such\nan authorizer, API Gateway calls the Lambda authorizer, which takes specified parts of the request, known as identity sources,\nas input and returns an IAM policy as output. A request-based Lambda authorizer (also called a request authorizer) receives\nthe identity sources in a series of values pulled from the request, from the headers, stage variables, query strings, and the context.\n\nAPI Gateway interacts with the authorizer Lambda function handler by passing input and expecting the output in a specific format.\nThe event object that the handler is called with contains the body of the request and the `methodArn` from the request to the\nAPI Gateway endpoint. The handler is expected to return the `principalId` (i.e. the client identifier) and a `policyDocument` stating\nwhat the client is authorizer to perform.\nSee [here](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html) for a detailed specification on\ninputs and outputs of the Lambda handler.\n\nThe following code attaches a request-based Lambda authorizer to the 'GET' Method of the Book resource:\n\n```ts\ndeclare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.RequestAuthorizer(this, 'booksAuthorizer', {\n handler: authFn,\n identitySources: [apigateway.IdentitySource.header('Authorization')]\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});\n```\n\nA full working example is shown below.\n\n!cdk-integ pragma:ignore-assets\n```ts lit=test/authorizers/integ.request-authorizer.lit.ts\nimport * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi } from '../../lib';\nimport { RequestAuthorizer } from '../../lib/authorizers';\nimport { IdentitySource } from '../../lib/authorizers/identity-source';\n\n// Against the RestApi endpoint from the stack output, run\n// `curl -s -o /dev/null -w \"%{http_code}\" ` should return 401\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' ?allow=yes` should return 403\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' ?allow=yes` should return 200\n\nconst app = new App();\nconst stack = new Stack(app, 'RequestAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new RequestAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});\n\n```\n\nBy default, the `RequestAuthorizer` does not pass any kind of information from the request. This can,\nhowever, be modified by changing the `identitySource` property, and is required when specifying a value for caching.\n\nAuthorizers can also be passed via the `defaultMethodOptions` property within the `RestApi` construct or the `Method` construct. Unless\nexplicitly overridden, the specified defaults will be applied across all `Method`s across the `RestApi` or across all `Resource`s,\ndepending on where the defaults were specified.\n\n### Cognito User Pools authorizer\n\nAPI Gateway also allows [Amazon Cognito user pools as authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html)\n\nThe following snippet configures a Cognito user pool as an authorizer:\n\n```ts\nconst userPool = new cognito.UserPool(this, 'UserPool');\n\nconst auth = new apigateway.CognitoUserPoolsAuthorizer(this, 'booksAuthorizer', {\n cognitoUserPools: [userPool]\n});\n\ndeclare const books: apigateway.Resource;\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth,\n authorizationType: apigateway.AuthorizationType.COGNITO,\n});\n```\n\n## Mutual TLS (mTLS)\n\nMutual TLS can be configured to limit access to your API based by using client certificates instead of (or as an extension of) using authorization headers.\n\n```ts\ndeclare const acm: any;\n\nnew apigateway.DomainName(this, 'domain-name', {\n domainName: 'example.com',\n certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),\n mtls: {\n bucket: new s3.Bucket(this, 'bucket'),\n key: 'truststore.pem',\n version: 'version',\n },\n});\n```\n\nInstructions for configuring your trust store can be found [here](https://aws.amazon.com/blogs/compute/introducing-mutual-tls-authentication-for-amazon-api-gateway/).\n\n## Deployments\n\nBy default, the `RestApi` construct will automatically create an API Gateway\n[Deployment] and a \"prod\" [Stage] which represent the API configuration you\ndefined in your CDK app. This means that when you deploy your app, your API will\nbe have open access from the internet via the stage URL.\n\nThe URL of your API can be obtained from the attribute `restApi.url`, and is\nalso exported as an `Output` from your stack, so it's printed when you `cdk\ndeploy` your app:\n\n```console\n$ cdk deploy\n...\nbooks.booksapiEndpointE230E8D5 = https://6lyktd4lpk.execute-api.us-east-1.amazonaws.com/prod/\n```\n\nTo disable this behavior, you can set `{ deploy: false }` when creating your\nAPI. This means that the API will not be deployed and a stage will not be\ncreated for it. You will need to manually define a `apigateway.Deployment` and\n`apigateway.Stage` resources.\n\nUse the `deployOptions` property to customize the deployment options of your\nAPI.\n\nThe following example will configure API Gateway to emit logs and data traces to\nAWS CloudWatch for all API calls:\n\n> By default, an IAM role will be created and associated with API Gateway to\nallow it to write logs and metrics to AWS CloudWatch unless `cloudWatchRole` is\nset to `false`.\n\n```ts\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n loggingLevel: apigateway.MethodLoggingLevel.INFO,\n dataTraceEnabled: true\n }\n})\n```\n\n### Deep dive: Invalidation of deployments\n\nAPI Gateway deployments are an immutable snapshot of the API. This means that we\nwant to automatically create a new deployment resource every time the API model\ndefined in our CDK app changes.\n\nIn order to achieve that, the AWS CloudFormation logical ID of the\n`AWS::ApiGateway::Deployment` resource is dynamically calculated by hashing the\nAPI configuration (resources, methods). This means that when the configuration\nchanges (i.e. a resource or method are added, configuration is changed), a new\nlogical ID will be assigned to the deployment resource. This will cause\nCloudFormation to create a new deployment resource.\n\nBy default, old deployments are _deleted_. You can set `retainDeployments: true`\nto allow users revert the stage to an old deployment manually.\n\n[Deployment]: https://docs.aws.amazon.com/apigateway/api-reference/resource/deployment/\n[Stage]: https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/\n\n## Custom Domains\n\nTo associate an API with a custom domain, use the `domainName` configuration when\nyou define your API:\n\n```ts\ndeclare const acmCertificateForExampleCom: any;\n\nconst api = new apigateway.RestApi(this, 'MyDomain', {\n domainName: {\n domainName: 'example.com',\n certificate: acmCertificateForExampleCom,\n },\n});\n```\n\nThis will define a `DomainName` resource for you, along with a `BasePathMapping`\nfrom the root of the domain to the deployment stage of the API. This is a common\nset up.\n\nTo route domain traffic to an API Gateway API, use Amazon Route 53 to create an\nalias record. An alias record is a Route 53 extension to DNS. It's similar to a\nCNAME record, but you can create an alias record both for the root domain, such\nas `example.com`, and for subdomains, such as `www.example.com`. (You can create\nCNAME records only for subdomains.)\n\n```ts\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as targets from '@aws-cdk/aws-route53-targets';\n\ndeclare const api: apigateway.RestApi;\ndeclare const hostedZoneForExampleCom: any;\n\nnew route53.ARecord(this, 'CustomDomainAliasRecord', {\n zone: hostedZoneForExampleCom,\n target: route53.RecordTarget.fromAlias(new targets.ApiGateway(api))\n});\n```\n\nYou can also define a `DomainName` resource directly in order to customize the default behavior:\n\n```ts\ndeclare const acmCertificateForExampleCom: any;\n\nnew apigateway.DomainName(this, 'custom-domain', {\n domainName: 'example.com',\n certificate: acmCertificateForExampleCom,\n endpointType: apigateway.EndpointType.EDGE, // default is REGIONAL\n securityPolicy: apigateway.SecurityPolicy.TLS_1_2\n});\n```\n\nOnce you have a domain, you can map base paths of the domain to APIs.\nThe following example will map the URL \nto the `api1` API and to the `api2` API.\n\n```ts\ndeclare const domain: apigateway.DomainName;\ndeclare const api1: apigateway.RestApi;\ndeclare const api2: apigateway.RestApi;\n\ndomain.addBasePathMapping(api1, { basePath: 'go-to-api1' });\ndomain.addBasePathMapping(api2, { basePath: 'boom' });\n```\n\nYou can specify the API `Stage` to which this base path URL will map to. By default, this will be the\n`deploymentStage` of the `RestApi`.\n\n```ts\ndeclare const domain: apigateway.DomainName;\ndeclare const restapi: apigateway.RestApi;\n\nconst betaDeploy = new apigateway.Deployment(this, 'beta-deployment', {\n api: restapi,\n});\nconst betaStage = new apigateway.Stage(this, 'beta-stage', {\n deployment: betaDeploy,\n});\ndomain.addBasePathMapping(restapi, { basePath: 'api/beta', stage: betaStage });\n```\n\nIf you don't specify `basePath`, all URLs under this domain will be mapped\nto the API, and you won't be able to map another API to the same domain:\n\n```ts\ndeclare const domain: apigateway.DomainName;\ndeclare const api: apigateway.RestApi;\ndomain.addBasePathMapping(api);\n```\n\nThis can also be achieved through the `mapping` configuration when defining the\ndomain as demonstrated above.\n\nIf you wish to setup this domain with an Amazon Route53 alias, use the `targets.ApiGatewayDomain`:\n\n```ts\ndeclare const hostedZoneForExampleCom: any;\ndeclare const domainName: apigateway.DomainName;\n\nimport * as route53 from '@aws-cdk/aws-route53';\nimport * as targets from '@aws-cdk/aws-route53-targets';\n\nnew route53.ARecord(this, 'CustomDomainAliasRecord', {\n zone: hostedZoneForExampleCom,\n target: route53.RecordTarget.fromAlias(new targets.ApiGatewayDomain(domainName))\n});\n```\n\n## Access Logging\n\nAccess logging creates logs every time an API method is accessed. Access logs can have information on\nwho has accessed the API, how the caller accessed the API and what responses were generated.\nAccess logs are configured on a Stage of the RestApi.\nAccess logs can be expressed in a format of your choosing, and can contain any access details, with a\nminimum that it must include the 'requestId'. The list of variables that can be expressed in the access\nlog can be found\n[here](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference).\nRead more at [Setting Up CloudWatch API Logging in API\nGateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html)\n\n```ts\n// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});\n```\n\nThe following code will generate the access log in the [CLF format](https://en.wikipedia.org/wiki/Common_Log_Format).\n\n```ts\nconst logGroup = new logs.LogGroup(this, \"ApiGatewayAccessLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),\n accessLogFormat: apigateway.AccessLogFormat.clf(),\n }});\n```\n\nYou can also configure your own access log format by using the `AccessLogFormat.custom()` API.\n`AccessLogField` provides commonly used fields. The following code configures access log to contain.\n\n```ts\nconst logGroup = new logs.LogGroup(this, \"ApiGatewayAccessLogs\");\nnew apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),\n accessLogFormat: apigateway.AccessLogFormat.custom(\n `${apigateway.AccessLogField.contextRequestId()} ${apigateway.AccessLogField.contextErrorMessage()} ${apigateway.AccessLogField.contextErrorMessageString()}`\n )\n }\n});\n```\n\nYou can use the `methodOptions` property to configure\n[default method throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html#apigateway-api-level-throttling-in-usage-plan)\nfor a stage. The following snippet configures the a stage that accepts\n100 requests per minute, allowing burst up to 200 requests per minute.\n\n```ts\nconst api = new apigateway.RestApi(this, 'books');\nconst deployment = new apigateway.Deployment(this, 'my-deployment', { api });\nconst stage = new apigateway.Stage(this, 'my-stage', {\n deployment,\n methodOptions: {\n '/*/*': { // This special path applies to all resource paths and all HTTP methods\n throttlingRateLimit: 100,\n throttlingBurstLimit: 200\n }\n }\n});\n```\n\nConfiguring `methodOptions` on the `deployOptions` of `RestApi` will set the\nthrottling behaviors on the default stage that is automatically created.\n\n```ts\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n methodOptions: {\n '/*/*': { // This special path applies to all resource paths and all HTTP methods\n throttlingRateLimit: 100,\n throttlingBurstLimit: 1000\n }\n }\n }\n});\n```\n\n## Cross Origin Resource Sharing (CORS)\n\n[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is a mechanism\nthat uses additional HTTP headers to tell browsers to give a web application\nrunning at one origin, access to selected resources from a different origin. A\nweb application executes a cross-origin HTTP request when it requests a resource\nthat has a different origin (domain, protocol, or port) from its own.\n\nYou can add the CORS [preflight](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Preflighted_requests) OPTIONS\nHTTP method to any API resource via the `defaultCorsPreflightOptions` option or by calling the `addCorsPreflight` on a specific resource.\n\nThe following example will enable CORS for all methods and all origins on all resources of the API:\n\n```ts\nnew apigateway.RestApi(this, 'api', {\n defaultCorsPreflightOptions: {\n allowOrigins: apigateway.Cors.ALL_ORIGINS,\n allowMethods: apigateway.Cors.ALL_METHODS // this is also the default\n }\n})\n```\n\nThe following example will add an OPTIONS method to the `myResource` API resource, which\nonly allows GET and PUT HTTP requests from the origin \n\n```ts\ndeclare const myResource: apigateway.Resource;\n\nmyResource.addCorsPreflight({\n allowOrigins: [ 'https://amazon.com' ],\n allowMethods: [ 'GET', 'PUT' ]\n});\n```\n\nSee the\n[`CorsOptions`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.CorsOptions.html)\nAPI reference for a detailed list of supported configuration options.\n\nYou can specify defaults this at the resource level, in which case they will be applied to the entire resource sub-tree:\n\n```ts\ndeclare const resource: apigateway.Resource;\n\nconst subtree = resource.addResource('subtree', {\n defaultCorsPreflightOptions: {\n allowOrigins: [ 'https://amazon.com' ]\n }\n});\n```\n\nThis means that all resources under `subtree` (inclusive) will have a preflight\nOPTIONS added to them.\n\nSee [#906](https://github.com/aws/aws-cdk/issues/906) for a list of CORS\nfeatures which are not yet supported.\n\n## Endpoint Configuration\n\nAPI gateway allows you to specify an\n[API Endpoint Type](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html).\nTo define an endpoint type for the API gateway, use `endpointConfiguration` property:\n\n```ts\nconst api = new apigateway.RestApi(this, 'api', {\n endpointConfiguration: {\n types: [ apigateway.EndpointType.EDGE ]\n }\n});\n```\n\nYou can also create an association between your Rest API and a VPC endpoint. By doing so,\nAPI Gateway will generate a new\nRoute53 Alias DNS record which you can use to invoke your private APIs. More info can be found\n[here](https://docs.aws.amazon.com/apigateway/latest/developerguide/associate-private-api-with-vpc-endpoint.html).\n\nHere is an example:\n\n```ts\ndeclare const someEndpoint: ec2.IVpcEndpoint;\n\nconst api = new apigateway.RestApi(this, 'api', {\n endpointConfiguration: {\n types: [ apigateway.EndpointType.PRIVATE ],\n vpcEndpoints: [ someEndpoint ]\n }\n});\n```\n\nBy performing this association, we can invoke the API gateway using the following format:\n\n```plaintext\nhttps://{rest-api-id}-{vpce-id}.execute-api.{region}.amazonaws.com/{stage}\n```\n\n## Private Integrations\n\nA private integration makes it simple to expose HTTP/HTTPS resources behind an\nAmazon VPC for access by clients outside of the VPC. The private integration uses\nan API Gateway resource of `VpcLink` to encapsulate connections between API\nGateway and targeted VPC resources.\nThe `VpcLink` is then attached to the `Integration` of a specific API Gateway\nMethod. The following code sets up a private integration with a network load\nbalancer -\n\n```ts\nimport * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});\n```\n\nThe uri for the private integration, in the case of a VpcLink, will be set to the DNS name of\nthe VPC Link's NLB. If the VPC Link has multiple NLBs or the VPC Link is imported or the DNS\nname cannot be determined for any other reason, the user is expected to specify the `uri`\nproperty.\n\nAny existing `VpcLink` resource can be imported into the CDK app via the `VpcLink.fromVpcLinkId()`.\n\n```ts\nconst awesomeLink = apigateway.VpcLink.fromVpcLinkId(this, 'awesome-vpc-link', 'us-east-1_oiuR12Abd');\n```\n\n## Gateway response\n\nIf the Rest API fails to process an incoming request, it returns to the client an error response without forwarding the\nrequest to the integration backend. API Gateway has a set of standard response messages that are sent to the client for\neach type of error. These error responses can be configured on the Rest API. The list of Gateway responses that can be\nconfigured can be found [here](https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html).\nLearn more about [Gateway\nResponses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-gatewayResponse-definition.html).\n\nThe following code configures a Gateway Response when the response is 'access denied':\n\n```ts\nconst api = new apigateway.RestApi(this, 'books-api');\napi.addGatewayResponse('test-response', {\n type: apigateway.ResponseType.ACCESS_DENIED,\n statusCode: '500',\n responseHeaders: {\n 'Access-Control-Allow-Origin': \"test.com\",\n 'test-key': 'test-value'\n },\n templates: {\n 'application/json': '{ \"message\": $context.error.messageString, \"statusCode\": \"488\", \"type\": \"$context.error.responseType\" }'\n }\n});\n```\n\n## OpenAPI Definition\n\nCDK supports creating a REST API by importing an OpenAPI definition file. It currently supports OpenAPI v2.0 and OpenAPI\nv3.0 definition files. Read more about [Configuring a REST API using\nOpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html).\n\nThe following code creates a REST API using an external OpenAPI definition JSON file -\n\n```ts\ndeclare const integration: apigateway.Integration;\n\nconst api = new apigateway.SpecRestApi(this, 'books-api', {\n apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')\n});\n\nconst booksResource = api.root.addResource('books')\nbooksResource.addMethod('GET', integration);\n```\n\nIt is possible to use the `addResource()` API to define additional API Gateway Resources.\n\n**Note:** Deployment will fail if a Resource of the same name is already defined in the Open API specification.\n\n**Note:** Any default properties configured, such as `defaultIntegration`, `defaultMethodOptions`, etc. will only be\napplied to Resources and Methods defined in the CDK, and not the ones defined in the spec. Use the [API Gateway\nextensions to OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html)\nto configure these.\n\nThere are a number of limitations in using OpenAPI definitions in API Gateway. Read the [Amazon API Gateway important\nnotes for REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html#api-gateway-known-issues-rest-apis)\nfor more details.\n\n**Note:** When starting off with an OpenAPI definition using `SpecRestApi`, it is not possible to configure some\nproperties that can be configured directly in the OpenAPI specification file. This is to prevent people duplication\nof these properties and potential confusion.\n\n### Endpoint configuration\n\nBy default, `SpecRestApi` will create an edge optimized endpoint.\n\nThis can be modified as shown below:\n\n```ts\ndeclare const apiDefinition: apigateway.ApiDefinition;\n\nconst api = new apigateway.SpecRestApi(this, 'ExampleRestApi', {\n apiDefinition,\n endpointTypes: [apigateway.EndpointType.PRIVATE]\n});\n```\n\n**Note:** For private endpoints you will still need to provide the\n[`x-amazon-apigateway-policy`](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.html) and\n[`x-amazon-apigateway-endpoint-configuration`](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)\nin your openApi file.\n\n## Metrics\n\nThe API Gateway service sends metrics around the performance of Rest APIs to Amazon CloudWatch.\nThese metrics can be referred to using the metric APIs available on the `RestApi` construct.\nThe APIs with the `metric` prefix can be used to get reference to specific metrics for this API. For example,\nthe method below refers to the client side errors metric for this API.\n\n```ts\nconst api = new apigateway.RestApi(this, 'my-api');\nconst clientErrorMetric = api.metricClientError();\n```\n\n## APIGateway v2\n\nAPIGateway v2 APIs are now moved to its own package named `aws-apigatewayv2`. For backwards compatibility, existing\nAPIGateway v2 \"CFN resources\" (such as `CfnApi`) that were previously exported as part of this package, are still\nexported from here and have been marked deprecated. However, updates to these CloudFormation resources, such as new\nproperties and new resource types will not be available.\n\nMove to using `aws-apigatewayv2` to get the latest APIs and updates.\n\n----\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n" }, "repository": { "directory": "packages/@aws-cdk/aws-apigateway", "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.APIGateway", "packageId": "Amazon.CDK.AWS.APIGateway" }, "java": { "maven": { "artifactId": "apigateway", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.apigateway" }, "js": { "npm": "@aws-cdk/aws-apigateway" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-apigateway", "module": "aws_cdk.aws_apigateway" } }, "types": { "@aws-cdk/aws-apigateway.AccessLogDestinationConfig": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Options when binding a log destination to a RestApi Stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst accessLogDestinationConfig: apigateway.AccessLogDestinationConfig = {\n destinationArn: 'destinationArn',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.AccessLogDestinationConfig", "kind": "interface", "locationInModule": { "filename": "lib/access-log.ts", "line": 17 }, "name": "AccessLogDestinationConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the destination resource." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 21 }, "name": "destinationArn", "type": { "primitive": "string" } } ], "symbolId": "lib/access-log:AccessLogDestinationConfig" }, "@aws-cdk/aws-apigateway.AccessLogField": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "$context variables that can be used to customize access log pattern.", "example": " apigateway.AccessLogFormat.custom(JSON.stringify({\n requestId: apigateway.AccessLogField.contextRequestId(),\n sourceIp: apigateway.AccessLogField.contextIdentitySourceIp(),\n method: apigateway.AccessLogField.contextHttpMethod(),\n userContext: {\n sub: apigateway.AccessLogField.contextAuthorizerClaims('sub'),\n email: apigateway.AccessLogField.contextAuthorizerClaims('email')\n }\n }))", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AccessLogField", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/access-log.ts", "line": 44 }, "methods": [ { "docs": { "stability": "stable", "summary": "The API owner's AWS account ID." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 48 }, "name": "contextAccountId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The identifier API Gateway assigns to your API." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 55 }, "name": "contextApiId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html", "stability": "stable", "summary": "The stringified value of the specified key-value pair of the `context` map returned from an API Gateway Lambda authorizer function." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 83 }, "name": "contextAuthorizer", "parameters": [ { "docs": { "summary": "key of the context map." }, "name": "property", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html", "stability": "stable", "summary": "A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 65 }, "name": "contextAuthorizerClaims", "parameters": [ { "docs": { "summary": "A property key of the claims." }, "name": "property", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The authorizer latency in ms." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 398 }, "name": "contextAuthorizerIntegrationLatency", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html", "stability": "stable", "summary": "The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer (formerly known as a custom authorizer)." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 74 }, "name": "contextAuthorizerPrincipalId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The AWS endpoint's request ID." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 90 }, "name": "contextAwsEndpointRequestId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "This should be the same as the incoming `Host` header.", "stability": "stable", "summary": "The full domain name used to invoke the API." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 97 }, "name": "contextDomainName", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The first label of the `$context.domainName`. This is often used as a caller/customer identifier." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 104 }, "name": "contextDomainPrefix", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A string containing an API Gateway error message." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 111 }, "name": "contextErrorMessage", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The quoted value of $context.error.message, namely \"$context.error.message\"." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 118 }, "name": "contextErrorMessageString", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "This variable can only be used for simple variable substitution in a GatewayResponse body-mapping template,\nwhich is not processed by the Velocity Template Language engine, and in access logging.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html", "stability": "stable", "summary": "A type of GatewayResponse." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 129 }, "name": "contextErrorResponseType", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A string containing a detailed validation error message." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 136 }, "name": "contextErrorValidationErrorString", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 143 }, "name": "contextExtendedRequestId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Valid values include: `DELETE`, `GET`, `HEAD`, `OPTIONS`, `PATCH`, `POST`, and `PUT`.", "stability": "stable", "summary": "The HTTP method used." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 150 }, "name": "contextHttpMethod", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The AWS account ID associated with the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 157 }, "name": "contextIdentityAccountId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "For methods that don't require an API key, this variable is", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html", "stability": "stable", "summary": "For API methods that require an API key, this variable is the API key associated with the method request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 166 }, "name": "contextIdentityApiKey", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The API key ID associated with an API request that requires an API key." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 173 }, "name": "contextIdentityApiKeyId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The principal identifier of the caller making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 180 }, "name": "contextIdentityCaller", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Available only if the request was signed with Amazon Cognito credentials.", "see": "https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html", "stability": "stable", "summary": "The Amazon Cognito authentication provider used by the caller making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 189 }, "name": "contextIdentityCognitoAuthenticationProvider", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Available only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "The Amazon Cognito authentication type of the caller making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 197 }, "name": "contextIdentityCognitoAuthenticationType", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Available only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "The Amazon Cognito identity ID of the caller making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 204 }, "name": "contextIdentityCognitoIdentityId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Available only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "The Amazon Cognito identity pool ID of the caller making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 212 }, "name": "contextIdentityCognitoIdentityPoolId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The AWS organization ID." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 219 }, "name": "contextIdentityPrincipalOrgId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Warning: You should not trust this value if there is any chance that the `X-Forwarded-For` header could be forged.", "stability": "stable", "summary": "The source IP address of the TCP connection making the request to API Gateway." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 227 }, "name": "contextIdentitySourceIp", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Used in Lambda authorizers.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html", "stability": "stable", "summary": "The principal identifier of the user making the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 235 }, "name": "contextIdentityUser", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The User-Agent header of the API caller." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 242 }, "name": "contextIdentityUserAgent", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "see": "https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html", "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the effective user identified after authentication." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 250 }, "name": "contextIdentityUserArn", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The integration latency in ms." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 405 }, "name": "contextIntegrationLatency", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 413 }, "name": "contextIntegrationStatus", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "For example, for a non-proxy request URL of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child,\nthis value is /{stage}/root/child.", "stability": "stable", "summary": "The request path." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 259 }, "name": "contextPath", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The request protocol, for example, HTTP/1.1." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 266 }, "name": "contextProtocol", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The ID that API Gateway assigns to the API request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 273 }, "name": "contextRequestId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html", "stability": "stable", "summary": "The request header override." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 284 }, "name": "contextRequestOverrideHeader", "parameters": [ { "name": "headerName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "If this parameter is defined,\nit contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html", "stability": "stable", "summary": "The request path override." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 295 }, "name": "contextRequestOverridePath", "parameters": [ { "name": "pathName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "If this parameter is defined, it contains the request query strings to be used instead\nof the URL Query String Parameters that are defined in the Integration Request pane.", "stability": "stable", "summary": "The request query string override." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 306 }, "name": "contextRequestOverrideQuerystring", "parameters": [ { "name": "querystringName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm)." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 335 }, "name": "contextRequestTime", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The Epoch-formatted request time." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 342 }, "name": "contextRequestTimeEpoch", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The identifier that API Gateway assigns to your resource." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 349 }, "name": "contextResourceId", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "For example, for the non-proxy request URI of `https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child`,\nThe $context.resourcePath value is `/root/child`.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.html", "stability": "stable", "summary": "The path to your resource." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 359 }, "name": "contextResourcePath", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The response latency in ms." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 420 }, "name": "contextResponseLatency", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The response payload length." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 427 }, "name": "contextResponseLength", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "If this parameter is defined, it contains the header to be returned instead of the Response header\nthat is defined as the Default mapping in the Integration Response pane.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html", "stability": "stable", "summary": "The response header override." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 318 }, "name": "contextResponseOverrideHeader", "parameters": [ { "name": "headerName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "If this parameter is defined, it contains the status code to be returned instead of the Method response status\nthat is defined as the Default mapping in the Integration Response pane.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html", "stability": "stable", "summary": "The response status code override." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 328 }, "name": "contextResponseOverrideStatus", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The deployment stage of the API request (for example, `Beta` or `Prod`)." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 366 }, "name": "contextStage", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "The method response status." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 434 }, "name": "contextStatus", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Will not be set if the stage is not associated with a web ACL.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html", "stability": "stable", "summary": "The response received from AWS WAF: `WAF_ALLOW` or `WAF_BLOCK`." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 374 }, "name": "contextWafResponseCode", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Will not be set if the stage is not associated with a web ACL.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html", "stability": "stable", "summary": "The complete ARN of the web ACL that is used to decide whether to allow or block the request." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 383 }, "name": "contextWebaclArn", "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html", "stability": "stable", "summary": "The trace ID for the X-Ray trace." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 391 }, "name": "contextXrayTraceId", "returns": { "type": { "primitive": "string" } }, "static": true } ], "name": "AccessLogField", "symbolId": "lib/access-log:AccessLogField" }, "@aws-cdk/aws-apigateway.AccessLogFormat": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "factory methods for access log format.", "example": "const logGroup = new logs.LogGroup(this, \"ApiGatewayAccessLogs\");\nnew apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),\n accessLogFormat: apigateway.AccessLogFormat.custom(\n `${apigateway.AccessLogField.contextRequestId()} ${apigateway.AccessLogField.contextErrorMessage()} ${apigateway.AccessLogField.contextErrorMessageString()}`\n )\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AccessLogFormat", "kind": "class", "locationInModule": { "filename": "lib/access-log.ts", "line": 484 }, "methods": [ { "docs": { "stability": "stable", "summary": "Generate Common Log Format." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 508 }, "name": "clf", "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogFormat" } }, "static": true }, { "docs": { "example": " apigateway.AccessLogFormat.custom(JSON.stringify({\n requestId: apigateway.AccessLogField.contextRequestId(),\n sourceIp: apigateway.AccessLogField.contextIdentitySourceIp(),\n method: apigateway.AccessLogField.contextHttpMethod(),\n userContext: {\n sub: apigateway.AccessLogField.contextAuthorizerClaims('sub'),\n email: apigateway.AccessLogField.contextAuthorizerClaims('email')\n }\n }))", "remarks": "You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.", "stability": "stable", "summary": "Custom log format." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 501 }, "name": "custom", "parameters": [ { "name": "format", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogFormat" } }, "static": true }, { "docs": { "remarks": "All fields are turned on by default with the\noption to turn off specific fields.", "stability": "stable", "summary": "Access log will be produced in the JSON format with a set of fields most useful in the access log." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 521 }, "name": "jsonWithStandardFields", "parameters": [ { "name": "fields", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.JsonWithStandardFieldProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogFormat" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Output a format string to be used with CloudFormation." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 559 }, "name": "toString", "returns": { "type": { "primitive": "string" } } } ], "name": "AccessLogFormat", "symbolId": "lib/access-log:AccessLogFormat" }, "@aws-cdk/aws-apigateway.AddApiKeyOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Options to the UsagePlan.addApiKey() method.", "example": "declare const usageplan: apigateway.UsagePlan;\ndeclare const apiKey: apigateway.ApiKey;\n\nusageplan.addApiKey(apiKey, {\n overrideLogicalId: '...',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AddApiKeyOptions", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 151 }, "name": "AddApiKeyOptions", "properties": [ { "abstract": true, "docs": { "default": "- autogenerated by the CDK", "stability": "stable", "summary": "Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 156 }, "name": "overrideLogicalId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/usage-plan:AddApiKeyOptions" }, "@aws-cdk/aws-apigateway.ApiDefinition": { "abstract": true, "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Represents an OpenAPI definition asset.", "example": "declare const integration: apigateway.Integration;\n\nconst api = new apigateway.SpecRestApi(this, 'books-api', {\n apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')\n});\n\nconst booksResource = api.root.addResource('books')\nbooksResource.addMethod('GET', integration);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ApiDefinition", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/api-definition.ts", "line": 15 }, "methods": [ { "docs": { "stability": "stable", "summary": "Loads the API specification from a local disk asset." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 77 }, "name": "fromAsset", "parameters": [ { "name": "file", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AssetApiDefinition" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates an API definition from a specification file in an S3 bucket." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 19 }, "name": "fromBucket", "parameters": [ { "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "name": "key", "type": { "primitive": "string" } }, { "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.S3ApiDefinition" } }, "static": true }, { "docs": { "example": " apigateway.ApiDefinition.fromInline({\n openapi: '3.0.2',\n paths: {\n '/pets': {\n get: {\n 'responses': {\n 200: {\n content: {\n 'application/json': {\n schema: {\n $ref: '#/components/schemas/Empty',\n },\n },\n },\n },\n },\n 'x-amazon-apigateway-integration': {\n responses: {\n default: {\n statusCode: '200',\n },\n },\n requestTemplates: {\n 'application/json': '{\"statusCode\": 200}',\n },\n passthroughBehavior: 'when_no_match',\n type: 'mock',\n },\n },\n },\n },\n components: {\n schemas: {\n Empty: {\n title: 'Empty Schema',\n type: 'object',\n },\n },\n },\n });", "remarks": "The inline object must follow the\nschema of OpenAPI 2.0 or OpenAPI 3.0", "stability": "stable", "summary": "Create an API definition from an inline object." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 70 }, "name": "fromInline", "parameters": [ { "name": "definition", "type": { "primitive": "any" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.InlineApiDefinition" } }, "static": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 88 }, "name": "bind", "parameters": [ { "docs": { "remarks": "Don't be smart about trying to down-cast or\nassume it's initialized. You may just use it as a construct scope.", "summary": "The binding scope." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionConfig" } } }, { "docs": { "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.", "stability": "stable", "summary": "Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 95 }, "name": "bindAfterCreate", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "_restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ] } ], "name": "ApiDefinition", "symbolId": "lib/api-definition:ApiDefinition" }, "@aws-cdk/aws-apigateway.ApiDefinitionConfig": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Post-Binding Configuration for a CDK construct.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const inlineDefinition: any;\nconst apiDefinitionConfig: apigateway.ApiDefinitionConfig = {\n inlineDefinition: inlineDefinition,\n s3Location: {\n bucket: 'bucket',\n key: 'key',\n\n // the properties below are optional\n version: 'version',\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionConfig", "kind": "interface", "locationInModule": { "filename": "lib/api-definition.ts", "line": 118 }, "name": "ApiDefinitionConfig", "properties": [ { "abstract": true, "docs": { "default": "- API definition is not defined inline", "stability": "stable", "summary": "Inline specification (mutually exclusive with `s3Location`)." }, "immutable": true, "locationInModule": { "filename": "lib/api-definition.ts", "line": 131 }, "name": "inlineDefinition", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "default": "- API definition is not an S3 location", "stability": "stable", "summary": "The location of the specification in S3 (mutually exclusive with `inlineDefinition`)." }, "immutable": true, "locationInModule": { "filename": "lib/api-definition.ts", "line": 124 }, "name": "s3Location", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionS3Location" } } ], "symbolId": "lib/api-definition:ApiDefinitionConfig" }, "@aws-cdk/aws-apigateway.ApiDefinitionS3Location": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "S3 location of the API definition file.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst apiDefinitionS3Location: apigateway.ApiDefinitionS3Location = {\n bucket: 'bucket',\n key: 'key',\n\n // the properties below are optional\n version: 'version',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionS3Location", "kind": "interface", "locationInModule": { "filename": "lib/api-definition.ts", "line": 103 }, "name": "ApiDefinitionS3Location", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/api-definition.ts", "line": 105 }, "name": "bucket", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The S3 key." }, "immutable": true, "locationInModule": { "filename": "lib/api-definition.ts", "line": 107 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- latest version", "stability": "stable", "summary": "An optional version." }, "immutable": true, "locationInModule": { "filename": "lib/api-definition.ts", "line": 112 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/api-definition:ApiDefinitionS3Location" }, "@aws-cdk/aws-apigateway.ApiKey": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "remarks": "An ApiKey can be distributed to API clients that are executing requests\nfor Method resources that require an Api Key.", "stability": "stable", "summary": "An API Gateway ApiKey.", "example": "const importedKey = apigateway.ApiKey.fromApiKeyId(this, 'imported-key', '');", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ApiKey", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-key.ts", "line": 160 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ApiKeyProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IApiKey" ], "kind": "class", "locationInModule": { "filename": "lib/api-key.ts", "line": 137 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an ApiKey by its Id." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 142 }, "name": "fromApiKeyId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "apiKeyId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IApiKey" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Permits the IAM principal all read operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 96 }, "name": "grantRead", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Permits the IAM principal all read and write operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 122 }, "name": "grantReadWrite", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Permits the IAM principal all write operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 109 }, "name": "grantWrite", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "ApiKey", "properties": [ { "docs": { "stability": "stable", "summary": "The API key ARN." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 158 }, "name": "keyArn", "overrides": "@aws-cdk/aws-apigateway.IApiKey", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The API key ID." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 157 }, "name": "keyId", "overrides": "@aws-cdk/aws-apigateway.IApiKey", "type": { "primitive": "string" } } ], "symbolId": "lib/api-key:ApiKey" }, "@aws-cdk/aws-apigateway.ApiKeyOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "The options for creating an API Key.", "example": "declare const api: apigateway.RestApi;\nconst key = api.addApiKey('ApiKey', {\n apiKeyName: 'myApiKey1',\n value: 'MyApiKeyThatIsAtLeast20Characters',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ApiKeyOptions", "interfaces": [ "@aws-cdk/aws-apigateway.ResourceOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/api-key.ts", "line": 29 }, "name": "ApiKeyOptions", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name" }, "default": "automically generated name", "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.", "stability": "stable", "summary": "A name for the API key." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 35 }, "name": "apiKeyName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description" }, "default": "none", "stability": "stable", "summary": "A description of the purpose of the API key." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 49 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value" }, "default": "none", "remarks": "Must be at least 20 characters long.", "stability": "stable", "summary": "The value of the API key." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 42 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/api-key:ApiKeyOptions" }, "@aws-cdk/aws-apigateway.ApiKeyProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "ApiKey Properties.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const authorizer: apigateway.Authorizer;\ndeclare const integration: apigateway.Integration;\ndeclare const model: apigateway.Model;\ndeclare const requestValidator: apigateway.RequestValidator;\ndeclare const restApi: apigateway.RestApi;\nconst apiKeyProps: apigateway.ApiKeyProps = {\n apiKeyName: 'apiKeyName',\n customerId: 'customerId',\n defaultCorsPreflightOptions: {\n allowOrigins: ['allowOrigins'],\n\n // the properties below are optional\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n disableCache: false,\n exposeHeaders: ['exposeHeaders'],\n maxAge: cdk.Duration.minutes(30),\n statusCode: 123,\n },\n defaultIntegration: integration,\n defaultMethodOptions: {\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: apigateway.AuthorizationType.NONE,\n authorizer: authorizer,\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: model,\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidator: requestValidator,\n requestValidatorOptions: {\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n },\n },\n description: 'description',\n enabled: false,\n generateDistinctId: false,\n resources: [restApi],\n value: 'value',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ApiKeyProps", "interfaces": [ "@aws-cdk/aws-apigateway.ApiKeyOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/api-key.ts", "line": 55 }, "name": "ApiKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid" }, "default": "none", "stability": "stable", "summary": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 67 }, "name": "customerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled" }, "default": "true", "stability": "stable", "summary": "Indicates whether the API key can be used by clients." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 74 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid" }, "default": "false", "stability": "stable", "summary": "Specifies whether the key identifier is distinct from the created API key value." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 81 }, "name": "generateDistinctId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "A list of resources this api key is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 60 }, "name": "resources", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" }, "kind": "array" } } } ], "symbolId": "lib/api-key:ApiKeyProps" }, "@aws-cdk/aws-apigateway.ApiKeySourceType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.ApiKeySourceType", "kind": "enum", "locationInModule": { "filename": "lib/restapi.ts", "line": 864 }, "members": [ { "docs": { "stability": "stable", "summary": "To read the API key from the `X-API-Key` header of a request." }, "name": "HEADER" }, { "docs": { "stability": "stable", "summary": "To read the API key from the `UsageIdentifierKey` from a custom authorizer." }, "name": "AUTHORIZER" } ], "name": "ApiKeySourceType", "symbolId": "lib/restapi:ApiKeySourceType" }, "@aws-cdk/aws-apigateway.AssetApiDefinition": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.ApiDefinition", "docs": { "stability": "stable", "summary": "OpenAPI specification from a local file.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const dockerImage: cdk.DockerImage;\ndeclare const grantable: iam.IGrantable;\ndeclare const localBundling: cdk.ILocalBundling;\nconst assetApiDefinition = new apigateway.AssetApiDefinition('path', /* all optional props */ {\n assetHash: 'assetHash',\n assetHashType: cdk.AssetHashType.SOURCE,\n bundling: {\n image: dockerImage,\n\n // the properties below are optional\n command: ['command'],\n entrypoint: ['entrypoint'],\n environment: {\n environmentKey: 'environment',\n },\n local: localBundling,\n outputType: cdk.BundlingOutput.ARCHIVED,\n securityOpt: 'securityOpt',\n user: 'user',\n volumes: [{\n containerPath: 'containerPath',\n hostPath: 'hostPath',\n\n // the properties below are optional\n consistency: cdk.DockerVolumeConsistency.CONSISTENT,\n }],\n workingDirectory: 'workingDirectory',\n },\n exclude: ['exclude'],\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n readers: [grantable],\n sourceHash: 'sourceHash',\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.AssetApiDefinition", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 190 }, "parameters": [ { "name": "path", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/api-definition.ts", "line": 187 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 194 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.ApiDefinition", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionConfig" } } }, { "docs": { "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.", "stability": "stable", "summary": "Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 215 }, "name": "bindAfterCreate", "overrides": "@aws-cdk/aws-apigateway.ApiDefinition", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ] } ], "name": "AssetApiDefinition", "symbolId": "lib/api-definition:AssetApiDefinition" }, "@aws-cdk/aws-apigateway.AuthorizationType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "const userPool = new cognito.UserPool(this, 'UserPool');\n\nconst auth = new apigateway.CognitoUserPoolsAuthorizer(this, 'booksAuthorizer', {\n cognitoUserPools: [userPool]\n});\n\ndeclare const books: apigateway.Resource;\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth,\n authorizationType: apigateway.AuthorizationType.COGNITO,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AuthorizationType", "kind": "enum", "locationInModule": { "filename": "lib/method.ts", "line": 369 }, "members": [ { "docs": { "stability": "stable", "summary": "Open access." }, "name": "NONE" }, { "docs": { "stability": "stable", "summary": "Use AWS IAM permissions." }, "name": "IAM" }, { "docs": { "stability": "stable", "summary": "Use a custom authorizer." }, "name": "CUSTOM" }, { "docs": { "stability": "stable", "summary": "Use an AWS Cognito user pool." }, "name": "COGNITO" } ], "name": "AuthorizationType", "symbolId": "lib/method:AuthorizationType" }, "@aws-cdk/aws-apigateway.Authorizer": { "abstract": true, "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Base class for all custom authorizers." }, "fqn": "@aws-cdk/aws-apigateway.Authorizer", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizer.ts", "line": 22 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/core.ResourceProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IAuthorizer" ], "kind": "class", "locationInModule": { "filename": "lib/authorizer.ts", "line": 11 }, "methods": [ { "docs": { "stability": "stable", "summary": "Return whether the given object is an Authorizer." }, "locationInModule": { "filename": "lib/authorizer.ts", "line": 15 }, "name": "isAuthorizer", "parameters": [ { "name": "x", "type": { "primitive": "any" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true } ], "name": "Authorizer", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The authorizer ID." }, "immutable": true, "locationInModule": { "filename": "lib/authorizer.ts", "line": 19 }, "name": "authorizerId", "overrides": "@aws-cdk/aws-apigateway.IAuthorizer", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The authorization type of this authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizer.ts", "line": 20 }, "name": "authorizationType", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IAuthorizer", "type": { "fqn": "@aws-cdk/aws-apigateway.AuthorizationType" } } ], "symbolId": "lib/authorizer:Authorizer" }, "@aws-cdk/aws-apigateway.AwsIntegration": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Integration", "docs": { "remarks": "It is\nintended for calling all AWS service actions, but is not recommended for\ncalling a Lambda function, because the Lambda custom integration is a legacy\ntechnology.", "stability": "stable", "summary": "This type of integration lets an API expose AWS service actions.", "example": "const getMessageIntegration = new apigateway.AwsIntegration({\n service: 'sqs',\n path: 'queueName',\n region: 'eu-west-1'\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AwsIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 82 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.AwsIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 79 }, "methods": [ { "docs": { "stability": "stable", "summary": "Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc." }, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 106 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.Integration", "parameters": [ { "name": "method", "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationConfig" } } } ], "name": "AwsIntegration", "symbolId": "lib/integrations/aws:AwsIntegration" }, "@aws-cdk/aws-apigateway.AwsIntegrationProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "const getMessageIntegration = new apigateway.AwsIntegration({\n service: 'sqs',\n path: 'queueName',\n region: 'eu-west-1'\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.AwsIntegrationProps", "kind": "interface", "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 7 }, "name": "AwsIntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the integrated AWS service (e.g. `s3`)." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 18 }, "name": "service", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Use `actionParams` to specify key-value params for the action.\n\nMutually exclusive with `path`.", "stability": "stable", "summary": "The AWS action to perform in the integration." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 43 }, "name": "action", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "`action` must be set, and `path` must be undefined.\nThe action params will be URL encoded.", "stability": "stable", "summary": "Parameters for the action." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 51 }, "name": "actionParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "POST", "stability": "stable", "summary": "The integration's HTTP method type." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 58 }, "name": "integrationHttpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Integration options, such as content handling, request/response mapping, etc." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 63 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions" } }, { "abstract": true, "docs": { "remarks": "For example, for S3 GET, you can set path to `bucket/key`.\nFor lambda, you can set path to `2015-03-31/functions/${function-arn}/invocations`\n\nMutually exclusive with the `action` options.", "stability": "stable", "summary": "The path to use for path-base APIs." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 34 }, "name": "path", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use AWS_PROXY integration." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 13 }, "name": "proxy", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- same region as the stack", "stability": "stable", "summary": "The region of the integrated AWS service." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 70 }, "name": "region", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A designated subdomain supported by certain AWS service for fast host-name lookup." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/aws.ts", "line": 24 }, "name": "subdomain", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/integrations/aws:AwsIntegrationProps" }, "@aws-cdk/aws-apigateway.BasePathMapping": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "remarks": "Unless you're importing a domain with `DomainName.fromDomainNameAttributes()`,\nyou can use `DomainName.addBasePathMapping()` to define mappings.", "stability": "stable", "summary": "This resource creates a base path that clients who call your API must use in the invocation URL.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const domainName: apigateway.DomainName;\ndeclare const restApi: apigateway.RestApi;\ndeclare const stage: apigateway.Stage;\nconst basePathMapping = new apigateway.BasePathMapping(this, 'MyBasePathMapping', {\n domainName: domainName,\n restApi: restApi,\n\n // the properties below are optional\n basePath: 'basePath',\n stage: stage,\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.BasePathMapping", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 47 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.BasePathMappingProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 46 }, "name": "BasePathMapping", "symbolId": "lib/base-path-mapping:BasePathMapping" }, "@aws-cdk/aws-apigateway.BasePathMappingOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const domain: apigateway.DomainName;\ndeclare const api1: apigateway.RestApi;\ndeclare const api2: apigateway.RestApi;\n\ndomain.addBasePathMapping(api1, { basePath: 'go-to-api1' });\ndomain.addBasePathMapping(api2, { basePath: 'boom' });", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.BasePathMappingOptions", "kind": "interface", "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 8 }, "name": "BasePathMappingOptions", "properties": [ { "abstract": true, "docs": { "default": "- map requests from the domain root (e.g. `example.com`). If this\nis undefined, no additional mappings will be allowed on this domain name.", "stability": "stable", "summary": "The base path name that callers of the API must provide in the URL after the domain name (e.g. `example.com/base-path`). If you specify this property, it can't be an empty string." }, "immutable": true, "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 17 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- map to deploymentStage of restApi otherwise stage needs to pass in URL", "stability": "stable", "summary": "The Deployment stage of API [disable-awslint:ref-via-interface]." }, "immutable": true, "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 24 }, "name": "stage", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Stage" } } ], "symbolId": "lib/base-path-mapping:BasePathMappingOptions" }, "@aws-cdk/aws-apigateway.BasePathMappingProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const domainName: apigateway.DomainName;\ndeclare const restApi: apigateway.RestApi;\ndeclare const stage: apigateway.Stage;\nconst basePathMappingProps: apigateway.BasePathMappingProps = {\n domainName: domainName,\n restApi: restApi,\n\n // the properties below are optional\n basePath: 'basePath',\n stage: stage,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.BasePathMappingProps", "interfaces": [ "@aws-cdk/aws-apigateway.BasePathMappingOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 27 }, "name": "BasePathMappingProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The DomainName to associate with this base path mapping." }, "immutable": true, "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 31 }, "name": "domainName", "type": { "fqn": "@aws-cdk/aws-apigateway.IDomainName" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The RestApi resource to target." }, "immutable": true, "locationInModule": { "filename": "lib/base-path-mapping.ts", "line": 36 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/base-path-mapping:BasePathMappingProps" }, "@aws-cdk/aws-apigateway.CfnAccount": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Account", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one `AWS::ApiGateway::Account` resource per region per account.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Account`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAccount = new apigateway.CfnAccount(this, 'MyCfnAccount', /* all optional props */ {\n cloudWatchRoleArn: 'cloudWatchRoleArn',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnAccount", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Account`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 129 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnAccountProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 84 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 142 }, "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/apigateway.generated.ts", "line": 153 }, "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": "CfnAccount", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 88 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the account." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 113 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 147 }, "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-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn" }, "stability": "external", "summary": "The ARN of an Amazon CloudWatch role for the current Account." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 120 }, "name": "cloudWatchRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnAccount" }, "@aws-cdk/aws-apigateway.CfnAccountProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnAccount`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAccountProps: apigateway.CfnAccountProps = {\n cloudWatchRoleArn: 'cloudWatchRoleArn',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnAccountProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 19 }, "name": "CfnAccountProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn" }, "stability": "external", "summary": "The ARN of an Amazon CloudWatch role for the current Account." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 26 }, "name": "cloudWatchRoleArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnAccountProps" }, "@aws-cdk/aws-apigateway.CfnApiKey": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::ApiKey", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::ApiKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnApiKey = new apigateway.CfnApiKey(this, 'MyCfnApiKey', /* all optional props */ {\n customerId: 'customerId',\n description: 'description',\n enabled: false,\n generateDistinctId: false,\n name: 'name',\n stageKeys: [{\n restApiId: 'restApiId',\n stageName: 'stageName',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n value: 'value',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnApiKey", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::ApiKey`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 399 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnApiKeyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 303 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 419 }, "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/apigateway.generated.ts", "line": 437 }, "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": "CfnApiKey", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 307 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "APIKeyId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the API key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 332 }, "name": "attrApiKeyId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 424 }, "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-apigateway-apikey.html#cfn-apigateway-apikey-tags" }, "remarks": "The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.", "stability": "external", "summary": "The key-value map of strings." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 383 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid" }, "stability": "external", "summary": "An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 339 }, "name": "customerId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description" }, "stability": "external", "summary": "The description of the ApiKey." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 346 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled" }, "stability": "external", "summary": "Specifies whether the ApiKey can be used by callers." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 353 }, "name": "enabled", "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-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid" }, "remarks": "This parameter is deprecated and should not be used.", "stability": "external", "summary": "Specifies whether ( `true` ) or not ( `false` ) the key identifier is distinct from the created API key value." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 360 }, "name": "generateDistinctId", "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-apigateway-apikey.html#cfn-apigateway-apikey-name" }, "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the API key." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 369 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys" }, "stability": "external", "summary": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 376 }, "name": "stageKeys", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiKey.StageKeyProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value" }, "stability": "external", "summary": "Specifies a value of the API key." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 390 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnApiKey" }, "@aws-cdk/aws-apigateway.CfnApiKey.StageKeyProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`StageKey` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst stageKeyProperty: apigateway.CfnApiKey.StageKeyProperty = {\n restApiId: 'restApiId',\n stageName: 'stageName',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnApiKey.StageKeyProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 451 }, "name": "StageKeyProperty", "namespace": "CfnApiKey", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 457 }, "name": "restApiId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename" }, "stability": "external", "summary": "The stage name associated with the stage key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 463 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnApiKey.StageKeyProperty" }, "@aws-cdk/aws-apigateway.CfnApiKeyProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnApiKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnApiKeyProps: apigateway.CfnApiKeyProps = {\n customerId: 'customerId',\n description: 'description',\n enabled: false,\n generateDistinctId: false,\n name: 'name',\n stageKeys: [{\n restApiId: 'restApiId',\n stageName: 'stageName',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnApiKeyProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 166 }, "name": "CfnApiKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid" }, "stability": "external", "summary": "An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 173 }, "name": "customerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description" }, "stability": "external", "summary": "The description of the ApiKey." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 180 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled" }, "stability": "external", "summary": "Specifies whether the ApiKey can be used by callers." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 187 }, "name": "enabled", "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-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid" }, "remarks": "This parameter is deprecated and should not be used.", "stability": "external", "summary": "Specifies whether ( `true` ) or not ( `false` ) the key identifier is distinct from the created API key value." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 194 }, "name": "generateDistinctId", "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-apigateway-apikey.html#cfn-apigateway-apikey-name" }, "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the API key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 203 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys" }, "stability": "external", "summary": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 210 }, "name": "stageKeys", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiKey.StageKeyProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags" }, "remarks": "The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.", "stability": "external", "summary": "The key-value map of strings." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 217 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value" }, "stability": "external", "summary": "Specifies a value of the API key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 224 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnApiKeyProps" }, "@aws-cdk/aws-apigateway.CfnApiMappingV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::ApiMapping", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::ApiMapping`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnApiMappingV2 = new apigateway.CfnApiMappingV2(this, 'MyCfnApiMappingV2', {\n apiId: 'apiId',\n domainName: 'domainName',\n stage: 'stage',\n\n // the properties below are optional\n apiMappingKey: 'apiMappingKey',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnApiMappingV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::ApiMapping`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 622 }, "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-apigateway.CfnApiMappingV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 585 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 640 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 653 }, "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": "CfnApiMappingV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 589 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 645 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 595 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.DomainName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 601 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.Stage`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 607 }, "name": "stage", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.ApiMappingKey`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 613 }, "name": "apiMappingKey", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnApiMappingV2" }, "@aws-cdk/aws-apigateway.CfnApiMappingV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::ApiMapping`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnApiMappingV2Props: apigateway.CfnApiMappingV2Props = {\n apiId: 'apiId',\n domainName: 'domainName',\n stage: 'stage',\n\n // the properties below are optional\n apiMappingKey: 'apiMappingKey',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnApiMappingV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 511 }, "name": "CfnApiMappingV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 517 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.DomainName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 523 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.Stage`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 529 }, "name": "stage", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::ApiMapping.ApiMappingKey`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 535 }, "name": "apiMappingKey", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnApiMappingV2Props" }, "@aws-cdk/aws-apigateway.CfnApiV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Api", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Api`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const body: any;\ndeclare const tags: any;\nconst cfnApiV2 = new apigateway.CfnApiV2(this, 'MyCfnApiV2', /* all optional props */ {\n apiKeySelectionExpression: 'apiKeySelectionExpression',\n basePath: 'basePath',\n body: body,\n bodyS3Location: {\n bucket: 'bucket',\n etag: 'etag',\n key: 'key',\n version: 'version',\n },\n corsConfiguration: {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n },\n credentialsArn: 'credentialsArn',\n description: 'description',\n disableSchemaValidation: false,\n failOnWarnings: false,\n name: 'name',\n protocolType: 'protocolType',\n routeKey: 'routeKey',\n routeSelectionExpression: 'routeSelectionExpression',\n tags: tags,\n target: 'target',\n version: 'version',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnApiV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Api`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 295 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnApiV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 186 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 322 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 347 }, "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": "CfnApiV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 190 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 327 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 274 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Body`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 208 }, "name": "body", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 196 }, "name": "apiKeySelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.BasePath`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 202 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.BodyS3Location`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 214 }, "name": "bodyS3Location", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.BodyS3LocationProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.CorsConfiguration`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 220 }, "name": "corsConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.CorsProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.CredentialsArn`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 226 }, "name": "credentialsArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Description`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 232 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.DisableSchemaValidation`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 238 }, "name": "disableSchemaValidation", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.FailOnWarnings`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 244 }, "name": "failOnWarnings", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Name`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 250 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.ProtocolType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 256 }, "name": "protocolType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.RouteKey`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 262 }, "name": "routeKey", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.RouteSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 268 }, "name": "routeSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Target`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 280 }, "name": "target", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Version`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 286 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnApiV2" }, "@aws-cdk/aws-apigateway.CfnApiV2.BodyS3LocationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst bodyS3LocationProperty: apigateway.CfnApiV2.BodyS3LocationProperty = {\n bucket: 'bucket',\n etag: 'etag',\n key: 'key',\n version: 'version',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.BodyS3LocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 361 }, "name": "BodyS3LocationProperty", "namespace": "CfnApiV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket", "stability": "deprecated", "summary": "`CfnApiV2.BodyS3LocationProperty.Bucket`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 366 }, "name": "bucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag", "stability": "deprecated", "summary": "`CfnApiV2.BodyS3LocationProperty.Etag`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 371 }, "name": "etag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key", "stability": "deprecated", "summary": "`CfnApiV2.BodyS3LocationProperty.Key`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 376 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version", "stability": "deprecated", "summary": "`CfnApiV2.BodyS3LocationProperty.Version`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 381 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnApiV2.BodyS3LocationProperty" }, "@aws-cdk/aws-apigateway.CfnApiV2.CorsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst corsProperty: apigateway.CfnApiV2.CorsProperty = {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.CorsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 430 }, "name": "CorsProperty", "namespace": "CfnApiV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowcredentials", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.AllowCredentials`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 435 }, "name": "allowCredentials", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowheaders", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.AllowHeaders`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 440 }, "name": "allowHeaders", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowmethods", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.AllowMethods`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 445 }, "name": "allowMethods", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-alloworigins", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.AllowOrigins`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 450 }, "name": "allowOrigins", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-exposeheaders", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.ExposeHeaders`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 455 }, "name": "exposeHeaders", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-maxage", "stability": "deprecated", "summary": "`CfnApiV2.CorsProperty.MaxAge`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 460 }, "name": "maxAge", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigatewayv2:CfnApiV2.CorsProperty" }, "@aws-cdk/aws-apigateway.CfnApiV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Api`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const body: any;\ndeclare const tags: any;\nconst cfnApiV2Props: apigateway.CfnApiV2Props = {\n apiKeySelectionExpression: 'apiKeySelectionExpression',\n basePath: 'basePath',\n body: body,\n bodyS3Location: {\n bucket: 'bucket',\n etag: 'etag',\n key: 'key',\n version: 'version',\n },\n corsConfiguration: {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n },\n credentialsArn: 'credentialsArn',\n description: 'description',\n disableSchemaValidation: false,\n failOnWarnings: false,\n name: 'name',\n protocolType: 'protocolType',\n routeKey: 'routeKey',\n routeSelectionExpression: 'routeSelectionExpression',\n tags: tags,\n target: 'target',\n version: 'version',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnApiV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 19 }, "name": "CfnApiV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.ApiKeySelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 25 }, "name": "apiKeySelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.BasePath`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 31 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Body`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 37 }, "name": "body", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.BodyS3Location`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 43 }, "name": "bodyS3Location", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.BodyS3LocationProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.CorsConfiguration`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 49 }, "name": "corsConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnApiV2.CorsProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.CredentialsArn`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 55 }, "name": "credentialsArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 61 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.DisableSchemaValidation`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 67 }, "name": "disableSchemaValidation", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.FailOnWarnings`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 73 }, "name": "failOnWarnings", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 79 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.ProtocolType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 85 }, "name": "protocolType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.RouteKey`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 91 }, "name": "routeKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.RouteSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 97 }, "name": "routeSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 103 }, "name": "tags", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Target`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 109 }, "name": "target", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Api.Version`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 115 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnApiV2Props" }, "@aws-cdk/aws-apigateway.CfnAuthorizer": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Authorizer", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Authorizer`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAuthorizer = new apigateway.CfnAuthorizer(this, 'MyCfnAuthorizer', {\n name: 'name',\n restApiId: 'restApiId',\n type: 'type',\n\n // the properties below are optional\n authorizerCredentials: 'authorizerCredentials',\n authorizerResultTtlInSeconds: 123,\n authorizerUri: 'authorizerUri',\n authType: 'authType',\n identitySource: 'identitySource',\n identityValidationExpression: 'identityValidationExpression',\n providerArns: ['providerArns'],\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizer", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Authorizer`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 792 }, "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-apigateway.CfnAuthorizerProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 684 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 817 }, "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/apigateway.generated.ts", "line": 837 }, "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": "CfnAuthorizer", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 688 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "AuthorizerId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 713 }, "name": "attrAuthorizerId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 822 }, "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-apigateway-authorizer.html#cfn-apigateway-authorizer-name" }, "stability": "external", "summary": "The name of the authorizer." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 720 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 727 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type" }, "remarks": "Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.", "stability": "external", "summary": "The authorizer type." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 734 }, "name": "type", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials" }, "remarks": "To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.", "stability": "external", "summary": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 741 }, "name": "authorizerCredentials", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds" }, "remarks": "If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.", "stability": "external", "summary": "The TTL in seconds of cached authorizer results." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 748 }, "name": "authorizerResultTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri" }, "remarks": "For `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations` . In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}` , where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/` . For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations` .", "stability": "external", "summary": "Specifies the authorizer's Uniform Resource Identifier (URI)." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 755 }, "name": "authorizerUri", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype" }, "stability": "external", "summary": "Optional customer-defined field, used in OpenAPI imports and exports without functional impact." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 762 }, "name": "authType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource" }, "remarks": "For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is `Auth` , the header mapping expression is `method.request.header.Auth` . For the `REQUEST` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name` . These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.", "stability": "external", "summary": "The identity source for which authorization is requested." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 769 }, "name": "identitySource", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression" }, "remarks": "For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.", "stability": "external", "summary": "A validation expression for the incoming identity token." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 776 }, "name": "identityValidationExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns" }, "remarks": "Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}` . For a `TOKEN` or `REQUEST` authorizer, this is not defined.", "stability": "external", "summary": "A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 783 }, "name": "providerArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnAuthorizer" }, "@aws-cdk/aws-apigateway.CfnAuthorizerProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnAuthorizer`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAuthorizerProps: apigateway.CfnAuthorizerProps = {\n name: 'name',\n restApiId: 'restApiId',\n type: 'type',\n\n // the properties below are optional\n authorizerCredentials: 'authorizerCredentials',\n authorizerResultTtlInSeconds: 123,\n authorizerUri: 'authorizerUri',\n authType: 'authType',\n identitySource: 'identitySource',\n identityValidationExpression: 'identityValidationExpression',\n providerArns: ['providerArns'],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 526 }, "name": "CfnAuthorizerProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name" }, "stability": "external", "summary": "The name of the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 533 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 540 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type" }, "remarks": "Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.", "stability": "external", "summary": "The authorizer type." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 547 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials" }, "remarks": "To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.", "stability": "external", "summary": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 554 }, "name": "authorizerCredentials", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds" }, "remarks": "If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.", "stability": "external", "summary": "The TTL in seconds of cached authorizer results." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 561 }, "name": "authorizerResultTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri" }, "remarks": "For `TOKEN` or `REQUEST` authorizers, this must be a well-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations` . In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}` , where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/` . For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations` .", "stability": "external", "summary": "Specifies the authorizer's Uniform Resource Identifier (URI)." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 568 }, "name": "authorizerUri", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype" }, "stability": "external", "summary": "Optional customer-defined field, used in OpenAPI imports and exports without functional impact." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 575 }, "name": "authType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource" }, "remarks": "For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is `Auth` , the header mapping expression is `method.request.header.Auth` . For the `REQUEST` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name` . These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.", "stability": "external", "summary": "The identity source for which authorization is requested." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 582 }, "name": "identitySource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression" }, "remarks": "For `TOKEN` authorizers, this value is a regular expression. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the `REQUEST` authorizer.", "stability": "external", "summary": "A validation expression for the incoming identity token." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 589 }, "name": "identityValidationExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns" }, "remarks": "Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}` . For a `TOKEN` or `REQUEST` authorizer, this is not defined.", "stability": "external", "summary": "A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 596 }, "name": "providerArns", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnAuthorizerProps" }, "@aws-cdk/aws-apigateway.CfnAuthorizerV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Authorizer", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Authorizer`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAuthorizerV2 = new apigateway.CfnAuthorizerV2(this, 'MyCfnAuthorizerV2', {\n apiId: 'apiId',\n authorizerType: 'authorizerType',\n identitySource: ['identitySource'],\n name: 'name',\n\n // the properties below are optional\n authorizerCredentialsArn: 'authorizerCredentialsArn',\n authorizerResultTtlInSeconds: 123,\n authorizerUri: 'authorizerUri',\n identityValidationExpression: 'identityValidationExpression',\n jwtConfiguration: {\n audience: ['audience'],\n issuer: 'issuer',\n },\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Authorizer`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 847 }, "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-apigateway.CfnAuthorizerV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 780 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 871 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 889 }, "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": "CfnAuthorizerV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 784 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 876 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 790 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 796 }, "name": "authorizerType", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.IdentitySource`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 802 }, "name": "identitySource", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.Name`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 808 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 814 }, "name": "authorizerCredentialsArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 820 }, "name": "authorizerResultTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerUri`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 826 }, "name": "authorizerUri", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 832 }, "name": "identityValidationExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.JwtConfiguration`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 838 }, "name": "jwtConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerV2.JWTConfigurationProperty" } ] } } } ], "symbolId": "lib/apigatewayv2:CfnAuthorizerV2" }, "@aws-cdk/aws-apigateway.CfnAuthorizerV2.JWTConfigurationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst jWTConfigurationProperty: apigateway.CfnAuthorizerV2.JWTConfigurationProperty = {\n audience: ['audience'],\n issuer: 'issuer',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerV2.JWTConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 903 }, "name": "JWTConfigurationProperty", "namespace": "CfnAuthorizerV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-audience", "stability": "deprecated", "summary": "`CfnAuthorizerV2.JWTConfigurationProperty.Audience`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 908 }, "name": "audience", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-issuer", "stability": "deprecated", "summary": "`CfnAuthorizerV2.JWTConfigurationProperty.Issuer`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 913 }, "name": "issuer", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnAuthorizerV2.JWTConfigurationProperty" }, "@aws-cdk/aws-apigateway.CfnAuthorizerV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Authorizer`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnAuthorizerV2Props: apigateway.CfnAuthorizerV2Props = {\n apiId: 'apiId',\n authorizerType: 'authorizerType',\n identitySource: ['identitySource'],\n name: 'name',\n\n // the properties below are optional\n authorizerCredentialsArn: 'authorizerCredentialsArn',\n authorizerResultTtlInSeconds: 123,\n authorizerUri: 'authorizerUri',\n identityValidationExpression: 'identityValidationExpression',\n jwtConfiguration: {\n audience: ['audience'],\n issuer: 'issuer',\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 665 }, "name": "CfnAuthorizerV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 671 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 677 }, "name": "authorizerType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.IdentitySource`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 683 }, "name": "identitySource", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 689 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 695 }, "name": "authorizerCredentialsArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 701 }, "name": "authorizerResultTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.AuthorizerUri`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 707 }, "name": "authorizerUri", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 713 }, "name": "identityValidationExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Authorizer.JwtConfiguration`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 719 }, "name": "jwtConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnAuthorizerV2.JWTConfigurationProperty" } ] } } } ], "symbolId": "lib/apigatewayv2:CfnAuthorizerV2Props" }, "@aws-cdk/aws-apigateway.CfnBasePathMapping": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::BasePathMapping", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::BasePathMapping`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnBasePathMapping = new apigateway.CfnBasePathMapping(this, 'MyCfnBasePathMapping', {\n domainName: 'domainName',\n\n // the properties below are optional\n basePath: 'basePath',\n id: 'id',\n restApiId: 'restApiId',\n stage: 'stage',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnBasePathMapping", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::BasePathMapping`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1023 }, "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-apigateway.CfnBasePathMappingProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 956 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1040 }, "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/apigateway.generated.ts", "line": 1055 }, "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": "CfnBasePathMapping", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 960 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1045 }, "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-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname" }, "stability": "external", "summary": "The domain name of the BasePathMapping resource to be described." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 986 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath" }, "stability": "external", "summary": "The base path name that callers of the API must provide as part of the URL after the domain name." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 993 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id" }, "stability": "external", "summary": "`AWS::ApiGateway::BasePathMapping.Id`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1000 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1007 }, "name": "restApiId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage" }, "stability": "external", "summary": "The name of the associated stage." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1014 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnBasePathMapping" }, "@aws-cdk/aws-apigateway.CfnBasePathMappingProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnBasePathMapping`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnBasePathMappingProps: apigateway.CfnBasePathMappingProps = {\n domainName: 'domainName',\n\n // the properties below are optional\n basePath: 'basePath',\n id: 'id',\n restApiId: 'restApiId',\n stage: 'stage',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnBasePathMappingProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 850 }, "name": "CfnBasePathMappingProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname" }, "stability": "external", "summary": "The domain name of the BasePathMapping resource to be described." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 857 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath" }, "stability": "external", "summary": "The base path name that callers of the API must provide as part of the URL after the domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 864 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id" }, "stability": "external", "summary": "`AWS::ApiGateway::BasePathMapping.Id`." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 871 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 878 }, "name": "restApiId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage" }, "stability": "external", "summary": "The name of the associated stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 885 }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnBasePathMappingProps" }, "@aws-cdk/aws-apigateway.CfnClientCertificate": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::ClientCertificate", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::ClientCertificate`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnClientCertificate = new apigateway.CfnClientCertificate(this, 'MyCfnClientCertificate', /* all optional props */ {\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnClientCertificate", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::ClientCertificate`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1195 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnClientCertificateProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1143 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1209 }, "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/apigateway.generated.ts", "line": 1221 }, "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": "CfnClientCertificate", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1147 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "ClientCertificateId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the client certificate." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1172 }, "name": "attrClientCertificateId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1214 }, "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-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1186 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description" }, "stability": "external", "summary": "The description of the client certificate." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1179 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnClientCertificate" }, "@aws-cdk/aws-apigateway.CfnClientCertificateProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnClientCertificate`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnClientCertificateProps: apigateway.CfnClientCertificateProps = {\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnClientCertificateProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1068 }, "name": "CfnClientCertificateProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description" }, "stability": "external", "summary": "The description of the client certificate." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1075 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1082 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnClientCertificateProps" }, "@aws-cdk/aws-apigateway.CfnDeployment": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Deployment", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Deployment`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDeployment = new apigateway.CfnDeployment(this, 'MyCfnDeployment', {\n restApiId: 'restApiId',\n\n // the properties below are optional\n deploymentCanarySettings: {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n description: 'description',\n stageDescription: {\n accessLogSetting: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n canarySetting: {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n clientCertificateId: 'clientCertificateId',\n dataTraceEnabled: false,\n description: 'description',\n documentationVersion: 'documentationVersion',\n loggingLevel: 'loggingLevel',\n methodSettings: [{\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n }],\n metricsEnabled: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n },\n stageName: 'stageName',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Deployment`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1413 }, "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-apigateway.CfnDeploymentProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1340 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1431 }, "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/apigateway.generated.ts", "line": 1446 }, "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": "CfnDeployment", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1344 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DeploymentId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1369 }, "name": "attrDeploymentId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1436 }, "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-apigateway-deployment.html#cfn-apigateway-deployment-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1376 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings" }, "stability": "external", "summary": "The input configuration for a canary deployment." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1383 }, "name": "deploymentCanarySettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.DeploymentCanarySettingsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description" }, "stability": "external", "summary": "The description for the Deployment resource to create." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1390 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription" }, "remarks": "To specify a stage description, you must also provide a stage name.", "stability": "external", "summary": "The description of the Stage resource for the Deployment resource to create." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1397 }, "name": "stageDescription", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.StageDescriptionProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename" }, "stability": "external", "summary": "The name of the Stage resource for the Deployment resource to create." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1404 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDeployment" }, "@aws-cdk/aws-apigateway.CfnDeployment.AccessLogSettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`AccessLogSetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", "stability": "external", "summary": "The `AccessLogSetting` property type specifies settings for logging access in this stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst accessLogSettingProperty: apigateway.CfnDeployment.AccessLogSettingProperty = {\n destinationArn: 'destinationArn',\n format: 'format',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.AccessLogSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1462 }, "name": "AccessLogSettingProperty", "namespace": "CfnDeployment", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn" }, "remarks": "If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` .", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1468 }, "name": "destinationArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format" }, "remarks": "The format must include at least `$context.requestId` .", "stability": "external", "summary": "A single line format of the access logs of data, as specified by selected $context variables." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1474 }, "name": "format", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDeployment.AccessLogSettingProperty" }, "@aws-cdk/aws-apigateway.CfnDeployment.CanarySettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`CanarySetting` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.", "stability": "external", "summary": "The `CanarySetting` property type specifies settings for the canary deployment in this stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst canarySettingProperty: apigateway.CfnDeployment.CanarySettingProperty = {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.CanarySettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1540 }, "name": "CanarySettingProperty", "namespace": "CfnDeployment", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic" }, "stability": "external", "summary": "The percent (0-100) of traffic diverted to a canary deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1546 }, "name": "percentTraffic", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides" }, "remarks": "These stage variables are represented as a string-to-string map between stage variable names and their values.", "stability": "external", "summary": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1552 }, "name": "stageVariableOverrides", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache" }, "stability": "external", "summary": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1558 }, "name": "useStageCache", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigateway.generated:CfnDeployment.CanarySettingProperty" }, "@aws-cdk/aws-apigateway.CfnDeployment.DeploymentCanarySettingsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `DeploymentCanarySettings` property type specifies settings for the canary deployment.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst deploymentCanarySettingsProperty: apigateway.CfnDeployment.DeploymentCanarySettingsProperty = {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.DeploymentCanarySettingsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1625 }, "name": "DeploymentCanarySettingsProperty", "namespace": "CfnDeployment", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-percenttraffic" }, "stability": "external", "summary": "The percentage (0.0-100.0) of traffic routed to the canary deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1631 }, "name": "percentTraffic", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides" }, "remarks": "They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.", "stability": "external", "summary": "A stage variable overrides used for the canary release deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1637 }, "name": "stageVariableOverrides", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-usestagecache" }, "stability": "external", "summary": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1643 }, "name": "useStageCache", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigateway.generated:CfnDeployment.DeploymentCanarySettingsProperty" }, "@aws-cdk/aws-apigateway.CfnDeployment.MethodSettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `MethodSettings` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of `MethodSetting` property types.", "stability": "external", "summary": "The `MethodSetting` property type configures settings for all methods in a stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst methodSettingProperty: apigateway.CfnDeployment.MethodSettingProperty = {\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.MethodSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1712 }, "name": "MethodSettingProperty", "namespace": "CfnDeployment", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachedataencrypted" }, "stability": "external", "summary": "Specifies whether the cached responses are encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1718 }, "name": "cacheDataEncrypted", "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-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachettlinseconds" }, "remarks": "The higher the TTL, the longer the response will be cached.", "stability": "external", "summary": "Specifies the time to live (TTL), in seconds, for cached responses." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1724 }, "name": "cacheTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachingenabled" }, "remarks": "A cache cluster must be enabled on the stage for responses to be cached.", "stability": "external", "summary": "Specifies whether responses should be cached and returned for requests." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1730 }, "name": "cachingEnabled", "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-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-datatraceenabled" }, "stability": "external", "summary": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1736 }, "name": "dataTraceEnabled", "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-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-httpmethod" }, "stability": "external", "summary": "The HTTP method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1742 }, "name": "httpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-logginglevel" }, "remarks": "Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events.", "stability": "external", "summary": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1748 }, "name": "loggingLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-metricsenabled" }, "stability": "external", "summary": "Specifies whether Amazon CloudWatch metrics are enabled for this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1754 }, "name": "metricsEnabled", "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-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-resourcepath" }, "remarks": "Forward slashes ( `/` ) are encoded as `~1` and the initial slash must include a forward slash. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource` . To specify the root path, use only a slash ( `/` ).", "stability": "external", "summary": "The resource path for this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1760 }, "name": "resourcePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingburstlimit" }, "stability": "external", "summary": "Specifies the throttling burst limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1766 }, "name": "throttlingBurstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingratelimit" }, "stability": "external", "summary": "Specifies the throttling rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1772 }, "name": "throttlingRateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigateway.generated:CfnDeployment.MethodSettingProperty" }, "@aws-cdk/aws-apigateway.CfnDeployment.StageDescriptionProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`StageDescription` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst stageDescriptionProperty: apigateway.CfnDeployment.StageDescriptionProperty = {\n accessLogSetting: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n canarySetting: {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n clientCertificateId: 'clientCertificateId',\n dataTraceEnabled: false,\n description: 'description',\n documentationVersion: 'documentationVersion',\n loggingLevel: 'loggingLevel',\n methodSettings: [{\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n }],\n metricsEnabled: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.StageDescriptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1860 }, "name": "StageDescriptionProperty", "namespace": "CfnDeployment", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting" }, "stability": "external", "summary": "Specifies settings for logging access in this stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1866 }, "name": "accessLogSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.AccessLogSettingProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled" }, "stability": "external", "summary": "Specifies whether a cache cluster is enabled for the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1872 }, "name": "cacheClusterEnabled", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize" }, "remarks": "For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference* .", "stability": "external", "summary": "The size of the stage's cache cluster." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1878 }, "name": "cacheClusterSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted" }, "stability": "external", "summary": "Indicates whether the cached responses are encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1884 }, "name": "cacheDataEncrypted", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds" }, "stability": "external", "summary": "The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1890 }, "name": "cacheTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled" }, "remarks": "You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "Indicates whether responses are cached and returned for requests." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1896 }, "name": "cachingEnabled", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting" }, "stability": "external", "summary": "Specifies settings for the canary deployment in this stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1902 }, "name": "canarySetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.CanarySettingProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid" }, "stability": "external", "summary": "The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1908 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled" }, "remarks": "API Gateway pushes these logs to Amazon CloudWatch Logs.", "stability": "external", "summary": "Indicates whether data trace logging is enabled for methods in the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1914 }, "name": "dataTraceEnabled", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description" }, "stability": "external", "summary": "A description of the purpose of the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1920 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion" }, "stability": "external", "summary": "The version identifier of the API documentation snapshot." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1926 }, "name": "documentationVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel" }, "remarks": "For valid values, see the `loggingLevel` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference* .", "stability": "external", "summary": "The logging level for this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1932 }, "name": "loggingLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings" }, "stability": "external", "summary": "Configures settings for all of the stage's methods." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1938 }, "name": "methodSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.MethodSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled" }, "stability": "external", "summary": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1944 }, "name": "metricsEnabled", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags" }, "stability": "external", "summary": "An array of arbitrary tags (key-value pairs) to associate with the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1950 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit" }, "remarks": "This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "The target request burst rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1956 }, "name": "throttlingBurstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit" }, "remarks": "For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "The target request steady-state rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1962 }, "name": "throttlingRateLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled" }, "remarks": "For more information, see [Trace API Gateway API Execution with AWS X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "Specifies whether active tracing with X-ray is enabled for this stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1970 }, "name": "tracingEnabled", "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-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables" }, "remarks": "Variable names must consist of alphanumeric characters, and the values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .", "stability": "external", "summary": "A map that defines the stage variables." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1976 }, "name": "variables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnDeployment.StageDescriptionProperty" }, "@aws-cdk/aws-apigateway.CfnDeploymentProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDeployment`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDeploymentProps: apigateway.CfnDeploymentProps = {\n restApiId: 'restApiId',\n\n // the properties below are optional\n deploymentCanarySettings: {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n description: 'description',\n stageDescription: {\n accessLogSetting: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n canarySetting: {\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n clientCertificateId: 'clientCertificateId',\n dataTraceEnabled: false,\n description: 'description',\n documentationVersion: 'documentationVersion',\n loggingLevel: 'loggingLevel',\n methodSettings: [{\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n }],\n metricsEnabled: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n },\n stageName: 'stageName',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeploymentProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1234 }, "name": "CfnDeploymentProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1241 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings" }, "stability": "external", "summary": "The input configuration for a canary deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1248 }, "name": "deploymentCanarySettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.DeploymentCanarySettingsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description" }, "stability": "external", "summary": "The description for the Deployment resource to create." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1255 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription" }, "remarks": "To specify a stage description, you must also provide a stage name.", "stability": "external", "summary": "The description of the Stage resource for the Deployment resource to create." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1262 }, "name": "stageDescription", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDeployment.StageDescriptionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename" }, "stability": "external", "summary": "The name of the Stage resource for the Deployment resource to create." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 1269 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDeploymentProps" }, "@aws-cdk/aws-apigateway.CfnDeploymentV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Deployment", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Deployment`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDeploymentV2 = new apigateway.CfnDeploymentV2(this, 'MyCfnDeploymentV2', {\n apiId: 'apiId',\n\n // the properties below are optional\n description: 'description',\n stageName: 'stageName',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDeploymentV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Deployment`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1051 }, "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-apigateway.CfnDeploymentV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1020 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1066 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1078 }, "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": "CfnDeploymentV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1024 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1071 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1030 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.Description`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1036 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.StageName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1042 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnDeploymentV2" }, "@aws-cdk/aws-apigateway.CfnDeploymentV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Deployment`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDeploymentV2Props: apigateway.CfnDeploymentV2Props = {\n apiId: 'apiId',\n\n // the properties below are optional\n description: 'description',\n stageName: 'stageName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnDeploymentV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 956 }, "name": "CfnDeploymentV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 962 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 968 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Deployment.StageName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 974 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnDeploymentV2Props" }, "@aws-cdk/aws-apigateway.CfnDocumentationPart": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::DocumentationPart", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::DocumentationPart`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDocumentationPart = new apigateway.CfnDocumentationPart(this, 'MyCfnDocumentationPart', {\n location: {\n method: 'method',\n name: 'name',\n path: 'path',\n statusCode: 'statusCode',\n type: 'type',\n },\n properties: 'properties',\n restApiId: 'restApiId',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationPart", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::DocumentationPart`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2237 }, "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-apigateway.CfnDocumentationPartProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2178 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2255 }, "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/apigateway.generated.ts", "line": 2268 }, "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": "CfnDocumentationPart", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2182 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DocumentationPartId" }, "stability": "external", "summary": "The ID for the documentation part." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2207 }, "name": "attrDocumentationPartId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2260 }, "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-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location" }, "stability": "external", "summary": "The location of the targeted API entity of the to-be-created documentation part." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2214 }, "name": "location", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationPart.LocationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties" }, "remarks": "Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.", "stability": "external", "summary": "The new documentation content map of the targeted API entity." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2221 }, "name": "properties", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2228 }, "name": "restApiId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDocumentationPart" }, "@aws-cdk/aws-apigateway.CfnDocumentationPart.LocationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`Location` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n\n> For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference* .", "stability": "external", "summary": "The `Location` property specifies the location of the Amazon API Gateway API entity that the documentation applies to.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst locationProperty: apigateway.CfnDocumentationPart.LocationProperty = {\n method: 'method',\n name: 'name',\n path: 'path',\n statusCode: 'statusCode',\n type: 'type',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationPart.LocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2284 }, "name": "LocationProperty", "namespace": "CfnDocumentationPart", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method" }, "remarks": "It is a valid field for the API entity types of `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly.", "stability": "external", "summary": "The HTTP verb of a method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2290 }, "name": "method", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name" }, "remarks": "It is a valid and required field for the API entity types of `AUTHORIZER` , `MODEL` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` and `RESPONSE_HEADER` . It is an invalid field for any other entity type.", "stability": "external", "summary": "The name of the targeted API entity." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2296 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path" }, "remarks": "It is a valid field for the API entity types of `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `/` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix.", "stability": "external", "summary": "The URL path of the target." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2302 }, "name": "path", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode" }, "remarks": "It is a valid field for the API entity types of `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly.", "stability": "external", "summary": "The HTTP status code of a response." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2308 }, "name": "statusCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type" }, "remarks": "Valid values are `API` , `AUTHORIZER` , `MODEL` , `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . Content inheritance does not apply to any entity of the `API` , `AUTHORIZER` , `METHOD` , `MODEL` , `REQUEST_BODY` , or `RESOURCE` type.", "stability": "external", "summary": "The type of API entity to which the documentation content applies." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2314 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDocumentationPart.LocationProperty" }, "@aws-cdk/aws-apigateway.CfnDocumentationPartProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDocumentationPart`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDocumentationPartProps: apigateway.CfnDocumentationPartProps = {\n location: {\n method: 'method',\n name: 'name',\n path: 'path',\n statusCode: 'statusCode',\n type: 'type',\n },\n properties: 'properties',\n restApiId: 'restApiId',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationPartProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2090 }, "name": "CfnDocumentationPartProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location" }, "stability": "external", "summary": "The location of the targeted API entity of the to-be-created documentation part." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2097 }, "name": "location", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationPart.LocationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties" }, "remarks": "Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.", "stability": "external", "summary": "The new documentation content map of the targeted API entity." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2104 }, "name": "properties", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2111 }, "name": "restApiId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDocumentationPartProps" }, "@aws-cdk/aws-apigateway.CfnDocumentationVersion": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::DocumentationVersion", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::DocumentationVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDocumentationVersion = new apigateway.CfnDocumentationVersion(this, 'MyCfnDocumentationVersion', {\n documentationVersion: 'documentationVersion',\n restApiId: 'restApiId',\n\n // the properties below are optional\n description: 'description',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::DocumentationVersion`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2526 }, "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-apigateway.CfnDocumentationVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2473 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2542 }, "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/apigateway.generated.ts", "line": 2555 }, "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": "CfnDocumentationVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2477 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2547 }, "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-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion" }, "stability": "external", "summary": "The version identifier of the to-be-updated documentation version." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2503 }, "name": "documentationVersion", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2510 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description" }, "stability": "external", "summary": "A description about the new documentation snapshot." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2517 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDocumentationVersion" }, "@aws-cdk/aws-apigateway.CfnDocumentationVersionProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDocumentationVersion`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDocumentationVersionProps: apigateway.CfnDocumentationVersionProps = {\n documentationVersion: 'documentationVersion',\n restApiId: 'restApiId',\n\n // the properties below are optional\n description: 'description',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDocumentationVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2386 }, "name": "CfnDocumentationVersionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion" }, "stability": "external", "summary": "The version identifier of the to-be-updated documentation version." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2393 }, "name": "documentationVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2400 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description" }, "stability": "external", "summary": "A description about the new documentation snapshot." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2407 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDocumentationVersionProps" }, "@aws-cdk/aws-apigateway.CfnDomainName": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::DomainName", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::DomainName` resource specifies a custom domain name for your API in API Gateway.\n\nYou can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::DomainName`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDomainName = new apigateway.CfnDomainName(this, 'MyCfnDomainName', /* all optional props */ {\n certificateArn: 'certificateArn',\n domainName: 'domainName',\n endpointConfiguration: {\n types: ['types'],\n },\n mutualTlsAuthentication: {\n truststoreUri: 'truststoreUri',\n truststoreVersion: 'truststoreVersion',\n },\n ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',\n regionalCertificateArn: 'regionalCertificateArn',\n securityPolicy: 'securityPolicy',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainName", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::DomainName`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2819 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2705 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2842 }, "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/apigateway.generated.ts", "line": 2860 }, "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": "CfnDomainName", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2709 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DistributionDomainName" }, "remarks": "This is only applicable for endpoints whose type is `EDGE` .\n\nExample: `d111111abcdef8.cloudfront.net`", "stability": "external", "summary": "The Amazon CloudFront distribution domain name that's mapped to the custom domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2736 }, "name": "attrDistributionDomainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DistributionHostedZoneId" }, "remarks": "The only valid value is `Z2FDTNDATAQYW2` for all regions.", "stability": "external", "summary": "The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2742 }, "name": "attrDistributionHostedZoneId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RegionalDomainName" }, "remarks": "You set up this association by adding a DNS record that points the custom domain name to this regional domain name.", "stability": "external", "summary": "The domain name associated with the regional endpoint for this custom domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2748 }, "name": "attrRegionalDomainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RegionalHostedZoneId" }, "stability": "external", "summary": "The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2754 }, "name": "attrRegionalHostedZoneId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2847 }, "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-apigateway-domainname.html#cfn-apigateway-domainname-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2810 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn" }, "remarks": "AWS Certificate Manager is the only supported source.", "stability": "external", "summary": "The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2761 }, "name": "certificateArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname" }, "stability": "external", "summary": "The custom domain name as an API host name, for example, `my-api.example.com` ." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2768 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration" }, "stability": "external", "summary": "The endpoint configuration of this DomainName showing the endpoint types of the domain name." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2775 }, "name": "endpointConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.EndpointConfigurationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication" }, "remarks": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.", "stability": "external", "summary": "The mutual TLS authentication configuration for a custom domain name." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2782 }, "name": "mutualTlsAuthentication", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.MutualTlsAuthenticationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn" }, "remarks": "Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.", "stability": "external", "summary": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2789 }, "name": "ownershipVerificationCertificateArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn" }, "remarks": "AWS Certificate Manager is the only supported source.", "stability": "external", "summary": "The reference to an AWS -managed certificate that will be used for validating the regional domain name." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2796 }, "name": "regionalCertificateArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy" }, "remarks": "The valid values are `TLS_1_0` and `TLS_1_2` .", "stability": "external", "summary": "The Transport Layer Security (TLS) version + cipher suite for this DomainName." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2803 }, "name": "securityPolicy", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDomainName" }, "@aws-cdk/aws-apigateway.CfnDomainName.EndpointConfigurationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`EndpointConfiguration` is a property of the [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.", "stability": "external", "summary": "The `EndpointConfiguration` property type specifies the endpoint types of an Amazon API Gateway domain name.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst endpointConfigurationProperty: apigateway.CfnDomainName.EndpointConfigurationProperty = {\n types: ['types'],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.EndpointConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2876 }, "name": "EndpointConfigurationProperty", "namespace": "CfnDomainName", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types" }, "remarks": "For an edge-optimized API and its custom domain name, the endpoint type is `\"EDGE\"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` .", "stability": "external", "summary": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName)." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2882 }, "name": "types", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnDomainName.EndpointConfigurationProperty" }, "@aws-cdk/aws-apigateway.CfnDomainName.MutualTlsAuthenticationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html", "exampleMetadata": "fixture=_generated" }, "remarks": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.", "stability": "external", "summary": "The mutual TLS authentication configuration for a custom domain name.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst mutualTlsAuthenticationProperty: apigateway.CfnDomainName.MutualTlsAuthenticationProperty = {\n truststoreUri: 'truststoreUri',\n truststoreVersion: 'truststoreVersion',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.MutualTlsAuthenticationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2943 }, "name": "MutualTlsAuthenticationProperty", "namespace": "CfnDomainName", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri" }, "remarks": "The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.", "stability": "external", "summary": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name` ." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2949 }, "name": "truststoreUri", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion" }, "remarks": "To specify a version, you must have versioning enabled for the S3 bucket.", "stability": "external", "summary": "The version of the S3 object that contains your truststore." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2955 }, "name": "truststoreVersion", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnDomainName.MutualTlsAuthenticationProperty" }, "@aws-cdk/aws-apigateway.CfnDomainNameProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDomainName`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnDomainNameProps: apigateway.CfnDomainNameProps = {\n certificateArn: 'certificateArn',\n domainName: 'domainName',\n endpointConfiguration: {\n types: ['types'],\n },\n mutualTlsAuthentication: {\n truststoreUri: 'truststoreUri',\n truststoreVersion: 'truststoreVersion',\n },\n ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',\n regionalCertificateArn: 'regionalCertificateArn',\n securityPolicy: 'securityPolicy',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2568 }, "name": "CfnDomainNameProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn" }, "remarks": "AWS Certificate Manager is the only supported source.", "stability": "external", "summary": "The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2575 }, "name": "certificateArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname" }, "stability": "external", "summary": "The custom domain name as an API host name, for example, `my-api.example.com` ." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2582 }, "name": "domainName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration" }, "stability": "external", "summary": "The endpoint configuration of this DomainName showing the endpoint types of the domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2589 }, "name": "endpointConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.EndpointConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication" }, "remarks": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.", "stability": "external", "summary": "The mutual TLS authentication configuration for a custom domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2596 }, "name": "mutualTlsAuthentication", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainName.MutualTlsAuthenticationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn" }, "remarks": "Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.", "stability": "external", "summary": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2603 }, "name": "ownershipVerificationCertificateArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn" }, "remarks": "AWS Certificate Manager is the only supported source.", "stability": "external", "summary": "The reference to an AWS -managed certificate that will be used for validating the regional domain name." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2610 }, "name": "regionalCertificateArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy" }, "remarks": "The valid values are `TLS_1_0` and `TLS_1_2` .", "stability": "external", "summary": "The Transport Layer Security (TLS) version + cipher suite for this DomainName." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2617 }, "name": "securityPolicy", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 2624 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnDomainNameProps" }, "@aws-cdk/aws-apigateway.CfnDomainNameV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::DomainName", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::DomainName`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const tags: any;\nconst cfnDomainNameV2 = new apigateway.CfnDomainNameV2(this, 'MyCfnDomainNameV2', {\n domainName: 'domainName',\n\n // the properties below are optional\n domainNameConfigurations: [{\n certificateArn: 'certificateArn',\n certificateName: 'certificateName',\n endpointType: 'endpointType',\n }],\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::DomainName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1195 }, "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-apigateway.CfnDomainNameV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1154 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1212 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1224 }, "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": "CfnDomainNameV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1158 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RegionalDomainName" }, "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1163 }, "name": "attrRegionalDomainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RegionalHostedZoneId" }, "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1168 }, "name": "attrRegionalHostedZoneId", "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1217 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1186 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.DomainName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1174 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.DomainNameConfigurations`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1180 }, "name": "domainNameConfigurations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameV2.DomainNameConfigurationProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/apigatewayv2:CfnDomainNameV2" }, "@aws-cdk/aws-apigateway.CfnDomainNameV2.DomainNameConfigurationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst domainNameConfigurationProperty: apigateway.CfnDomainNameV2.DomainNameConfigurationProperty = {\n certificateArn: 'certificateArn',\n certificateName: 'certificateName',\n endpointType: 'endpointType',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameV2.DomainNameConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1238 }, "name": "DomainNameConfigurationProperty", "namespace": "CfnDomainNameV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn", "stability": "deprecated", "summary": "`CfnDomainNameV2.DomainNameConfigurationProperty.CertificateArn`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1243 }, "name": "certificateArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatename", "stability": "deprecated", "summary": "`CfnDomainNameV2.DomainNameConfigurationProperty.CertificateName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1248 }, "name": "certificateName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-endpointtype", "stability": "deprecated", "summary": "`CfnDomainNameV2.DomainNameConfigurationProperty.EndpointType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1253 }, "name": "endpointType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnDomainNameV2.DomainNameConfigurationProperty" }, "@aws-cdk/aws-apigateway.CfnDomainNameV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::DomainName`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const tags: any;\nconst cfnDomainNameV2Props: apigateway.CfnDomainNameV2Props = {\n domainName: 'domainName',\n\n // the properties below are optional\n domainNameConfigurations: [{\n certificateArn: 'certificateArn',\n certificateName: 'certificateName',\n endpointType: 'endpointType',\n }],\n tags: tags,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1090 }, "name": "CfnDomainNameV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.DomainName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1096 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.DomainNameConfigurations`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1102 }, "name": "domainNameConfigurations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnDomainNameV2.DomainNameConfigurationProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::DomainName.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1108 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/apigatewayv2:CfnDomainNameV2Props" }, "@aws-cdk/aws-apigateway.CfnGatewayResponse": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::GatewayResponse", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::GatewayResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnGatewayResponse = new apigateway.CfnGatewayResponse(this, 'MyCfnGatewayResponse', {\n responseType: 'responseType',\n restApiId: 'restApiId',\n\n // the properties below are optional\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n statusCode: 'statusCode',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnGatewayResponse", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::GatewayResponse`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3198 }, "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-apigateway.CfnGatewayResponseProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3125 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3217 }, "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/apigateway.generated.ts", "line": 3232 }, "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": "CfnGatewayResponse", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3129 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the gateway response." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3154 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3222 }, "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-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype" }, "stability": "external", "summary": "The response type of the associated GatewayResponse." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3161 }, "name": "responseType", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3168 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters" }, "stability": "external", "summary": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3175 }, "name": "responseParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates" }, "stability": "external", "summary": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3182 }, "name": "responseTemplates", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode" }, "stability": "external", "summary": "The HTTP status code for this GatewayResponse." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3189 }, "name": "statusCode", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnGatewayResponse" }, "@aws-cdk/aws-apigateway.CfnGatewayResponseProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnGatewayResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnGatewayResponseProps: apigateway.CfnGatewayResponseProps = {\n responseType: 'responseType',\n restApiId: 'restApiId',\n\n // the properties below are optional\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n statusCode: 'statusCode',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnGatewayResponseProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3018 }, "name": "CfnGatewayResponseProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype" }, "stability": "external", "summary": "The response type of the associated GatewayResponse." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3025 }, "name": "responseType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3032 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters" }, "stability": "external", "summary": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3039 }, "name": "responseParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates" }, "stability": "external", "summary": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3046 }, "name": "responseTemplates", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode" }, "stability": "external", "summary": "The HTTP status code for this GatewayResponse." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3053 }, "name": "statusCode", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnGatewayResponseProps" }, "@aws-cdk/aws-apigateway.CfnIntegrationResponseV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::IntegrationResponse", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::IntegrationResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseParameters: any;\ndeclare const responseTemplates: any;\nconst cfnIntegrationResponseV2 = new apigateway.CfnIntegrationResponseV2(this, 'MyCfnIntegrationResponseV2', {\n apiId: 'apiId',\n integrationId: 'integrationId',\n integrationResponseKey: 'integrationResponseKey',\n\n // the properties below are optional\n contentHandlingStrategy: 'contentHandlingStrategy',\n responseParameters: responseParameters,\n responseTemplates: responseTemplates,\n templateSelectionExpression: 'templateSelectionExpression',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnIntegrationResponseV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::IntegrationResponse`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1763 }, "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-apigateway.CfnIntegrationResponseV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1708 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1784 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1800 }, "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": "CfnIntegrationResponseV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1712 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1789 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1718 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.IntegrationId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1724 }, "name": "integrationId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.IntegrationResponseKey`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1730 }, "name": "integrationResponseKey", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ResponseParameters`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1742 }, "name": "responseParameters", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ResponseTemplates`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1748 }, "name": "responseTemplates", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ContentHandlingStrategy`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1736 }, "name": "contentHandlingStrategy", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.TemplateSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1754 }, "name": "templateSelectionExpression", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnIntegrationResponseV2" }, "@aws-cdk/aws-apigateway.CfnIntegrationResponseV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::IntegrationResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseParameters: any;\ndeclare const responseTemplates: any;\nconst cfnIntegrationResponseV2Props: apigateway.CfnIntegrationResponseV2Props = {\n apiId: 'apiId',\n integrationId: 'integrationId',\n integrationResponseKey: 'integrationResponseKey',\n\n // the properties below are optional\n contentHandlingStrategy: 'contentHandlingStrategy',\n responseParameters: responseParameters,\n responseTemplates: responseTemplates,\n templateSelectionExpression: 'templateSelectionExpression',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnIntegrationResponseV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1610 }, "name": "CfnIntegrationResponseV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1616 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.IntegrationId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1622 }, "name": "integrationId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.IntegrationResponseKey`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1628 }, "name": "integrationResponseKey", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ContentHandlingStrategy`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1634 }, "name": "contentHandlingStrategy", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ResponseParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1640 }, "name": "responseParameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.ResponseTemplates`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1646 }, "name": "responseTemplates", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::IntegrationResponse.TemplateSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1652 }, "name": "templateSelectionExpression", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnIntegrationResponseV2Props" }, "@aws-cdk/aws-apigateway.CfnIntegrationV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Integration", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Integration`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const requestParameters: any;\ndeclare const requestTemplates: any;\nconst cfnIntegrationV2 = new apigateway.CfnIntegrationV2(this, 'MyCfnIntegrationV2', {\n apiId: 'apiId',\n integrationType: 'integrationType',\n\n // the properties below are optional\n connectionType: 'connectionType',\n contentHandlingStrategy: 'contentHandlingStrategy',\n credentialsArn: 'credentialsArn',\n description: 'description',\n integrationMethod: 'integrationMethod',\n integrationUri: 'integrationUri',\n passthroughBehavior: 'passthroughBehavior',\n payloadFormatVersion: 'payloadFormatVersion',\n requestParameters: requestParameters,\n requestTemplates: requestTemplates,\n templateSelectionExpression: 'templateSelectionExpression',\n timeoutInMillis: 123,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnIntegrationV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Integration`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1548 }, "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-apigateway.CfnIntegrationV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1451 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1575 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1598 }, "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": "CfnIntegrationV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1455 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1580 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1461 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1467 }, "name": "integrationType", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.RequestParameters`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1521 }, "name": "requestParameters", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.RequestTemplates`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1527 }, "name": "requestTemplates", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ConnectionType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1473 }, "name": "connectionType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ContentHandlingStrategy`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1479 }, "name": "contentHandlingStrategy", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.CredentialsArn`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1485 }, "name": "credentialsArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.Description`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1491 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationMethod`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1497 }, "name": "integrationMethod", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationUri`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1503 }, "name": "integrationUri", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.PassthroughBehavior`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1509 }, "name": "passthroughBehavior", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.PayloadFormatVersion`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1515 }, "name": "payloadFormatVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.TemplateSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1533 }, "name": "templateSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.TimeoutInMillis`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1539 }, "name": "timeoutInMillis", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigatewayv2:CfnIntegrationV2" }, "@aws-cdk/aws-apigateway.CfnIntegrationV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Integration`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const requestParameters: any;\ndeclare const requestTemplates: any;\nconst cfnIntegrationV2Props: apigateway.CfnIntegrationV2Props = {\n apiId: 'apiId',\n integrationType: 'integrationType',\n\n // the properties below are optional\n connectionType: 'connectionType',\n contentHandlingStrategy: 'contentHandlingStrategy',\n credentialsArn: 'credentialsArn',\n description: 'description',\n integrationMethod: 'integrationMethod',\n integrationUri: 'integrationUri',\n passthroughBehavior: 'passthroughBehavior',\n payloadFormatVersion: 'payloadFormatVersion',\n requestParameters: requestParameters,\n requestTemplates: requestTemplates,\n templateSelectionExpression: 'templateSelectionExpression',\n timeoutInMillis: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnIntegrationV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1298 }, "name": "CfnIntegrationV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1304 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1310 }, "name": "integrationType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ConnectionType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1316 }, "name": "connectionType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.ContentHandlingStrategy`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1322 }, "name": "contentHandlingStrategy", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.CredentialsArn`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1328 }, "name": "credentialsArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1334 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationMethod`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1340 }, "name": "integrationMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.IntegrationUri`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1346 }, "name": "integrationUri", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.PassthroughBehavior`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1352 }, "name": "passthroughBehavior", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.PayloadFormatVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1358 }, "name": "payloadFormatVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.RequestParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1364 }, "name": "requestParameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.RequestTemplates`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1370 }, "name": "requestTemplates", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.TemplateSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1376 }, "name": "templateSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Integration.TimeoutInMillis`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1382 }, "name": "timeoutInMillis", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigatewayv2:CfnIntegrationV2Props" }, "@aws-cdk/aws-apigateway.CfnMethod": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Method", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Method`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnMethod = new apigateway.CfnMethod(this, 'MyCfnMethod', {\n httpMethod: 'httpMethod',\n resourceId: 'resourceId',\n restApiId: 'restApiId',\n\n // the properties below are optional\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: 'authorizationType',\n authorizerId: 'authorizerId',\n integration: {\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionId: 'connectionId',\n connectionType: 'connectionType',\n contentHandling: 'contentHandling',\n credentials: 'credentials',\n integrationHttpMethod: 'integrationHttpMethod',\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: 'contentHandling',\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: 'passthroughBehavior',\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeoutInMillis: 123,\n type: 'type',\n uri: 'uri',\n },\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: 'responseModels',\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: 'requestModels',\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidatorId: 'requestValidatorId',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnMethod", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Method`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3560 }, "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-apigateway.CfnMethodProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3435 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3587 }, "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/apigateway.generated.ts", "line": 3610 }, "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": "CfnMethod", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3439 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3592 }, "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-apigateway-method.html#cfn-apigateway-method-httpmethod" }, "stability": "external", "summary": "The method's HTTP verb." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3465 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid" }, "stability": "external", "summary": "The Resource identifier for the MethodResponse resource." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3472 }, "name": "resourceId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3479 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired" }, "stability": "external", "summary": "A boolean flag specifying whether a valid ApiKey is required to invoke this method." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3486 }, "name": "apiKeyRequired", "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-apigateway-method.html#cfn-apigateway-method-authorizationscopes" }, "remarks": "The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.", "stability": "external", "summary": "A list of authorization scopes configured on the method." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3493 }, "name": "authorizationScopes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype" }, "remarks": "This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference* .\n\n> If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.", "stability": "external", "summary": "The method's authorization type." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3502 }, "name": "authorizationType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid" }, "remarks": "The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .", "stability": "external", "summary": "The identifier of an authorizer to use on this method." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3509 }, "name": "authorizerId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration" }, "stability": "external", "summary": "Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3516 }, "name": "integration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnMethod.IntegrationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses" }, "stability": "external", "summary": "Gets a method response associated with a given HTTP status code." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3523 }, "name": "methodResponses", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnMethod.MethodResponseProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname" }, "remarks": "For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.", "stability": "external", "summary": "A human-friendly operation identifier for the method." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3530 }, "name": "operationName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels" }, "stability": "external", "summary": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key)." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3537 }, "name": "requestModels", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters" }, "remarks": "A key is a method request parameter name matching the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( `true` ) or optional ( `false` ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.", "stability": "external", "summary": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3544 }, "name": "requestParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "map" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid" }, "stability": "external", "summary": "The identifier of a RequestValidator for request validation." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3551 }, "name": "requestValidatorId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnMethod" }, "@aws-cdk/aws-apigateway.CfnMethod.IntegrationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst integrationProperty: apigateway.CfnMethod.IntegrationProperty = {\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionId: 'connectionId',\n connectionType: 'connectionType',\n contentHandling: 'contentHandling',\n credentials: 'credentials',\n integrationHttpMethod: 'integrationHttpMethod',\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: 'contentHandling',\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: 'passthroughBehavior',\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeoutInMillis: 123,\n type: 'type',\n uri: 'uri',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnMethod.IntegrationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3624 }, "name": "IntegrationProperty", "namespace": "CfnMethod", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters" }, "remarks": "To be valid values for `cacheKeyParameters` , these parameters must also be specified for Method `requestParameters` .", "stability": "external", "summary": "A list of request parameters whose values API Gateway caches." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3630 }, "name": "cacheKeyParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace" }, "remarks": "By default, API Gateway uses the resource ID as the `cacheNamespace` . You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.", "stability": "external", "summary": "Specifies a group of related cached parameters." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3636 }, "name": "cacheNamespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectionid" }, "stability": "external", "summary": "The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3642 }, "name": "connectionId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectiontype" }, "remarks": "The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET` .", "stability": "external", "summary": "The type of the network connection to the integration endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3648 }, "name": "connectionType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling" }, "remarks": "Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.", "stability": "external", "summary": "Specifies how to handle request payload content type conversions." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3656 }, "name": "contentHandling", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials" }, "remarks": "For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\\*:user/\\*` . To use resource-based permissions on supported AWS services, specify null.", "stability": "external", "summary": "Specifies the credentials required for the integration, if any." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3662 }, "name": "credentials", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod" }, "remarks": "For the Type property, if you specify `MOCK` , this property is optional. For Lambda integrations, you must set the integration method to `POST` . For all other types, you must specify this property.", "stability": "external", "summary": "Specifies the integration's HTTP method type." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3668 }, "name": "integrationHttpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses" }, "stability": "external", "summary": "Specifies the integration's responses." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3674 }, "name": "integrationResponses", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnMethod.IntegrationResponseProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior" }, "remarks": "A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates` . The valid value is one of the following: `WHEN_NO_MATCH` : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES` : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER` : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.", "stability": "external", "summary": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3680 }, "name": "passthroughBehavior", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters" }, "remarks": "The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` must be a valid and unique method request parameter name.", "stability": "external", "summary": "A key-value map specifying request parameters that are passed from the method request to the back end." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3686 }, "name": "requestParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates" }, "remarks": "The content type value is the key in this map, and the template (as a String) is the value.", "stability": "external", "summary": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3692 }, "name": "requestTemplates", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis" }, "remarks": "The default value is 29,000 milliseconds or 29 seconds.", "stability": "external", "summary": "Custom timeout between 50 and 29,000 milliseconds." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3698 }, "name": "timeoutInMillis", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type" }, "remarks": "For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( `http/https` ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.", "stability": "external", "summary": "Specifies an API method integration type. The valid value is one of the following:." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3706 }, "name": "type", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri" }, "remarks": "For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}` . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`", "stability": "external", "summary": "Specifies Uniform Resource Identifier (URI) of the integration endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3714 }, "name": "uri", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnMethod.IntegrationProperty" }, "@aws-cdk/aws-apigateway.CfnMethod.IntegrationResponseProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst integrationResponseProperty: apigateway.CfnMethod.IntegrationResponseProperty = {\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: 'contentHandling',\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnMethod.IntegrationResponseProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3814 }, "name": "IntegrationResponseProperty", "namespace": "CfnMethod", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode" }, "stability": "external", "summary": "Specifies the status code that is used to map the integration response to an existing MethodResponse." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3846 }, "name": "statusCode", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling" }, "remarks": "Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification.", "stability": "external", "summary": "Specifies how to handle response payload content type conversions." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3822 }, "name": "contentHandling", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters" }, "remarks": "The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}` , where `name` is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}` , where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix.", "stability": "external", "summary": "A key-value map specifying response parameters that are passed to the method response from the back end." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3828 }, "name": "responseParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates" }, "remarks": "Response templates are represented as a key/value map, with a content-type as the key and a template as the value.", "stability": "external", "summary": "Specifies the templates used to transform the integration response body." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3834 }, "name": "responseTemplates", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern" }, "remarks": "For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response. However, make sure that the error response does not contain any newline ( `\\n` ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.", "stability": "external", "summary": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3840 }, "name": "selectionPattern", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnMethod.IntegrationResponseProperty" }, "@aws-cdk/aws-apigateway.CfnMethod.MethodResponseProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.", "stability": "external", "summary": "Represents a method response of a given HTTP status code returned to the client.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst methodResponseProperty: apigateway.CfnMethod.MethodResponseProperty = {\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: 'responseModels',\n },\n responseParameters: {\n responseParametersKey: false,\n },\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnMethod.MethodResponseProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3920 }, "name": "MethodResponseProperty", "namespace": "CfnMethod", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode" }, "stability": "external", "summary": "The method response's status code." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3938 }, "name": "statusCode", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels" }, "remarks": "Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.", "stability": "external", "summary": "Specifies the Model resources used for the response's content-type." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3926 }, "name": "responseModels", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters" }, "remarks": "A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern `method.response.header.{name}` , where `name` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}` , a static value enclosed within a pair of single quotes (e.g., `'application/json'` ), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}` , where `JSON-expression` is a valid JSON expression without the `$` prefix.)", "stability": "external", "summary": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3932 }, "name": "responseParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnMethod.MethodResponseProperty" }, "@aws-cdk/aws-apigateway.CfnMethodProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnMethod`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnMethodProps: apigateway.CfnMethodProps = {\n httpMethod: 'httpMethod',\n resourceId: 'resourceId',\n restApiId: 'restApiId',\n\n // the properties below are optional\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: 'authorizationType',\n authorizerId: 'authorizerId',\n integration: {\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionId: 'connectionId',\n connectionType: 'connectionType',\n contentHandling: 'contentHandling',\n credentials: 'credentials',\n integrationHttpMethod: 'integrationHttpMethod',\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: 'contentHandling',\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: 'passthroughBehavior',\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeoutInMillis: 123,\n type: 'type',\n uri: 'uri',\n },\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: 'responseModels',\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: 'requestModels',\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidatorId: 'requestValidatorId',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnMethodProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3245 }, "name": "CfnMethodProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod" }, "stability": "external", "summary": "The method's HTTP verb." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3252 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid" }, "stability": "external", "summary": "The Resource identifier for the MethodResponse resource." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3259 }, "name": "resourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3266 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired" }, "stability": "external", "summary": "A boolean flag specifying whether a valid ApiKey is required to invoke this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3273 }, "name": "apiKeyRequired", "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-apigateway-method.html#cfn-apigateway-method-authorizationscopes" }, "remarks": "The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.", "stability": "external", "summary": "A list of authorization scopes configured on the method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3280 }, "name": "authorizationScopes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype" }, "remarks": "This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference* .\n\n> If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.", "stability": "external", "summary": "The method's authorization type." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3289 }, "name": "authorizationType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid" }, "remarks": "The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .", "stability": "external", "summary": "The identifier of an authorizer to use on this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3296 }, "name": "authorizerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration" }, "stability": "external", "summary": "Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3303 }, "name": "integration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnMethod.IntegrationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses" }, "stability": "external", "summary": "Gets a method response associated with a given HTTP status code." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3310 }, "name": "methodResponses", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnMethod.MethodResponseProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname" }, "remarks": "For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.", "stability": "external", "summary": "A human-friendly operation identifier for the method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3317 }, "name": "operationName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels" }, "stability": "external", "summary": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key)." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3324 }, "name": "requestModels", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters" }, "remarks": "A key is a method request parameter name matching the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( `true` ) or optional ( `false` ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.", "stability": "external", "summary": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3331 }, "name": "requestParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid" }, "stability": "external", "summary": "The identifier of a RequestValidator for request validation." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 3338 }, "name": "requestValidatorId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnMethodProps" }, "@aws-cdk/aws-apigateway.CfnModel": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Model", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Model`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const schema: any;\nconst cfnModel = new apigateway.CfnModel(this, 'MyCfnModel', {\n restApiId: 'restApiId',\n\n // the properties below are optional\n contentType: 'contentType',\n description: 'description',\n name: 'name',\n schema: schema,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnModel", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Model`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4182 }, "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-apigateway.CfnModelProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4113 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4199 }, "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/apigateway.generated.ts", "line": 4214 }, "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": "CfnModel", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4117 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4204 }, "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-apigateway-model.html#cfn-apigateway-model-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4143 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema" }, "remarks": "For `application/json` models, this should be JSON schema draft 4 model. Do not include \"\\* /\" characters in the description of any properties because such \"\\* /\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.", "stability": "external", "summary": "The schema for the model." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4173 }, "name": "schema", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype" }, "stability": "external", "summary": "The content-type for the model." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4150 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description" }, "stability": "external", "summary": "The description of the model." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4157 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name" }, "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the model." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4166 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnModel" }, "@aws-cdk/aws-apigateway.CfnModelProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnModel`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const schema: any;\nconst cfnModelProps: apigateway.CfnModelProps = {\n restApiId: 'restApiId',\n\n // the properties below are optional\n contentType: 'contentType',\n description: 'description',\n name: 'name',\n schema: schema,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnModelProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4005 }, "name": "CfnModelProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4012 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype" }, "stability": "external", "summary": "The content-type for the model." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4019 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description" }, "stability": "external", "summary": "The description of the model." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4026 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name" }, "remarks": "If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\n> If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the model." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4035 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema" }, "remarks": "For `application/json` models, this should be JSON schema draft 4 model. Do not include \"\\* /\" characters in the description of any properties because such \"\\* /\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.", "stability": "external", "summary": "The schema for the model." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4042 }, "name": "schema", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/apigateway.generated:CfnModelProps" }, "@aws-cdk/aws-apigateway.CfnModelV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Model", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Model`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const schema: any;\nconst cfnModelV2 = new apigateway.CfnModelV2(this, 'MyCfnModelV2', {\n apiId: 'apiId',\n name: 'name',\n schema: schema,\n\n // the properties below are optional\n contentType: 'contentType',\n description: 'description',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnModelV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Model`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1937 }, "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-apigateway.CfnModelV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1894 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1956 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1970 }, "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": "CfnModelV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1898 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1961 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1904 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Name`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1910 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Schema`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1916 }, "name": "schema", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.ContentType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1922 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Description`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1928 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnModelV2" }, "@aws-cdk/aws-apigateway.CfnModelV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Model`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const schema: any;\nconst cfnModelV2Props: apigateway.CfnModelV2Props = {\n apiId: 'apiId',\n name: 'name',\n schema: schema,\n\n // the properties below are optional\n contentType: 'contentType',\n description: 'description',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnModelV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1812 }, "name": "CfnModelV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1818 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1824 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Schema`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1830 }, "name": "schema", "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.ContentType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1836 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Model.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1842 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnModelV2Props" }, "@aws-cdk/aws-apigateway.CfnRequestValidator": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::RequestValidator", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::RequestValidator`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnRequestValidator = new apigateway.CfnRequestValidator(this, 'MyCfnRequestValidator', {\n restApiId: 'restApiId',\n\n // the properties below are optional\n name: 'name',\n validateRequestBody: false,\n validateRequestParameters: false,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnRequestValidator", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::RequestValidator`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4389 }, "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-apigateway.CfnRequestValidatorProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4323 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4406 }, "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/apigateway.generated.ts", "line": 4420 }, "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": "CfnRequestValidator", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4327 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RequestValidatorId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the request validator." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4352 }, "name": "attrRequestValidatorId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4411 }, "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-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4359 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name" }, "stability": "external", "summary": "The name of this RequestValidator." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4366 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody" }, "stability": "external", "summary": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4373 }, "name": "validateRequestBody", "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-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters" }, "stability": "external", "summary": "A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` )." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4380 }, "name": "validateRequestParameters", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigateway.generated:CfnRequestValidator" }, "@aws-cdk/aws-apigateway.CfnRequestValidatorProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRequestValidator`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnRequestValidatorProps: apigateway.CfnRequestValidatorProps = {\n restApiId: 'restApiId',\n\n // the properties below are optional\n name: 'name',\n validateRequestBody: false,\n validateRequestParameters: false,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnRequestValidatorProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4227 }, "name": "CfnRequestValidatorProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4234 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name" }, "stability": "external", "summary": "The name of this RequestValidator." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4241 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody" }, "stability": "external", "summary": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4248 }, "name": "validateRequestBody", "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-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters" }, "stability": "external", "summary": "A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` )." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4255 }, "name": "validateRequestParameters", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigateway.generated:CfnRequestValidatorProps" }, "@aws-cdk/aws-apigateway.CfnResource": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Resource", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Resource` resource creates a resource in an API.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Resource`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnResource = new apigateway.CfnResource(this, 'MyCfnResource', {\n parentId: 'parentId',\n pathPart: 'pathPart',\n restApiId: 'restApiId',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnResource", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Resource`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4580 }, "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-apigateway.CfnResourceProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4521 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4598 }, "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/apigateway.generated.ts", "line": 4611 }, "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": "CfnResource", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4525 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "ResourceId" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the resource." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4550 }, "name": "attrResourceId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4603 }, "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-apigateway-resource.html#cfn-apigateway-resource-parentid" }, "stability": "external", "summary": "The parent resource's identifier." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4557 }, "name": "parentId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart" }, "stability": "external", "summary": "The last path segment for this resource." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4564 }, "name": "pathPart", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4571 }, "name": "restApiId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnResource" }, "@aws-cdk/aws-apigateway.CfnResourceProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResource`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnResourceProps: apigateway.CfnResourceProps = {\n parentId: 'parentId',\n pathPart: 'pathPart',\n restApiId: 'restApiId',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnResourceProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4433 }, "name": "CfnResourceProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid" }, "stability": "external", "summary": "The parent resource's identifier." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4440 }, "name": "parentId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart" }, "stability": "external", "summary": "The last path segment for this resource." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4447 }, "name": "pathPart", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4454 }, "name": "restApiId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnResourceProps" }, "@aws-cdk/aws-apigateway.CfnRestApi": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::RestApi", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference* .\n\n> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/) , becoming the foundation of the OpenAPI Specification.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::RestApi`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const body: any;\ndeclare const policy: any;\nconst cfnRestApi = new apigateway.CfnRestApi(this, 'MyCfnRestApi', /* all optional props */ {\n apiKeySourceType: 'apiKeySourceType',\n binaryMediaTypes: ['binaryMediaTypes'],\n body: body,\n bodyS3Location: {\n bucket: 'bucket',\n eTag: 'eTag',\n key: 'key',\n version: 'version',\n },\n cloneFrom: 'cloneFrom',\n description: 'description',\n disableExecuteApiEndpoint: false,\n endpointConfiguration: {\n types: ['types'],\n vpcEndpointIds: ['vpcEndpointIds'],\n },\n failOnWarnings: false,\n minimumCompressionSize: 123,\n mode: 'mode',\n name: 'name',\n parameters: {\n parametersKey: 'parameters',\n },\n policy: policy,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnRestApi", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::RestApi`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5000 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnRestApiProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4841 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5028 }, "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/apigateway.generated.ts", "line": 5053 }, "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": "CfnRestApi", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4845 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RestApiId" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4870 }, "name": "attrRestApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RootResourceId" }, "stability": "external", "summary": "The root resource ID for a `RestApi` resource, such as `a0bc123d4e` ." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4876 }, "name": "attrRootResourceId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5033 }, "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-apigateway-restapi.html#cfn-apigateway-restapi-tags" }, "remarks": "The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.", "stability": "external", "summary": "The key-value map of strings." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4991 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body" }, "remarks": "For YAML templates, you can also provide the specification in YAML format.", "stability": "external", "summary": "An OpenAPI specification that defines a set of RESTful APIs in JSON format." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4897 }, "name": "body", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy" }, "remarks": "To set the ARN for the policy, use the `!Join` intrinsic function with `\"\"` as delimiter and values of `\"execute-api:/\"` and `\"*\"` .", "stability": "external", "summary": "A policy document that contains the permissions for the `RestApi` resource." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4984 }, "name": "policy", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype" }, "remarks": "Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.", "stability": "external", "summary": "The source of the API key for metering requests according to a usage plan." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4883 }, "name": "apiKeySourceType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes" }, "remarks": "By default, the RestApi supports only UTF-8-encoded text payloads.", "stability": "external", "summary": "The list of binary media types supported by the RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4890 }, "name": "binaryMediaTypes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location" }, "stability": "external", "summary": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4904 }, "name": "bodyS3Location", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.S3LocationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom" }, "stability": "external", "summary": "The ID of the RestApi that you want to clone from." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4911 }, "name": "cloneFrom", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description" }, "stability": "external", "summary": "The description of the RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4918 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint" }, "remarks": "By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint", "stability": "external", "summary": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4925 }, "name": "disableExecuteApiEndpoint", "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-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration" }, "remarks": "Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the `Parameters` property.", "stability": "external", "summary": "A list of the endpoint types of the API." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4932 }, "name": "endpointConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.EndpointConfigurationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings" }, "remarks": "The default value is `false` .", "stability": "external", "summary": "A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4939 }, "name": "failOnWarnings", "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-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize" }, "remarks": "When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.", "stability": "external", "summary": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4946 }, "name": "minimumCompressionSize", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode" }, "remarks": "The `Mode` determines how API Gateway handles resource updates.\n\nValid values are `overwrite` or `merge` .\n\nFor `overwrite` , the new API definition replaces the existing one. The existing API identifier remains unchanged.\n\nFor `merge` , the new API definition is merged with the existing API.\n\nIf you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is `overwrite` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.\n\nUse the default mode to define top-level `RestApi` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.", "stability": "external", "summary": "This property applies only when you use OpenAPI to define your REST API." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4963 }, "name": "mode", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name" }, "remarks": "A name is required if the REST API is not based on an OpenAPI specification.", "stability": "external", "summary": "The name of the RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4970 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters" }, "remarks": "For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'` .", "stability": "external", "summary": "Custom header parameters as part of the request." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4977 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnRestApi" }, "@aws-cdk/aws-apigateway.CfnRestApi.EndpointConfigurationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`EndpointConfiguration` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.", "stability": "external", "summary": "The `EndpointConfiguration` property type specifies the endpoint types of a REST API.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst endpointConfigurationProperty: apigateway.CfnRestApi.EndpointConfigurationProperty = {\n types: ['types'],\n vpcEndpointIds: ['vpcEndpointIds'],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.EndpointConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5069 }, "name": "EndpointConfigurationProperty", "namespace": "CfnRestApi", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types" }, "remarks": "For an edge-optimized API and its custom domain name, the endpoint type is `\"EDGE\"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` .", "stability": "external", "summary": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName)." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5075 }, "name": "types", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids" }, "remarks": "It is only supported for `PRIVATE` endpoint type.", "stability": "external", "summary": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5081 }, "name": "vpcEndpointIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnRestApi.EndpointConfigurationProperty" }, "@aws-cdk/aws-apigateway.CfnRestApi.S3LocationProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/) , becoming the foundation of the OpenAPI Specification.", "stability": "external", "summary": "`S3Location` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst s3LocationProperty: apigateway.CfnRestApi.S3LocationProperty = {\n bucket: 'bucket',\n eTag: 'eTag',\n key: 'key',\n version: 'version',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.S3LocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5147 }, "name": "S3LocationProperty", "namespace": "CfnRestApi", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket" }, "stability": "external", "summary": "The name of the S3 bucket where the OpenAPI file is stored." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5153 }, "name": "bucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag" }, "remarks": "If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.", "stability": "external", "summary": "The Amazon S3 ETag (a file checksum) of the OpenAPI file." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5159 }, "name": "eTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key" }, "stability": "external", "summary": "The file name of the OpenAPI file (Amazon S3 object name)." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5165 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version" }, "stability": "external", "summary": "For versioning-enabled buckets, a specific version of the OpenAPI file." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5171 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnRestApi.S3LocationProperty" }, "@aws-cdk/aws-apigateway.CfnRestApiProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRestApi`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const body: any;\ndeclare const policy: any;\nconst cfnRestApiProps: apigateway.CfnRestApiProps = {\n apiKeySourceType: 'apiKeySourceType',\n binaryMediaTypes: ['binaryMediaTypes'],\n body: body,\n bodyS3Location: {\n bucket: 'bucket',\n eTag: 'eTag',\n key: 'key',\n version: 'version',\n },\n cloneFrom: 'cloneFrom',\n description: 'description',\n disableExecuteApiEndpoint: false,\n endpointConfiguration: {\n types: ['types'],\n vpcEndpointIds: ['vpcEndpointIds'],\n },\n failOnWarnings: false,\n minimumCompressionSize: 123,\n mode: 'mode',\n name: 'name',\n parameters: {\n parametersKey: 'parameters',\n },\n policy: policy,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnRestApiProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4624 }, "name": "CfnRestApiProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype" }, "remarks": "Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.", "stability": "external", "summary": "The source of the API key for metering requests according to a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4631 }, "name": "apiKeySourceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes" }, "remarks": "By default, the RestApi supports only UTF-8-encoded text payloads.", "stability": "external", "summary": "The list of binary media types supported by the RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4638 }, "name": "binaryMediaTypes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body" }, "remarks": "For YAML templates, you can also provide the specification in YAML format.", "stability": "external", "summary": "An OpenAPI specification that defines a set of RESTful APIs in JSON format." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4645 }, "name": "body", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location" }, "stability": "external", "summary": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4652 }, "name": "bodyS3Location", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.S3LocationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom" }, "stability": "external", "summary": "The ID of the RestApi that you want to clone from." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4659 }, "name": "cloneFrom", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description" }, "stability": "external", "summary": "The description of the RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4666 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint" }, "remarks": "By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint", "stability": "external", "summary": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4673 }, "name": "disableExecuteApiEndpoint", "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-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration" }, "remarks": "Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the `Parameters` property.", "stability": "external", "summary": "A list of the endpoint types of the API." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4680 }, "name": "endpointConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnRestApi.EndpointConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings" }, "remarks": "The default value is `false` .", "stability": "external", "summary": "A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4687 }, "name": "failOnWarnings", "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-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize" }, "remarks": "When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.", "stability": "external", "summary": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4694 }, "name": "minimumCompressionSize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode" }, "remarks": "The `Mode` determines how API Gateway handles resource updates.\n\nValid values are `overwrite` or `merge` .\n\nFor `overwrite` , the new API definition replaces the existing one. The existing API identifier remains unchanged.\n\nFor `merge` , the new API definition is merged with the existing API.\n\nIf you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is `overwrite` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.\n\nUse the default mode to define top-level `RestApi` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.", "stability": "external", "summary": "This property applies only when you use OpenAPI to define your REST API." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4711 }, "name": "mode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name" }, "remarks": "A name is required if the REST API is not based on an OpenAPI specification.", "stability": "external", "summary": "The name of the RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4718 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters" }, "remarks": "For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'` .", "stability": "external", "summary": "Custom header parameters as part of the request." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4725 }, "name": "parameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy" }, "remarks": "To set the ARN for the policy, use the `!Join` intrinsic function with `\"\"` as delimiter and values of `\"execute-api:/\"` and `\"*\"` .", "stability": "external", "summary": "A policy document that contains the permissions for the `RestApi` resource." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4732 }, "name": "policy", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags" }, "remarks": "The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.", "stability": "external", "summary": "The key-value map of strings." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 4739 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnRestApiProps" }, "@aws-cdk/aws-apigateway.CfnRouteResponseV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::RouteResponse", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::RouteResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseModels: any;\ndeclare const responseParameters: any;\nconst cfnRouteResponseV2 = new apigateway.CfnRouteResponseV2(this, 'MyCfnRouteResponseV2', {\n apiId: 'apiId',\n routeId: 'routeId',\n routeResponseKey: 'routeResponseKey',\n\n // the properties below are optional\n modelSelectionExpression: 'modelSelectionExpression',\n responseModels: responseModels,\n responseParameters: responseParameters,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteResponseV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::RouteResponse`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2450 }, "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-apigateway.CfnRouteResponseV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2401 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2470 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2485 }, "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": "CfnRouteResponseV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2405 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2475 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2411 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ResponseModels`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2435 }, "name": "responseModels", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ResponseParameters`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2441 }, "name": "responseParameters", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.RouteId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2417 }, "name": "routeId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.RouteResponseKey`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2423 }, "name": "routeResponseKey", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2429 }, "name": "modelSelectionExpression", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnRouteResponseV2" }, "@aws-cdk/aws-apigateway.CfnRouteResponseV2.ParameterConstraintsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst parameterConstraintsProperty: apigateway.CfnRouteResponseV2.ParameterConstraintsProperty = {\n required: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteResponseV2.ParameterConstraintsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2499 }, "name": "ParameterConstraintsProperty", "namespace": "CfnRouteResponseV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html#cfn-apigatewayv2-routeresponse-parameterconstraints-required", "stability": "deprecated", "summary": "`CfnRouteResponseV2.ParameterConstraintsProperty.Required`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2504 }, "name": "required", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigatewayv2:CfnRouteResponseV2.ParameterConstraintsProperty" }, "@aws-cdk/aws-apigateway.CfnRouteResponseV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::RouteResponse`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseModels: any;\ndeclare const responseParameters: any;\nconst cfnRouteResponseV2Props: apigateway.CfnRouteResponseV2Props = {\n apiId: 'apiId',\n routeId: 'routeId',\n routeResponseKey: 'routeResponseKey',\n\n // the properties below are optional\n modelSelectionExpression: 'modelSelectionExpression',\n responseModels: responseModels,\n responseParameters: responseParameters,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteResponseV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2311 }, "name": "CfnRouteResponseV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2317 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.RouteId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2323 }, "name": "routeId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.RouteResponseKey`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2329 }, "name": "routeResponseKey", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2335 }, "name": "modelSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ResponseModels`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2341 }, "name": "responseModels", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::RouteResponse.ResponseParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2347 }, "name": "responseParameters", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/apigatewayv2:CfnRouteResponseV2Props" }, "@aws-cdk/aws-apigateway.CfnRouteV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Route", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Route`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const requestModels: any;\ndeclare const requestParameters: any;\nconst cfnRouteV2 = new apigateway.CfnRouteV2(this, 'MyCfnRouteV2', {\n apiId: 'apiId',\n routeKey: 'routeKey',\n\n // the properties below are optional\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: 'authorizationType',\n authorizerId: 'authorizerId',\n modelSelectionExpression: 'modelSelectionExpression',\n operationName: 'operationName',\n requestModels: requestModels,\n requestParameters: requestParameters,\n routeResponseSelectionExpression: 'routeResponseSelectionExpression',\n target: 'target',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Route`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2204 }, "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-apigateway.CfnRouteV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2119 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2229 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2250 }, "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": "CfnRouteV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2123 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2234 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2129 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RequestModels`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2177 }, "name": "requestModels", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RequestParameters`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2183 }, "name": "requestParameters", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RouteKey`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2135 }, "name": "routeKey", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ApiKeyRequired`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2141 }, "name": "apiKeyRequired", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizationScopes`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2147 }, "name": "authorizationScopes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizationType`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2153 }, "name": "authorizationType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizerId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2159 }, "name": "authorizerId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ModelSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2165 }, "name": "modelSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.OperationName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2171 }, "name": "operationName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2189 }, "name": "routeResponseSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.Target`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2195 }, "name": "target", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnRouteV2" }, "@aws-cdk/aws-apigateway.CfnRouteV2.ParameterConstraintsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst parameterConstraintsProperty: apigateway.CfnRouteV2.ParameterConstraintsProperty = {\n required: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteV2.ParameterConstraintsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2264 }, "name": "ParameterConstraintsProperty", "namespace": "CfnRouteV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html#cfn-apigatewayv2-route-parameterconstraints-required", "stability": "deprecated", "summary": "`CfnRouteV2.ParameterConstraintsProperty.Required`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2269 }, "name": "required", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigatewayv2:CfnRouteV2.ParameterConstraintsProperty" }, "@aws-cdk/aws-apigateway.CfnRouteV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Route`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const requestModels: any;\ndeclare const requestParameters: any;\nconst cfnRouteV2Props: apigateway.CfnRouteV2Props = {\n apiId: 'apiId',\n routeKey: 'routeKey',\n\n // the properties below are optional\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: 'authorizationType',\n authorizerId: 'authorizerId',\n modelSelectionExpression: 'modelSelectionExpression',\n operationName: 'operationName',\n requestModels: requestModels,\n requestParameters: requestParameters,\n routeResponseSelectionExpression: 'routeResponseSelectionExpression',\n target: 'target',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnRouteV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1982 }, "name": "CfnRouteV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1988 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RouteKey`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 1994 }, "name": "routeKey", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ApiKeyRequired`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2000 }, "name": "apiKeyRequired", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizationScopes`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2006 }, "name": "authorizationScopes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizationType`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2012 }, "name": "authorizationType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.AuthorizerId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2018 }, "name": "authorizerId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.ModelSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2024 }, "name": "modelSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.OperationName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2030 }, "name": "operationName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RequestModels`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2036 }, "name": "requestModels", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RequestParameters`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2042 }, "name": "requestParameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2048 }, "name": "routeResponseSelectionExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Route.Target`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2054 }, "name": "target", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnRouteV2Props" }, "@aws-cdk/aws-apigateway.CfnStage": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::Stage", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::Stage`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnStage = new apigateway.CfnStage(this, 'MyCfnStage', {\n restApiId: 'restApiId',\n\n // the properties below are optional\n accessLogSetting: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n canarySetting: {\n deploymentId: 'deploymentId',\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n clientCertificateId: 'clientCertificateId',\n deploymentId: 'deploymentId',\n description: 'description',\n documentationVersion: 'documentationVersion',\n methodSettings: [{\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n }],\n stageName: 'stageName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnStage", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::Stage`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5566 }, "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-apigateway.CfnStageProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5436 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5592 }, "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/apigateway.generated.ts", "line": 5616 }, "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": "CfnStage", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5440 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5597 }, "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-apigateway-stage.html#cfn-apigateway-stage-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5543 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5466 }, "name": "restApiId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting" }, "stability": "external", "summary": "Access log settings, including the access log format and access log destination ARN." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5473 }, "name": "accessLogSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.AccessLogSettingProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled" }, "stability": "external", "summary": "Specifies whether a cache cluster is enabled for the stage." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5480 }, "name": "cacheClusterEnabled", "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-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize" }, "remarks": "For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) .", "stability": "external", "summary": "The stage's cache capacity in GB." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5487 }, "name": "cacheClusterSize", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting" }, "stability": "external", "summary": "Settings for the canary deployment in this stage." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5494 }, "name": "canarySetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.CanarySettingProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid" }, "stability": "external", "summary": "The identifier of a client certificate for an API stage." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5501 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid" }, "stability": "external", "summary": "The identifier of the Deployment that the stage points to." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5508 }, "name": "deploymentId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description" }, "stability": "external", "summary": "The stage's description." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5515 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion" }, "stability": "external", "summary": "The version of the associated API documentation." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5522 }, "name": "documentationVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings" }, "remarks": "Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\\* /\\*` for overriding all methods in the stage.", "stability": "external", "summary": "A map that defines the method settings for a Stage resource." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5529 }, "name": "methodSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.MethodSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename" }, "remarks": "Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.", "stability": "external", "summary": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5536 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled" }, "stability": "external", "summary": "Specifies whether active tracing with X-ray is enabled for the Stage." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5550 }, "name": "tracingEnabled", "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-apigateway-stage.html#cfn-apigateway-stage-variables" }, "remarks": "Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .", "stability": "external", "summary": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5557 }, "name": "variables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnStage" }, "@aws-cdk/aws-apigateway.CfnStage.AccessLogSettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`AccessLogSetting` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.", "stability": "external", "summary": "The `AccessLogSetting` property type specifies settings for logging access in this stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst accessLogSettingProperty: apigateway.CfnStage.AccessLogSettingProperty = {\n destinationArn: 'destinationArn',\n format: 'format',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnStage.AccessLogSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5632 }, "name": "AccessLogSettingProperty", "namespace": "CfnStage", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn" }, "remarks": "If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` . This parameter is required to enable access logging.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5638 }, "name": "destinationArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format" }, "stability": "external", "summary": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least `$context.requestId` . This parameter is required to enable access logging." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5644 }, "name": "format", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnStage.AccessLogSettingProperty" }, "@aws-cdk/aws-apigateway.CfnStage.CanarySettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Configuration settings of a canary deployment.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst canarySettingProperty: apigateway.CfnStage.CanarySettingProperty = {\n deploymentId: 'deploymentId',\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnStage.CanarySettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5708 }, "name": "CanarySettingProperty", "namespace": "CfnStage", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid" }, "stability": "external", "summary": "The ID of the canary deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5714 }, "name": "deploymentId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic" }, "stability": "external", "summary": "The percent (0-100) of traffic diverted to a canary deployment." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5720 }, "name": "percentTraffic", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides" }, "remarks": "These stage variables are represented as a string-to-string map between stage variable names and their values.", "stability": "external", "summary": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5726 }, "name": "stageVariableOverrides", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache" }, "stability": "external", "summary": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5732 }, "name": "useStageCache", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/apigateway.generated:CfnStage.CanarySettingProperty" }, "@aws-cdk/aws-apigateway.CfnStage.MethodSettingProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.", "stability": "external", "summary": "The `MethodSetting` property type configures settings for all methods in a stage.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst methodSettingProperty: apigateway.CfnStage.MethodSettingProperty = {\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnStage.MethodSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5804 }, "name": "MethodSettingProperty", "namespace": "CfnStage", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted" }, "stability": "external", "summary": "Specifies whether the cached responses are encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5810 }, "name": "cacheDataEncrypted", "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-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds" }, "remarks": "The higher the TTL, the longer the response will be cached.", "stability": "external", "summary": "Specifies the time to live (TTL), in seconds, for cached responses." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5816 }, "name": "cacheTtlInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled" }, "remarks": "A cache cluster must be enabled on the stage for responses to be cached.", "stability": "external", "summary": "Specifies whether responses should be cached and returned for requests." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5822 }, "name": "cachingEnabled", "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-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled" }, "stability": "external", "summary": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5828 }, "name": "dataTraceEnabled", "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-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod" }, "remarks": "To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .", "stability": "external", "summary": "The HTTP method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5834 }, "name": "httpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel" }, "remarks": "Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events.", "stability": "external", "summary": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5840 }, "name": "loggingLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled" }, "stability": "external", "summary": "Specifies whether Amazon CloudWatch metrics are enabled for this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5846 }, "name": "metricsEnabled", "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-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath" }, "remarks": "Forward slashes ( `/` ) are encoded as `~1` and the initial slash must include a forward slash. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource` . To specify the root path, use only a slash ( `/` ). To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .", "stability": "external", "summary": "The resource path for this method." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5852 }, "name": "resourcePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit" }, "stability": "external", "summary": "Specifies the throttling burst limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5858 }, "name": "throttlingBurstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit" }, "stability": "external", "summary": "Specifies the throttling rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5864 }, "name": "throttlingRateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigateway.generated:CfnStage.MethodSettingProperty" }, "@aws-cdk/aws-apigateway.CfnStageProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnStage`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnStageProps: apigateway.CfnStageProps = {\n restApiId: 'restApiId',\n\n // the properties below are optional\n accessLogSetting: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n canarySetting: {\n deploymentId: 'deploymentId',\n percentTraffic: 123,\n stageVariableOverrides: {\n stageVariableOverridesKey: 'stageVariableOverrides',\n },\n useStageCache: false,\n },\n clientCertificateId: 'clientCertificateId',\n deploymentId: 'deploymentId',\n description: 'description',\n documentationVersion: 'documentationVersion',\n methodSettings: [{\n cacheDataEncrypted: false,\n cacheTtlInSeconds: 123,\n cachingEnabled: false,\n dataTraceEnabled: false,\n httpMethod: 'httpMethod',\n loggingLevel: 'loggingLevel',\n metricsEnabled: false,\n resourcePath: 'resourcePath',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n }],\n stageName: 'stageName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnStageProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5240 }, "name": "CfnStageProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid" }, "stability": "external", "summary": "The string identifier of the associated RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5247 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting" }, "stability": "external", "summary": "Access log settings, including the access log format and access log destination ARN." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5254 }, "name": "accessLogSetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.AccessLogSettingProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled" }, "stability": "external", "summary": "Specifies whether a cache cluster is enabled for the stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5261 }, "name": "cacheClusterEnabled", "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-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize" }, "remarks": "For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) .", "stability": "external", "summary": "The stage's cache capacity in GB." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5268 }, "name": "cacheClusterSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting" }, "stability": "external", "summary": "Settings for the canary deployment in this stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5275 }, "name": "canarySetting", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.CanarySettingProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid" }, "stability": "external", "summary": "The identifier of a client certificate for an API stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5282 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid" }, "stability": "external", "summary": "The identifier of the Deployment that the stage points to." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5289 }, "name": "deploymentId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description" }, "stability": "external", "summary": "The stage's description." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5296 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion" }, "stability": "external", "summary": "The version of the associated API documentation." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5303 }, "name": "documentationVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings" }, "remarks": "Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\\* /\\*` for overriding all methods in the stage.", "stability": "external", "summary": "A map that defines the method settings for a Stage resource." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5310 }, "name": "methodSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStage.MethodSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename" }, "remarks": "Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.", "stability": "external", "summary": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5317 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5324 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled" }, "stability": "external", "summary": "Specifies whether active tracing with X-ray is enabled for the Stage." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5331 }, "name": "tracingEnabled", "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-apigateway-stage.html#cfn-apigateway-stage-variables" }, "remarks": "Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .", "stability": "external", "summary": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5338 }, "name": "variables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnStageProps" }, "@aws-cdk/aws-apigateway.CfnStageV2": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGatewayV2::Stage", "exampleMetadata": "fixture=_generated" }, "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html", "stability": "deprecated", "summary": "A CloudFormation `AWS::ApiGatewayV2::Stage`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const routeSettings: any;\ndeclare const stageVariables: any;\ndeclare const tags: any;\nconst cfnStageV2 = new apigateway.CfnStageV2(this, 'MyCfnStageV2', {\n apiId: 'apiId',\n stageName: 'stageName',\n\n // the properties below are optional\n accessLogSettings: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n autoDeploy: false,\n clientCertificateId: 'clientCertificateId',\n defaultRouteSettings: {\n dataTraceEnabled: false,\n detailedMetricsEnabled: false,\n loggingLevel: 'loggingLevel',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n },\n deploymentId: 'deploymentId',\n description: 'description',\n routeSettings: routeSettings,\n stageVariables: stageVariables,\n tags: tags,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnStageV2", "initializer": { "docs": { "stability": "deprecated", "summary": "Create a new `AWS::ApiGatewayV2::Stage`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2754 }, "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-apigateway.CfnStageV2Props" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2675 }, "methods": [ { "docs": { "stability": "deprecated", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2778 }, "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": "deprecated" }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2798 }, "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": "CfnStageV2", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2679 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2783 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2745 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.ApiId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2685 }, "name": "apiId", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.RouteSettings`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2733 }, "name": "routeSettings", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.StageName`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2691 }, "name": "stageName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.StageVariables`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2739 }, "name": "stageVariables", "type": { "primitive": "any" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.AccessLogSettings`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2697 }, "name": "accessLogSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.AccessLogSettingsProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.AutoDeploy`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2703 }, "name": "autoDeploy", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.ClientCertificateId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2709 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2715 }, "name": "defaultRouteSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.RouteSettingsProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.DeploymentId`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2721 }, "name": "deploymentId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.Description`." }, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2727 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnStageV2" }, "@aws-cdk/aws-apigateway.CfnStageV2.AccessLogSettingsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst accessLogSettingsProperty: apigateway.CfnStageV2.AccessLogSettingsProperty = {\n destinationArn: 'destinationArn',\n format: 'format',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.AccessLogSettingsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2812 }, "name": "AccessLogSettingsProperty", "namespace": "CfnStageV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn", "stability": "deprecated", "summary": "`CfnStageV2.AccessLogSettingsProperty.DestinationArn`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2817 }, "name": "destinationArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format", "stability": "deprecated", "summary": "`CfnStageV2.AccessLogSettingsProperty.Format`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2822 }, "name": "format", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigatewayv2:CfnStageV2.AccessLogSettingsProperty" }, "@aws-cdk/aws-apigateway.CfnStageV2.RouteSettingsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html", "stability": "deprecated", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst routeSettingsProperty: apigateway.CfnStageV2.RouteSettingsProperty = {\n dataTraceEnabled: false,\n detailedMetricsEnabled: false,\n loggingLevel: 'loggingLevel',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.RouteSettingsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2867 }, "name": "RouteSettingsProperty", "namespace": "CfnStageV2", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled", "stability": "deprecated", "summary": "`CfnStageV2.RouteSettingsProperty.DataTraceEnabled`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2872 }, "name": "dataTraceEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled", "stability": "deprecated", "summary": "`CfnStageV2.RouteSettingsProperty.DetailedMetricsEnabled`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2877 }, "name": "detailedMetricsEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel", "stability": "deprecated", "summary": "`CfnStageV2.RouteSettingsProperty.LoggingLevel`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2882 }, "name": "loggingLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit", "stability": "deprecated", "summary": "`CfnStageV2.RouteSettingsProperty.ThrottlingBurstLimit`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2887 }, "name": "throttlingBurstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit", "stability": "deprecated", "summary": "`CfnStageV2.RouteSettingsProperty.ThrottlingRateLimit`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2892 }, "name": "throttlingRateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigatewayv2:CfnStageV2.RouteSettingsProperty" }, "@aws-cdk/aws-apigateway.CfnStageV2Props": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "moved to package aws-apigatewayv2", "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html", "stability": "deprecated", "summary": "Properties for defining a `AWS::ApiGatewayV2::Stage`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const routeSettings: any;\ndeclare const stageVariables: any;\ndeclare const tags: any;\nconst cfnStageV2Props: apigateway.CfnStageV2Props = {\n apiId: 'apiId',\n stageName: 'stageName',\n\n // the properties below are optional\n accessLogSettings: {\n destinationArn: 'destinationArn',\n format: 'format',\n },\n autoDeploy: false,\n clientCertificateId: 'clientCertificateId',\n defaultRouteSettings: {\n dataTraceEnabled: false,\n detailedMetricsEnabled: false,\n loggingLevel: 'loggingLevel',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n },\n deploymentId: 'deploymentId',\n description: 'description',\n routeSettings: routeSettings,\n stageVariables: stageVariables,\n tags: tags,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.CfnStageV2Props", "kind": "interface", "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2546 }, "name": "CfnStageV2Props", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.ApiId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2552 }, "name": "apiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.StageName`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2558 }, "name": "stageName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.AccessLogSettings`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2564 }, "name": "accessLogSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.AccessLogSettingsProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.AutoDeploy`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2570 }, "name": "autoDeploy", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.ClientCertificateId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2576 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2582 }, "name": "defaultRouteSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnStageV2.RouteSettingsProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.DeploymentId`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2588 }, "name": "deploymentId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2594 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.RouteSettings`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2600 }, "name": "routeSettings", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.StageVariables`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2606 }, "name": "stageVariables", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags", "stability": "deprecated", "summary": "`AWS::ApiGatewayV2::Stage.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/apigatewayv2.ts", "line": 2612 }, "name": "tags", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/apigatewayv2:CfnStageV2Props" }, "@aws-cdk/aws-apigateway.CfnUsagePlan": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::UsagePlan", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide* .\n\nIn some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::UsagePlan`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnUsagePlan = new apigateway.CfnUsagePlan(this, 'MyCfnUsagePlan', /* all optional props */ {\n apiStages: [{\n apiId: 'apiId',\n stage: 'stage',\n throttle: {\n throttleKey: {\n burstLimit: 123,\n rateLimit: 123,\n },\n },\n }],\n description: 'description',\n quota: {\n limit: 123,\n offset: 123,\n period: 'period',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n throttle: {\n burstLimit: 123,\n rateLimit: 123,\n },\n usagePlanName: 'usagePlanName',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::UsagePlan`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6148 }, "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", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlanProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6068 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6166 }, "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/apigateway.generated.ts", "line": 6182 }, "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": "CfnUsagePlan", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6072 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6097 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6171 }, "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-apigateway-usageplan.html#cfn-apigateway-usageplan-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6125 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages" }, "stability": "external", "summary": "The associated API stages of a usage plan." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6104 }, "name": "apiStages", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ApiStageProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description" }, "stability": "external", "summary": "The description of a usage plan." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6111 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota" }, "stability": "external", "summary": "The target maximum number of permitted requests per a given unit time interval." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6118 }, "name": "quota", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.QuotaSettingsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle" }, "stability": "external", "summary": "A map containing method level throttling information for API stage in a usage plan." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6132 }, "name": "throttle", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ThrottleSettingsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname" }, "stability": "external", "summary": "The name of a usage plan." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6139 }, "name": "usagePlanName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlan" }, "@aws-cdk/aws-apigateway.CfnUsagePlan.ApiStageProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "API stage name of the associated API stage in a usage plan.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst apiStageProperty: apigateway.CfnUsagePlan.ApiStageProperty = {\n apiId: 'apiId',\n stage: 'stage',\n throttle: {\n throttleKey: {\n burstLimit: 123,\n rateLimit: 123,\n },\n },\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ApiStageProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6196 }, "name": "ApiStageProperty", "namespace": "CfnUsagePlan", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid" }, "stability": "external", "summary": "API Id of the associated API stage in a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6202 }, "name": "apiId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage" }, "stability": "external", "summary": "API stage name of the associated API stage in a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6208 }, "name": "stage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle" }, "stability": "external", "summary": "Map containing method level throttling information for API stage in a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6214 }, "name": "throttle", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ThrottleSettingsProperty" } ] } }, "kind": "map" } } ] } } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlan.ApiStageProperty" }, "@aws-cdk/aws-apigateway.CfnUsagePlan.QuotaSettingsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html", "exampleMetadata": "fixture=_generated" }, "remarks": "In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.", "stability": "external", "summary": "`QuotaSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst quotaSettingsProperty: apigateway.CfnUsagePlan.QuotaSettingsProperty = {\n limit: 123,\n offset: 123,\n period: 'period',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.QuotaSettingsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6283 }, "name": "QuotaSettingsProperty", "namespace": "CfnUsagePlan", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit" }, "stability": "external", "summary": "The target maximum number of requests that can be made in a given time period." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6289 }, "name": "limit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset" }, "stability": "external", "summary": "The number of requests subtracted from the given limit in the initial time period." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6295 }, "name": "offset", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period" }, "remarks": "Valid values are \"DAY\", \"WEEK\" or \"MONTH\".", "stability": "external", "summary": "The time period in which the limit applies." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6301 }, "name": "period", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlan.QuotaSettingsProperty" }, "@aws-cdk/aws-apigateway.CfnUsagePlan.ThrottleSettingsProperty": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`ThrottleSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst throttleSettingsProperty: apigateway.CfnUsagePlan.ThrottleSettingsProperty = {\n burstLimit: 123,\n rateLimit: 123,\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ThrottleSettingsProperty", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6368 }, "name": "ThrottleSettingsProperty", "namespace": "CfnUsagePlan", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit" }, "remarks": "This allows more requests through for a period of time than the target rate limit.", "stability": "external", "summary": "The API target request burst rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6374 }, "name": "burstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit" }, "stability": "external", "summary": "The API target request rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6380 }, "name": "rateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlan.ThrottleSettingsProperty" }, "@aws-cdk/aws-apigateway.CfnUsagePlanKey": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::UsagePlanKey", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::UsagePlanKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnUsagePlanKey = new apigateway.CfnUsagePlanKey(this, 'MyCfnUsagePlanKey', {\n keyId: 'keyId',\n keyType: 'keyType',\n usagePlanId: 'usagePlanId',\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlanKey", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::UsagePlanKey`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6590 }, "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-apigateway.CfnUsagePlanKeyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6531 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6608 }, "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/apigateway.generated.ts", "line": 6621 }, "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": "CfnUsagePlanKey", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6535 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Id" }, "remarks": "For example: `abc123` .", "stability": "external", "summary": "The ID for the usage plan key." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6560 }, "name": "attrId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6613 }, "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-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid" }, "stability": "external", "summary": "The Id of the UsagePlanKey resource to be deleted." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6567 }, "name": "keyId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype" }, "stability": "external", "summary": "The type of a UsagePlanKey resource for a plan customer." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6574 }, "name": "keyType", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid" }, "stability": "external", "summary": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6581 }, "name": "usagePlanId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlanKey" }, "@aws-cdk/aws-apigateway.CfnUsagePlanKeyProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnUsagePlanKey`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnUsagePlanKeyProps: apigateway.CfnUsagePlanKeyProps = {\n keyId: 'keyId',\n keyType: 'keyType',\n usagePlanId: 'usagePlanId',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlanKeyProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6443 }, "name": "CfnUsagePlanKeyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid" }, "stability": "external", "summary": "The Id of the UsagePlanKey resource to be deleted." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6450 }, "name": "keyId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype" }, "stability": "external", "summary": "The type of a UsagePlanKey resource for a plan customer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6457 }, "name": "keyType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid" }, "stability": "external", "summary": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6464 }, "name": "usagePlanId", "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlanKeyProps" }, "@aws-cdk/aws-apigateway.CfnUsagePlanProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnUsagePlan`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnUsagePlanProps: apigateway.CfnUsagePlanProps = {\n apiStages: [{\n apiId: 'apiId',\n stage: 'stage',\n throttle: {\n throttleKey: {\n burstLimit: 123,\n rateLimit: 123,\n },\n },\n }],\n description: 'description',\n quota: {\n limit: 123,\n offset: 123,\n period: 'period',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n throttle: {\n burstLimit: 123,\n rateLimit: 123,\n },\n usagePlanName: 'usagePlanName',\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlanProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5951 }, "name": "CfnUsagePlanProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages" }, "stability": "external", "summary": "The associated API stages of a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5958 }, "name": "apiStages", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ApiStageProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description" }, "stability": "external", "summary": "The description of a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5965 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota" }, "stability": "external", "summary": "The target maximum number of permitted requests per a given unit time interval." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5972 }, "name": "quota", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.QuotaSettingsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags" }, "remarks": "Each tag element is associated with a given resource.", "stability": "external", "summary": "The collection of tags." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5979 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle" }, "stability": "external", "summary": "A map containing method level throttling information for API stage in a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5986 }, "name": "throttle", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-apigateway.CfnUsagePlan.ThrottleSettingsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname" }, "stability": "external", "summary": "The name of a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 5993 }, "name": "usagePlanName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnUsagePlanProps" }, "@aws-cdk/aws-apigateway.CfnVpcLink": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::ApiGateway::VpcLink", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the `Amazon API Gateway REST API Reference` .", "stability": "external", "summary": "A CloudFormation `AWS::ApiGateway::VpcLink`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnVpcLink = new apigateway.CfnVpcLink(this, 'MyCfnVpcLink', {\n name: 'name',\n targetArns: ['targetArns'],\n\n // the properties below are optional\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-apigateway.CfnVpcLink", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::ApiGateway::VpcLink`." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6797 }, "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-apigateway.CfnVpcLinkProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6731 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6815 }, "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/apigateway.generated.ts", "line": 6829 }, "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": "CfnVpcLink", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6735 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "VpcLinkId" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6760 }, "name": "attrVpcLinkId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6820 }, "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-apigateway-vpclink.html#cfn-apigateway-vpclink-tags" }, "stability": "external", "summary": "An array of arbitrary tags (key-value pairs) to associate with the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6788 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name" }, "stability": "external", "summary": "The name used to label and identify the VPC link." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6767 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns" }, "remarks": "The network load balancer must be owned by the same AWS account of the API owner.", "stability": "external", "summary": "The ARN of the network load balancer of the VPC targeted by the VPC link." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6774 }, "name": "targetArns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description" }, "stability": "external", "summary": "The description of the VPC link." }, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6781 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/apigateway.generated:CfnVpcLink" }, "@aws-cdk/aws-apigateway.CfnVpcLinkProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnVpcLink`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst cfnVpcLinkProps: apigateway.CfnVpcLinkProps = {\n name: 'name',\n targetArns: ['targetArns'],\n\n // the properties below are optional\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-apigateway.CfnVpcLinkProps", "kind": "interface", "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6634 }, "name": "CfnVpcLinkProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name" }, "stability": "external", "summary": "The name used to label and identify the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6641 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns" }, "remarks": "The network load balancer must be owned by the same AWS account of the API owner.", "stability": "external", "summary": "The ARN of the network load balancer of the VPC targeted by the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6648 }, "name": "targetArns", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description" }, "stability": "external", "summary": "The description of the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6655 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags" }, "stability": "external", "summary": "An array of arbitrary tags (key-value pairs) to associate with the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/apigateway.generated.ts", "line": 6662 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/apigateway.generated:CfnVpcLinkProps" }, "@aws-cdk/aws-apigateway.CognitoUserPoolsAuthorizer": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Authorizer", "docs": { "custom": { "resource": "AWS::ApiGateway::Authorizer", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Cognito user pools based custom authorizer.", "example": "const userPool = new cognito.UserPool(this, 'UserPool');\n\nconst auth = new apigateway.CognitoUserPoolsAuthorizer(this, 'booksAuthorizer', {\n cognitoUserPools: [userPool]\n});\n\ndeclare const books: apigateway.Resource;\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth,\n authorizationType: apigateway.AuthorizationType.COGNITO,\n});" }, "fqn": "@aws-cdk/aws-apigateway.CognitoUserPoolsAuthorizer", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 67 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.CognitoUserPoolsAuthorizerProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IAuthorizer" ], "kind": "class", "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 47 }, "name": "CognitoUserPoolsAuthorizer", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 58 }, "name": "authorizerArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The id of the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 52 }, "name": "authorizerId", "overrides": "@aws-cdk/aws-apigateway.Authorizer", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The authorization type of this authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 63 }, "name": "authorizationType", "optional": true, "overrides": "@aws-cdk/aws-apigateway.Authorizer", "type": { "fqn": "@aws-cdk/aws-apigateway.AuthorizationType" } } ], "symbolId": "lib/authorizers/cognito:CognitoUserPoolsAuthorizer" }, "@aws-cdk/aws-apigateway.CognitoUserPoolsAuthorizerProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for CognitoUserPoolsAuthorizer.", "example": "const userPool = new cognito.UserPool(this, 'UserPool');\n\nconst auth = new apigateway.CognitoUserPoolsAuthorizer(this, 'booksAuthorizer', {\n cognitoUserPools: [userPool]\n});\n\ndeclare const books: apigateway.Resource;\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth,\n authorizationType: apigateway.AuthorizationType.COGNITO,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.CognitoUserPoolsAuthorizerProps", "kind": "interface", "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 12 }, "name": "CognitoUserPoolsAuthorizerProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The user pools to associate with this authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 23 }, "name": "cognitoUserPools", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-cognito.IUserPool" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the unique construct ID", "remarks": "Note that, this is not the primary identifier of the authorizer.", "stability": "stable", "summary": "An optional human friendly name for the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 18 }, "name": "authorizerName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "`IdentitySource.header('Authorization')`", "remarks": "This is typically passed as part of the header, in which case\nthis should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.", "see": "https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource", "stability": "stable", "summary": "The request header mapping expression for the bearer token." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 39 }, "name": "identitySource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Duration.minutes(5)", "remarks": "Max 1 hour.\nDisable caching by setting this to 0.", "stability": "stable", "summary": "How long APIGateway should cache the results." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/cognito.ts", "line": 31 }, "name": "resultsCacheTtl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/authorizers/cognito:CognitoUserPoolsAuthorizerProps" }, "@aws-cdk/aws-apigateway.ConnectionType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ConnectionType", "kind": "enum", "locationInModule": { "filename": "lib/integration.ts", "line": 319 }, "members": [ { "docs": { "stability": "stable", "summary": "For connections through the public routable internet." }, "name": "INTERNET" }, { "docs": { "stability": "stable", "summary": "For private connections between API Gateway and a network load balancer in a VPC." }, "name": "VPC_LINK" } ], "name": "ConnectionType", "symbolId": "lib/integration:ConnectionType" }, "@aws-cdk/aws-apigateway.ContentHandling": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "declare const getBookHandler: lambda.Function;\ndeclare const getBookIntegration: apigateway.LambdaIntegration;\n\nconst getBookIntegration = new apigateway.LambdaIntegration(getBookHandler, {\n contentHandling: apigateway.ContentHandling.CONVERT_TO_TEXT, // convert to base64\n credentialsPassthrough: true, // use caller identity to invoke the function\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ContentHandling", "kind": "enum", "locationInModule": { "filename": "lib/integration.ts", "line": 248 }, "members": [ { "docs": { "stability": "stable", "summary": "Converts a request payload from a base64-encoded string to a binary blob." }, "name": "CONVERT_TO_BINARY" }, { "docs": { "stability": "stable", "summary": "Converts a request payload from a binary blob to a base64-encoded string." }, "name": "CONVERT_TO_TEXT" } ], "name": "ContentHandling", "symbolId": "lib/integration:ContentHandling" }, "@aws-cdk/aws-apigateway.Cors": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "new apigateway.RestApi(this, 'api', {\n defaultCorsPreflightOptions: {\n allowOrigins: apigateway.Cors.ALL_ORIGINS,\n allowMethods: apigateway.Cors.ALL_METHODS // this is also the default\n }\n})", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Cors", "kind": "class", "locationInModule": { "filename": "lib/cors.ts", "line": 98 }, "name": "Cors", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "All HTTP methods." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 102 }, "name": "ALL_METHODS", "static": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "const": true, "docs": { "stability": "stable", "summary": "All origins." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 107 }, "name": "ALL_ORIGINS", "static": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "const": true, "docs": { "stability": "stable", "summary": "The set of default headers allowed for CORS and useful for API Gateway." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 112 }, "name": "DEFAULT_HEADERS", "static": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/cors:Cors" }, "@aws-cdk/aws-apigateway.CorsOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const myResource: apigateway.Resource;\n\nmyResource.addCorsPreflight({\n allowOrigins: [ 'https://amazon.com' ],\n allowMethods: [ 'GET', 'PUT' ]\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.CorsOptions", "kind": "interface", "locationInModule": { "filename": "lib/cors.ts", "line": 4 }, "name": "CorsOptions", "properties": [ { "abstract": true, "docs": { "remarks": "If you wish to allow all origins, specify `Cors.ALL_ORIGINS` or\n`[ * ]`.\n\nResponses will include the `Access-Control-Allow-Origin` response header.\nIf `Cors.ALL_ORIGINS` is specified, the `Vary: Origin` response header will\nalso be included.", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin", "stability": "stable", "summary": "Specifies the list of origins that are allowed to make requests to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 23 }, "name": "allowOrigins", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "When a request's credentials mode (Request.credentials) is \"include\",\nbrowsers will only expose the response to frontend JavaScript code if the\nAccess-Control-Allow-Credentials value is true.\n\nCredentials are cookies, authorization headers or TLS client certificates.", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials", "stability": "stable", "summary": "The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to frontend JavaScript code when the request's credentials mode (Request.credentials) is \"include\"." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 59 }, "name": "allowCredentials", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "Cors.DEFAULT_HEADERS", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers", "stability": "stable", "summary": "The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 33 }, "name": "allowHeaders", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "Cors.ALL_METHODS", "remarks": "If `ANY` is specified, it will be expanded to `Cors.ALL_METHODS`.", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods", "stability": "stable", "summary": "The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 44 }, "name": "allowMethods", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- cache is enabled", "remarks": "This option cannot be used with `maxAge`.", "stability": "stable", "summary": "Sets Access-Control-Max-Age to -1, which means that caching is disabled." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 80 }, "name": "disableCache", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- only the 6 CORS-safelisted response headers are exposed:\nCache-Control, Content-Language, Content-Type, Expires, Last-Modified,\nPragma", "remarks": "If you want clients to be able to access other headers, you have to list\nthem using the Access-Control-Expose-Headers header.", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers", "stability": "stable", "summary": "The Access-Control-Expose-Headers response header indicates which headers can be exposed as part of the response by listing their names." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 95 }, "name": "exposeHeaders", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- browser-specific (see reference)", "remarks": "To disable caching altogether use `disableCache: true`.", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age", "stability": "stable", "summary": "The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 72 }, "name": "maxAge", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "204", "stability": "stable", "summary": "Specifies the response status code returned from the OPTIONS method." }, "immutable": true, "locationInModule": { "filename": "lib/cors.ts", "line": 10 }, "name": "statusCode", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/cors:CorsOptions" }, "@aws-cdk/aws-apigateway.Deployment": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "remarks": "An immutable representation of a RestApi resource that can be called by users\nusing Stages. A deployment must be associated with a Stage for it to be\ncallable over the Internet.\n\nNormally, you don't need to define deployments manually. The RestApi\nconstruct manages a Deployment resource that represents the latest model. It\ncan be accessed through `restApi.latestDeployment` (unless `deploy: false` is\nset when defining the `RestApi`).\n\nIf you manually define this resource, you will need to know that since\ndeployments are immutable, as long as the resource's logical ID doesn't\nchange, the deployment will represent the snapshot in time in which the\nresource was created. This means that if you modify the RestApi model (i.e.\nadd methods or resources), these changes will not be reflected unless a new\ndeployment resource is created.\n\nTo achieve this behavior, the method `addToLogicalId(data)` can be used to\naugment the logical ID generated for the deployment resource such that it\nwill include arbitrary data. This is done automatically for the\n`restApi.latestDeployment` deployment.\n\nFurthermore, since a deployment does not reference any of the REST API\nresources and methods, CloudFormation will likely provision it before these\nresources are created, which means that it will represent a \"half-baked\"\nmodel. Use the `node.addDependency(dep)` method to circumvent that. This is done\nautomatically for the `restApi.latestDeployment` deployment.", "stability": "stable", "summary": "A Deployment of a REST API.", "example": "// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Deployment", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/deployment.ts", "line": 72 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.DeploymentProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/deployment.ts", "line": 65 }, "methods": [ { "docs": { "remarks": "This should be called by constructs of the API Gateway model that want to\ninvalidate the deployment when their settings change. The component will\nbe resolve()ed during synthesis so tokens are welcome.", "stability": "stable", "summary": "Adds a component to the hash that determines this Deployment resource's logical ID." }, "locationInModule": { "filename": "lib/deployment.ts", "line": 100 }, "name": "addToLogicalId", "parameters": [ { "name": "data", "type": { "primitive": "any" } } ] } ], "name": "Deployment", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/deployment.ts", "line": 68 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/deployment.ts", "line": 67 }, "name": "deploymentId", "type": { "primitive": "string" } } ], "symbolId": "lib/deployment:Deployment" }, "@aws-cdk/aws-apigateway.DeploymentProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.DeploymentProps", "kind": "interface", "locationInModule": { "filename": "lib/deployment.ts", "line": 12 }, "name": "DeploymentProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Rest API to deploy." }, "immutable": true, "locationInModule": { "filename": "lib/deployment.ts", "line": 16 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "A description of the purpose of the API Gateway deployment." }, "immutable": true, "locationInModule": { "filename": "lib/deployment.ts", "line": 23 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "If this is true, the old API Gateway Deployment resource will not be deleted.\nThis will allow manually reverting back to a previous deployment in case for example", "stability": "stable", "summary": "When an API Gateway model is updated, a new deployment will automatically be created." }, "immutable": true, "locationInModule": { "filename": "lib/deployment.ts", "line": 32 }, "name": "retainDeployments", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/deployment:DeploymentProps" }, "@aws-cdk/aws-apigateway.DomainName": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "declare const acm: any;\n\nnew apigateway.DomainName(this, 'domain-name', {\n domainName: 'example.com',\n certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),\n mtls: {\n bucket: new s3.Bucket(this, 'bucket'),\n key: 'truststore.pem',\n version: 'version',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.DomainName", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/domain-name.ts", "line": 119 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.DomainNameProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IDomainName" ], "kind": "class", "locationInModule": { "filename": "lib/domain-name.ts", "line": 99 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing domain name." }, "locationInModule": { "filename": "lib/domain-name.ts", "line": 104 }, "name": "fromDomainNameAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-apigateway.DomainNameAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IDomainName" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Maps this domain to an API endpoint." }, "locationInModule": { "filename": "lib/domain-name.ts", "line": 161 }, "name": "addBasePathMapping", "parameters": [ { "docs": { "summary": "That target API endpoint, requests will be mapped to the deployment stage." }, "name": "targetApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "docs": { "summary": "Options for mapping to base path with or without a stage." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.BasePathMappingOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.BasePathMapping" } } } ], "name": "DomainName", "properties": [ { "docs": { "stability": "stable", "summary": "The domain name (e.g. `example.com`)." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 114 }, "name": "domainName", "overrides": "@aws-cdk/aws-apigateway.IDomainName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The Route53 alias target to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 115 }, "name": "domainNameAliasDomainName", "overrides": "@aws-cdk/aws-apigateway.IDomainName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 116 }, "name": "domainNameAliasHostedZoneId", "overrides": "@aws-cdk/aws-apigateway.IDomainName", "type": { "primitive": "string" } } ], "symbolId": "lib/domain-name:DomainName" }, "@aws-cdk/aws-apigateway.DomainNameAttributes": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst domainNameAttributes: apigateway.DomainNameAttributes = {\n domainName: 'domainName',\n domainNameAliasHostedZoneId: 'domainNameAliasHostedZoneId',\n domainNameAliasTarget: 'domainNameAliasTarget',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.DomainNameAttributes", "kind": "interface", "locationInModule": { "filename": "lib/domain-name.ts", "line": 184 }, "name": "DomainNameAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain name (e.g. `example.com`)." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 188 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 198 }, "name": "domainNameAliasHostedZoneId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The Route53 alias target to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 193 }, "name": "domainNameAliasTarget", "type": { "primitive": "string" } } ], "symbolId": "lib/domain-name:DomainNameAttributes" }, "@aws-cdk/aws-apigateway.DomainNameOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const acmCertificateForExampleCom: any;\n\nconst api = new apigateway.RestApi(this, 'MyDomain', {\n domainName: {\n domainName: 'example.com',\n certificate: acmCertificateForExampleCom,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.DomainNameOptions", "kind": "interface", "locationInModule": { "filename": "lib/domain-name.ts", "line": 20 }, "name": "DomainNameOptions", "properties": [ { "abstract": true, "docs": { "remarks": "For \"EDGE\" domain names, the certificate\nneeds to be in the US East (N. Virginia) region.", "stability": "stable", "summary": "The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 31 }, "name": "certificate", "type": { "fqn": "@aws-cdk/aws-certificatemanager.ICertificate" } }, { "abstract": true, "docs": { "remarks": "Uppercase letters are not supported.", "stability": "stable", "summary": "The custom domain name for your API." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 24 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- map requests from the domain root (e.g. `example.com`). If this\nis undefined, no additional mappings will be allowed on this domain name.", "stability": "stable", "summary": "The base path name that callers of the API must provide in the URL after the domain name (e.g. `example.com/base-path`). If you specify this property, it can't be an empty string." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 60 }, "name": "basePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "REGIONAL", "stability": "stable", "summary": "The type of endpoint for this DomainName." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 37 }, "name": "endpointType", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.EndpointType" } }, { "abstract": true, "docs": { "default": "- mTLS is not configured.", "stability": "stable", "summary": "The mutual TLS authentication configuration for a custom domain name." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 50 }, "name": "mtls", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MTLSConfig" } }, { "abstract": true, "docs": { "default": "SecurityPolicy.TLS_1_0", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html", "stability": "stable", "summary": "The Transport Layer Security (TLS) version + cipher suite for this domain name." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 44 }, "name": "securityPolicy", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.SecurityPolicy" } } ], "symbolId": "lib/domain-name:DomainNameOptions" }, "@aws-cdk/aws-apigateway.DomainNameProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const acm: any;\n\nnew apigateway.DomainName(this, 'domain-name', {\n domainName: 'example.com',\n certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),\n mtls: {\n bucket: new s3.Bucket(this, 'bucket'),\n key: 'truststore.pem',\n version: 'version',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.DomainNameProps", "interfaces": [ "@aws-cdk/aws-apigateway.DomainNameOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/domain-name.ts", "line": 63 }, "name": "DomainNameProps", "properties": [ { "abstract": true, "docs": { "default": "- you will have to call `addBasePathMapping` to map this domain to\nAPI endpoints.", "remarks": "If you wish to map this domain to multiple APIs\nwith different base paths, don't specify this option and use\n`addBasePathMapping`.", "stability": "stable", "summary": "If specified, all requests to this domain will be mapped to the production deployment of this API." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 73 }, "name": "mapping", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/domain-name:DomainNameProps" }, "@aws-cdk/aws-apigateway.EmptyModel": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "deprecated": "You should use Model.EMPTY_MODEL", "remarks": "This can be used for mapping\nJSON responses from an integration to what is returned to a client,\nwhere strong typing is not required. In the absence of any defined\nmodel, the Empty model will be used to return the response payload\nunmapped.\n\nDefinition\n{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}", "see": "https://docs.amazonaws.cn/en_us/apigateway/latest/developerguide/models-mappings.html#models-mappings-models", "stability": "deprecated", "summary": "Represents a reference to a REST API's Empty model, which is available as part of the model collection by default.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst emptyModel = new apigateway.EmptyModel();", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.EmptyModel", "initializer": { "docs": { "stability": "stable" } }, "interfaces": [ "@aws-cdk/aws-apigateway.IModel" ], "kind": "class", "locationInModule": { "filename": "lib/model.ts", "line": 35 }, "name": "EmptyModel", "properties": [ { "docs": { "stability": "deprecated", "summary": "Returns the model name, such as 'myModel'." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 36 }, "name": "modelId", "overrides": "@aws-cdk/aws-apigateway.IModel", "type": { "primitive": "string" } } ], "symbolId": "lib/model:EmptyModel" }, "@aws-cdk/aws-apigateway.EndpointConfiguration": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "remarks": "EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.", "stability": "stable", "summary": "The endpoint configuration of a REST API, including VPCs and endpoint types.", "example": "const api = new apigateway.RestApi(this, 'api', {\n endpointConfiguration: {\n types: [ apigateway.EndpointType.EDGE ]\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.EndpointConfiguration", "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 848 }, "name": "EndpointConfiguration", "properties": [ { "abstract": true, "docs": { "default": "EndpointType.EDGE", "stability": "stable", "summary": "A list of endpoint types of an API or its custom domain name." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 854 }, "name": "types", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.EndpointType" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no ALIASes are created for the endpoint.", "stability": "stable", "summary": "A list of VPC Endpoints against which to create Route53 ALIASes." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 861 }, "name": "vpcEndpoints", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.IVpcEndpoint" }, "kind": "array" } } } ], "symbolId": "lib/restapi:EndpointConfiguration" }, "@aws-cdk/aws-apigateway.EndpointType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "declare const apiDefinition: apigateway.ApiDefinition;\n\nconst api = new apigateway.SpecRestApi(this, 'ExampleRestApi', {\n apiDefinition,\n endpointTypes: [apigateway.EndpointType.PRIVATE]\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.EndpointType", "kind": "enum", "locationInModule": { "filename": "lib/restapi.ts", "line": 876 }, "members": [ { "docs": { "stability": "stable", "summary": "For an edge-optimized API and its custom domain name." }, "name": "EDGE" }, { "docs": { "stability": "stable", "summary": "For a regional API and its custom domain name." }, "name": "REGIONAL" }, { "docs": { "stability": "stable", "summary": "For a private API and its custom domain name." }, "name": "PRIVATE" } ], "name": "EndpointType", "symbolId": "lib/restapi:EndpointType" }, "@aws-cdk/aws-apigateway.ErrorModel": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "deprecated": "You should use Model.ERROR_MODEL", "remarks": "This can be used for mapping\nerror JSON responses from an integration to a client, where a simple\ngeneric message field is sufficient to map and return an error payload.\n\nDefinition\n{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Error Schema\",\n \"type\" : \"object\",\n \"properties\" : {\n \"message\" : { \"type\" : \"string\" }\n }\n}", "stability": "deprecated", "summary": "Represents a reference to a REST API's Error model, which is available as part of the model collection by default.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst errorModel = new apigateway.ErrorModel();", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ErrorModel", "initializer": { "docs": { "stability": "stable" } }, "interfaces": [ "@aws-cdk/aws-apigateway.IModel" ], "kind": "class", "locationInModule": { "filename": "lib/model.ts", "line": 56 }, "name": "ErrorModel", "properties": [ { "docs": { "stability": "deprecated", "summary": "Returns the model name, such as 'myModel'." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 57 }, "name": "modelId", "overrides": "@aws-cdk/aws-apigateway.IModel", "type": { "primitive": "string" } } ], "symbolId": "lib/model:ErrorModel" }, "@aws-cdk/aws-apigateway.GatewayResponse": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::ApiGateway::GatewayResponse", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "Configure the response received by clients, produced from the API Gateway backend.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseType: apigateway.ResponseType;\ndeclare const restApi: apigateway.RestApi;\nconst gatewayResponse = new apigateway.GatewayResponse(this, 'MyGatewayResponse', {\n restApi: restApi,\n type: responseType,\n\n // the properties below are optional\n responseHeaders: {\n responseHeadersKey: 'responseHeaders',\n },\n statusCode: 'statusCode',\n templates: {\n templatesKey: 'templates',\n },\n});" }, "fqn": "@aws-cdk/aws-apigateway.GatewayResponse", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 58 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.GatewayResponseProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IGatewayResponse" ], "kind": "class", "locationInModule": { "filename": "lib/gateway-response.ts", "line": 57 }, "name": "GatewayResponse", "symbolId": "lib/gateway-response:GatewayResponse" }, "@aws-cdk/aws-apigateway.GatewayResponseOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Options to add gateway response.", "example": "const api = new apigateway.RestApi(this, 'books-api');\napi.addGatewayResponse('test-response', {\n type: apigateway.ResponseType.ACCESS_DENIED,\n statusCode: '500',\n responseHeaders: {\n 'Access-Control-Allow-Origin': \"test.com\",\n 'test-key': 'test-value'\n },\n templates: {\n 'application/json': '{ \"message\": $context.error.messageString, \"statusCode\": \"488\", \"type\": \"$context.error.responseType\" }'\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.GatewayResponseOptions", "kind": "interface", "locationInModule": { "filename": "lib/gateway-response.ts", "line": 25 }, "name": "GatewayResponseOptions", "properties": [ { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html", "stability": "stable", "summary": "Response type to associate with gateway response." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 30 }, "name": "type", "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "abstract": true, "docs": { "default": "- no headers", "stability": "stable", "summary": "Custom headers parameters for response." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 42 }, "name": "responseHeaders", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- standard http status code for the response type.", "stability": "stable", "summary": "Http status code for response." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 36 }, "name": "statusCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Response from api will be returned without applying any transformation.", "stability": "stable", "summary": "Custom templates to get mapped as response." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 48 }, "name": "templates", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/gateway-response:GatewayResponseOptions" }, "@aws-cdk/aws-apigateway.GatewayResponseProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new gateway response.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const responseType: apigateway.ResponseType;\ndeclare const restApi: apigateway.RestApi;\nconst gatewayResponseProps: apigateway.GatewayResponseProps = {\n restApi: restApi,\n type: responseType,\n\n // the properties below are optional\n responseHeaders: {\n responseHeadersKey: 'responseHeaders',\n },\n statusCode: 'statusCode',\n templates: {\n templatesKey: 'templates',\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.GatewayResponseProps", "interfaces": [ "@aws-cdk/aws-apigateway.GatewayResponseOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/gateway-response.ts", "line": 15 }, "name": "GatewayResponseProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Rest api resource to target." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 19 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/gateway-response:GatewayResponseProps" }, "@aws-cdk/aws-apigateway.HttpIntegration": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Integration", "docs": { "remarks": "With the proxy integration, the setup is simple. You only need to set the\nHTTP method and the HTTP endpoint URI, according to the backend requirements,\nif you are not concerned with content encoding or caching.\n\nWith the custom integration, the setup is more involved. In addition to the\nproxy integration setup steps, you need to specify how the incoming request\ndata is mapped to the integration request and how the resulting integration\nresponse data is mapped to the method response.", "stability": "stable", "summary": "You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.RequestAuthorizer(this, 'booksAuthorizer', {\n handler: authFn,\n identitySources: [apigateway.IdentitySource.header('Authorization')]\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.HttpIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/integrations/http.ts", "line": 40 }, "parameters": [ { "name": "url", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.HttpIntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/integrations/http.ts", "line": 39 }, "name": "HttpIntegration", "symbolId": "lib/integrations/http:HttpIntegration" }, "@aws-cdk/aws-apigateway.HttpIntegrationProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\ndeclare const vpcLink: apigateway.VpcLink;\nconst httpIntegrationProps: apigateway.HttpIntegrationProps = {\n httpMethod: 'httpMethod',\n options: {\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionType: apigateway.ConnectionType.INTERNET,\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n credentialsPassthrough: false,\n credentialsRole: role,\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: apigateway.PassthroughBehavior.WHEN_NO_MATCH,\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeout: cdk.Duration.minutes(30),\n vpcLink: vpcLink,\n },\n proxy: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.HttpIntegrationProps", "kind": "interface", "locationInModule": { "filename": "lib/integrations/http.ts", "line": 3 }, "name": "HttpIntegrationProps", "properties": [ { "abstract": true, "docs": { "default": "GET", "stability": "stable", "summary": "HTTP method to use when invoking the backend URL." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/http.ts", "line": 15 }, "name": "httpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "defaults based on `IntegrationOptions` defaults", "stability": "stable", "summary": "Integration options, such as request/resopnse mapping, content handling, etc." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/http.ts", "line": 23 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Determines whether to use proxy integration or custom integration." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/http.ts", "line": 9 }, "name": "proxy", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/integrations/http:HttpIntegrationProps" }, "@aws-cdk/aws-apigateway.IAccessLogDestination": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Access log destination for a RestApi Stage." }, "fqn": "@aws-cdk/aws-apigateway.IAccessLogDestination", "kind": "interface", "locationInModule": { "filename": "lib/access-log.ts", "line": 7 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Binds this destination to the RestApi Stage." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 11 }, "name": "bind", "parameters": [ { "name": "stage", "type": { "fqn": "@aws-cdk/aws-apigateway.IStage" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogDestinationConfig" } } } ], "name": "IAccessLogDestination", "symbolId": "lib/access-log:IAccessLogDestination" }, "@aws-cdk/aws-apigateway.IApiKey": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API." }, "fqn": "@aws-cdk/aws-apigateway.IApiKey", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/api-key.ts", "line": 13 }, "name": "IApiKey", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The API key ARN." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 23 }, "name": "keyArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The API key ID." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 18 }, "name": "keyId", "type": { "primitive": "string" } } ], "symbolId": "lib/api-key:IApiKey" }, "@aws-cdk/aws-apigateway.IAuthorizer": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Represents an API Gateway authorizer." }, "fqn": "@aws-cdk/aws-apigateway.IAuthorizer", "kind": "interface", "locationInModule": { "filename": "lib/authorizer.ts", "line": 38 }, "name": "IAuthorizer", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The authorizer ID." }, "immutable": true, "locationInModule": { "filename": "lib/authorizer.ts", "line": 43 }, "name": "authorizerId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The authorization type of this authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizer.ts", "line": 48 }, "name": "authorizationType", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.AuthorizationType" } } ], "symbolId": "lib/authorizer:IAuthorizer" }, "@aws-cdk/aws-apigateway.IDomainName": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.IDomainName", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/domain-name.ts", "line": 76 }, "name": "IDomainName", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "DomainName" }, "stability": "stable", "summary": "The domain name (e.g. `example.com`)." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 82 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "DistributionDomainName,RegionalDomainName" }, "stability": "stable", "summary": "The Route53 alias target to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 89 }, "name": "domainNameAliasDomainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "DistributionHostedZoneId,RegionalHostedZoneId" }, "stability": "stable", "summary": "The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 96 }, "name": "domainNameAliasHostedZoneId", "type": { "primitive": "string" } } ], "symbolId": "lib/domain-name:IDomainName" }, "@aws-cdk/aws-apigateway.IGatewayResponse": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Represents gateway response resource." }, "fqn": "@aws-cdk/aws-apigateway.IGatewayResponse", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/gateway-response.ts", "line": 9 }, "name": "IGatewayResponse", "symbolId": "lib/gateway-response:IGatewayResponse" }, "@aws-cdk/aws-apigateway.IModel": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.IModel", "kind": "interface", "locationInModule": { "filename": "lib/model.ts", "line": 8 }, "name": "IModel", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Returns the model name, such as 'myModel'." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 14 }, "name": "modelId", "type": { "primitive": "string" } } ], "symbolId": "lib/model:IModel" }, "@aws-cdk/aws-apigateway.IRequestValidator": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.IRequestValidator", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 6 }, "name": "IRequestValidator", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "ID of the request validator, such as abc123." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 12 }, "name": "requestValidatorId", "type": { "primitive": "string" } } ], "symbolId": "lib/requestvalidator:IRequestValidator" }, "@aws-cdk/aws-apigateway.IResource": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.IResource", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "remarks": "Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional\nHTTP headers to tell browsers to give a web application running at one\norigin, access to selected resources from a different origin. A web\napplication executes a cross-origin HTTP request when it requests a\nresource that has a different origin (domain, protocol, or port) from its\nown.", "returns": "a `Method` object", "see": "https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS", "stability": "stable", "summary": "Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests." }, "locationInModule": { "filename": "lib/resource.ts", "line": 119 }, "name": "addCorsPreflight", "parameters": [ { "docs": { "summary": "CORS options." }, "name": "options", "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } }, { "abstract": true, "docs": { "returns": "The newly created `Method` object.", "stability": "stable", "summary": "Defines a new method for this resource." }, "locationInModule": { "filename": "lib/resource.ts", "line": 102 }, "name": "addMethod", "parameters": [ { "docs": { "summary": "The HTTP method." }, "name": "httpMethod", "type": { "primitive": "string" } }, { "docs": { "summary": "The target backend integration for this method." }, "name": "target", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "docs": { "summary": "Method options, such as authentication." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Adds a greedy proxy resource (\"{proxy+}\") and an ANY method to this route." }, "locationInModule": { "filename": "lib/resource.ts", "line": 92 }, "name": "addProxy", "parameters": [ { "docs": { "summary": "Default integration and method options." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ProxyResourceOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ProxyResource" } } }, { "abstract": true, "docs": { "returns": "A Resource object", "stability": "stable", "summary": "Defines a new child resource where this resource is the parent." }, "locationInModule": { "filename": "lib/resource.ts", "line": 78 }, "name": "addResource", "parameters": [ { "docs": { "summary": "The path part for the child resource." }, "name": "pathPart", "type": { "primitive": "string" } }, { "docs": { "summary": "Resource options." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResourceOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Resource" } } }, { "abstract": true, "docs": { "returns": "the child resource or undefined if not found", "stability": "stable", "summary": "Retrieves a child resource by path part." }, "locationInModule": { "filename": "lib/resource.ts", "line": 86 }, "name": "getResource", "parameters": [ { "docs": { "summary": "The path part of the child resource." }, "name": "pathPart", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } }, { "abstract": true, "docs": { "remarks": "- Path may only start with \"/\" if this method is called on the root resource.\n- All resources are created using default options.", "returns": "a new or existing resource.", "stability": "stable", "summary": "Gets or create all resources leading up to the specified path." }, "locationInModule": { "filename": "lib/resource.ts", "line": 70 }, "name": "resourceForPath", "parameters": [ { "docs": { "summary": "The relative path." }, "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Resource" } } } ], "name": "IResource", "properties": [ { "abstract": true, "docs": { "remarks": "The reason we need the RestApi object itself and not just the ID is because the model\nis being tracked by the top-level RestApi object for the purpose of calculating it's\nhash to determine the ID of the deployment. This allows us to automatically update\nthe deployment when the model of the REST API changes.", "stability": "stable", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 31 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The full path of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 42 }, "name": "path", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 37 }, "name": "resourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.", "stability": "deprecated", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 21 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApi" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Default options for CORS preflight OPTIONS method." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 59 }, "name": "defaultCorsPreflightOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "An integration to use as a default for all methods created within this API unless an integration is specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 48 }, "name": "defaultIntegration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Method options to use as a default for all methods created within this API unless custom options are specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 54 }, "name": "defaultMethodOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent of this resource or undefined for the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 14 }, "name": "parentResource", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } ], "symbolId": "lib/resource:IResource" }, "@aws-cdk/aws-apigateway.IRestApi": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.IRestApi", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 24 }, "methods": [ { "abstract": true, "docs": { "default": "\"*\" returns the execute API ARN for all methods/resources in\nthis API.", "returns": "The \"execute-api\" ARN.", "stability": "stable", "summary": "Gets the \"execute-api\" ARN." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 67 }, "name": "arnForExecuteApi", "parameters": [ { "docs": { "summary": "The method (default `*`)." }, "name": "method", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "Must start with '/' (default `*`)", "summary": "The resource path." }, "name": "path", "optional": true, "type": { "primitive": "string" } }, { "docs": { "summary": "The stage (default `*`)." }, "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "IRestApi", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ID of this API Gateway RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 29 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The resource ID of the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 35 }, "name": "restApiRootResourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "api.root.addMethod('ANY', redirectToHomePage); // \"ANY /\"\n api.root.addResource('friends').addMethod('GET', getFriendsHandler); // \"GET /friends\"", "stability": "stable", "summary": "Represents the root resource (\"/\") of this API. Use it to define the API model:." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 56 }, "name": "root", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "abstract": true, "docs": { "remarks": "This resource will be automatically updated every time the REST API model changes.\n`undefined` when no deployment is configured.", "stability": "stable", "summary": "API Gateway deployment that represents the latest changes of the API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 42 }, "name": "latestDeployment", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Deployment" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "API Gateway stage that points to the latest deployment (if defined)." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 47 }, "name": "deploymentStage", "type": { "fqn": "@aws-cdk/aws-apigateway.Stage" } } ], "symbolId": "lib/restapi:IRestApi" }, "@aws-cdk/aws-apigateway.IStage": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Represents an APIGateway Stage." }, "fqn": "@aws-cdk/aws-apigateway.IStage", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/stage.ts", "line": 12 }, "name": "IStage", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "RestApi to which this stage is associated." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 22 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Name of this stage." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 17 }, "name": "stageName", "type": { "primitive": "string" } } ], "symbolId": "lib/stage:IStage" }, "@aws-cdk/aws-apigateway.IUsagePlan": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "A UsagePlan, either managed by this CDK app, or imported." }, "fqn": "@aws-cdk/aws-apigateway.IUsagePlan", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 162 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Adds an ApiKey." }, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 175 }, "name": "addApiKey", "parameters": [ { "docs": { "summary": "the api key to associate with this usage plan." }, "name": "apiKey", "type": { "fqn": "@aws-cdk/aws-apigateway.IApiKey" } }, { "docs": { "summary": "options that control the behaviour of this method." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.AddApiKeyOptions" } } ] } ], "name": "IUsagePlan", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Id of the usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 167 }, "name": "usagePlanId", "type": { "primitive": "string" } } ], "symbolId": "lib/usage-plan:IUsagePlan" }, "@aws-cdk/aws-apigateway.IVpcLink": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Represents an API Gateway VpcLink." }, "fqn": "@aws-cdk/aws-apigateway.IVpcLink", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/vpc-link.ts", "line": 9 }, "name": "IVpcLink", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Physical ID of the VpcLink resource." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 14 }, "name": "vpcLinkId", "type": { "primitive": "string" } } ], "symbolId": "lib/vpc-link:IVpcLink" }, "@aws-cdk/aws-apigateway.IdentitySource": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "remarks": "The source can be specified either as a literal value (e.g: `Auth`) which\ncannot be blank, or as an unresolved string token.", "stability": "stable", "summary": "Represents an identity source.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.RequestAuthorizer(this, 'booksAuthorizer', {\n handler: authFn,\n identitySources: [apigateway.IdentitySource.header('Authorization')]\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.IdentitySource", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/authorizers/identity-source.ts", "line": 7 }, "methods": [ { "docs": { "returns": "a request context identity source.", "stability": "stable", "summary": "Provides a properly formatted request context identity source." }, "locationInModule": { "filename": "lib/authorizers/identity-source.ts", "line": 44 }, "name": "context", "parameters": [ { "docs": { "summary": "the name of the context variable the `IdentitySource` will represent." }, "name": "context", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "returns": "a header identity source.", "stability": "stable", "summary": "Provides a properly formatted header identity source." }, "locationInModule": { "filename": "lib/authorizers/identity-source.ts", "line": 14 }, "name": "header", "parameters": [ { "docs": { "summary": "the name of the header the `IdentitySource` will represent." }, "name": "headerName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "returns": "a query string identity source.", "stability": "stable", "summary": "Provides a properly formatted query string identity source." }, "locationInModule": { "filename": "lib/authorizers/identity-source.ts", "line": 24 }, "name": "queryString", "parameters": [ { "docs": { "summary": "the name of the query string the `IdentitySource` will represent." }, "name": "queryString", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "returns": "an API Gateway stage variable identity source.", "stability": "stable", "summary": "Provides a properly formatted API Gateway stage variable identity source." }, "locationInModule": { "filename": "lib/authorizers/identity-source.ts", "line": 34 }, "name": "stageVariable", "parameters": [ { "docs": { "summary": "the name of the stage variable the `IdentitySource` will represent." }, "name": "stageVariable", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true } ], "name": "IdentitySource", "symbolId": "lib/authorizers/identity-source:IdentitySource" }, "@aws-cdk/aws-apigateway.InlineApiDefinition": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.ApiDefinition", "docs": { "stability": "stable", "summary": "OpenAPI specification from an inline JSON object.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const definition: any;\nconst inlineApiDefinition = new apigateway.InlineApiDefinition(definition);", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.InlineApiDefinition", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 165 }, "parameters": [ { "name": "definition", "type": { "primitive": "any" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/api-definition.ts", "line": 164 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 177 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.ApiDefinition", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionConfig" } } } ], "name": "InlineApiDefinition", "symbolId": "lib/api-definition:InlineApiDefinition" }, "@aws-cdk/aws-apigateway.Integration": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "remarks": "Use one of the concrete classes such as `MockIntegration`, `AwsIntegration`, `LambdaIntegration`\nor implement on your own by specifying the set of props.", "stability": "stable", "summary": "Base class for backend integrations for an API Gateway method.", "example": "declare const books: apigateway.Resource;\ndeclare const iamUser: iam.User;\n\nconst getBooks = books.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizationType: apigateway.AuthorizationType.IAM\n});\n\niamUser.attachInlinePolicy(new iam.Policy(this, 'AllowBooks', {\n statements: [\n new iam.PolicyStatement({\n actions: [ 'execute-api:Invoke' ],\n effect: iam.Effect.ALLOW,\n resources: [ getBooks.methodArn ]\n })\n ]\n}))", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Integration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/integration.ts", "line": 191 }, "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/integration.ts", "line": 190 }, "methods": [ { "docs": { "stability": "stable", "summary": "Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc." }, "locationInModule": { "filename": "lib/integration.ts", "line": 214 }, "name": "bind", "parameters": [ { "name": "_method", "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationConfig" } } } ], "name": "Integration", "symbolId": "lib/integration:Integration" }, "@aws-cdk/aws-apigateway.IntegrationConfig": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Result of binding an Integration to a Method.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\ndeclare const vpcLink: apigateway.VpcLink;\nconst integrationConfig: apigateway.IntegrationConfig = {\n type: apigateway.IntegrationType.AWS,\n\n // the properties below are optional\n deploymentToken: 'deploymentToken',\n integrationHttpMethod: 'integrationHttpMethod',\n options: {\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionType: apigateway.ConnectionType.INTERNET,\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n credentialsPassthrough: false,\n credentialsRole: role,\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: apigateway.PassthroughBehavior.WHEN_NO_MATCH,\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeout: cdk.Duration.minutes(30),\n vpcLink: vpcLink,\n },\n uri: 'uri',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.IntegrationConfig", "kind": "interface", "locationInModule": { "filename": "lib/integration.ts", "line": 149 }, "name": "IntegrationConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Specifies an API method integration type." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 159 }, "name": "type", "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationType" } }, { "abstract": true, "docs": { "default": "undefined deployments are not triggered for any change to this integration.", "remarks": "When the fingerprint\nchanges, a new deployment is triggered.\nThis property should contain values associated with the Integration that upon changing\nshould trigger a fresh the Deployment needs to be refreshed.", "stability": "stable", "summary": "This value is included in computing the Deployment's fingerprint." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 181 }, "name": "deploymentToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no integration method specified.", "stability": "stable", "summary": "The integration's HTTP method type." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 172 }, "name": "integrationHttpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no integration options", "stability": "stable", "summary": "Integration options." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 154 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions" } }, { "abstract": true, "docs": { "default": "- no URI. Usually applies to MOCK integration", "see": "https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri", "stability": "stable", "summary": "The Uniform Resource Identifier (URI) for the integration." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 166 }, "name": "uri", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/integration:IntegrationConfig" }, "@aws-cdk/aws-apigateway.IntegrationOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "import * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi } from '../../lib';\nimport { RequestAuthorizer } from '../../lib/authorizers';\nimport { IdentitySource } from '../../lib/authorizers/identity-source';\n\n// Against the RestApi endpoint from the stack output, run\n// `curl -s -o /dev/null -w \"%{http_code}\" ` should return 401\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' ?allow=yes` should return 403\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' ?allow=yes` should return 200\n\nconst app = new App();\nconst stack = new Stack(app, 'RequestAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new RequestAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});", "custom": { "exampleMetadata": "lit=test/authorizers/integ.request-authorizer.lit.ts infused" } }, "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions", "kind": "interface", "locationInModule": { "filename": "lib/integration.ts", "line": 6 }, "name": "IntegrationOptions", "properties": [ { "abstract": true, "docs": { "remarks": "It determines\nrequest parameters that will make it into the cache key.", "stability": "stable", "summary": "A list of request parameters whose values are to be cached." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 11 }, "name": "cacheKeyParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "An API-specific tag group of related cached parameters." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 16 }, "name": "cacheNamespace", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- ConnectionType.VPC_LINK if `vpcLink` property is configured; ConnectionType.Internet otherwise.", "stability": "stable", "summary": "The type of network connection to the integration endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 104 }, "name": "connectionType", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ConnectionType" } }, { "abstract": true, "docs": { "default": "none if this property isn't defined, the request payload is passed\nthrough from the method request to the integration request without\nmodification, provided that the `passthroughBehaviors` property is\nconfigured to support payload pass-through.", "stability": "stable", "summary": "Specifies how to handle request payload content type conversions." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 26 }, "name": "contentHandling", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ContentHandling" } }, { "abstract": true, "docs": { "default": "Caller identity is not passed through", "stability": "stable", "summary": "Requires that the caller's identity be passed through from the request." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 42 }, "name": "credentialsPassthrough", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "A role is not assumed", "remarks": "Mutually exclusive with `credentialsPassThrough`.", "stability": "stable", "summary": "An IAM role that API Gateway assumes." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 35 }, "name": "credentialsRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "remarks": "API Gateway intercepts the response from the\nbackend so that you can control how API Gateway surfaces backend\nresponses. For example, you can map the backend status codes to codes\nthat you define.", "stability": "stable", "summary": "The response that API Gateway provides after a method's backend completes processing a request." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 98 }, "name": "integrationResponses", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.IntegrationResponse" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\nNEVER.", "stability": "stable", "summary": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 51 }, "name": "passthroughBehavior", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.PassthroughBehavior" } }, { "abstract": true, "docs": { "remarks": "Specify request parameters as key-value pairs (string-to-string\nmappings), with a destination as the key and a source as the value.\n\nSpecify the destination by using the following pattern\nintegration.request.location.name, where location is querystring, path,\nor header, and name is a valid, unique parameter name.\n\nThe source must be an existing method request parameter or a static\nvalue. You must enclose static values in single quotation marks and\npre-encode these values based on their destination in the request.", "stability": "stable", "summary": "The request parameters that API Gateway sends with the backend request." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 66 }, "name": "requestParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "The template that API Gateway uses is based on the value of the\nContent-Type header that's sent by the client. The content type value is\nthe key, and the template is the value (specified as a string), such as\nthe following snippet:\n\n```\n { \"application/json\": \"{ \\\"statusCode\\\": 200 }\" }\n```", "see": "http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html", "stability": "stable", "summary": "A map of Apache Velocity templates that are applied on the request payload." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 81 }, "name": "requestTemplates", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "Duration.seconds(29)", "remarks": "Must be between 50 milliseconds and 29 seconds.", "stability": "stable", "summary": "The maximum amount of time an integration will run before it returns without a response." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 89 }, "name": "timeout", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "remarks": "Required if connectionType is VPC_LINK", "stability": "stable", "summary": "The VpcLink used for the integration." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 110 }, "name": "vpcLink", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IVpcLink" } } ], "symbolId": "lib/integration:IntegrationOptions" }, "@aws-cdk/aws-apigateway.IntegrationProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.IntegrationProps", "kind": "interface", "locationInModule": { "filename": "lib/integration.ts", "line": 113 }, "name": "IntegrationProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Specifies an API method integration type." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 117 }, "name": "type", "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationType" } }, { "abstract": true, "docs": { "remarks": "Required unless you use a MOCK integration.", "stability": "stable", "summary": "The integration's HTTP method type." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 138 }, "name": "integrationHttpMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Integration options." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 143 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions" } }, { "abstract": true, "docs": { "remarks": "- If you specify HTTP for the `type` property, specify the API endpoint URL.\n- If you specify MOCK for the `type` property, don't specify this property.\n- If you specify AWS for the `type` property, specify an AWS service that\n follows this form: `arn:partition:apigateway:region:subdomain.service|service:path|action/service_api.`\n For example, a Lambda function URI follows this form:\n arn:partition:apigateway:region:lambda:path/path. The path is usually in the\n form /2015-03-31/functions/LambdaFunctionARN/invocations.", "see": "https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri", "stability": "stable", "summary": "The Uniform Resource Identifier (URI) for the integration." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 132 }, "name": "uri", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/integration:IntegrationProps" }, "@aws-cdk/aws-apigateway.IntegrationResponse": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nconst integrationResponse: apigateway.IntegrationResponse = {\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.IntegrationResponse", "kind": "interface", "locationInModule": { "filename": "lib/integration.ts", "line": 331 }, "name": "IntegrationResponse", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The status code that API Gateway uses to map the integration response to a MethodResponse status code." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 347 }, "name": "statusCode", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "none the request payload is passed through from the method\nrequest to the integration request without modification.", "stability": "stable", "summary": "Specifies how to handle request payload content type conversions." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 355 }, "name": "contentHandling", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ContentHandling" } }, { "abstract": true, "docs": { "remarks": "Use the destination as the key and the source as the value:\n\n- The destination must be an existing response parameter in the\n MethodResponse property.\n- The source must be an existing method request parameter or a static\n value. You must enclose static values in single quotation marks and\n pre-encode these values based on the destination specified in the\n request.", "see": "http://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html", "stability": "stable", "summary": "The response parameters from the backend response that API Gateway sends to the method response." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 372 }, "name": "responseParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "Specify templates as key-value pairs, with a content type as the key and\na template as the value.", "see": "http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html", "stability": "stable", "summary": "The templates that are used to transform the integration response body." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 381 }, "name": "responseTemplates", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "For example, if the success response returns nothing and the error response returns some string, you\ncould use the ``.+`` regex to match error response. However, make sure that the error response does not contain any\nnewline (``\\n``) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error\nheader is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-integration-settings-integration-response.html", "stability": "stable", "summary": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end." }, "immutable": true, "locationInModule": { "filename": "lib/integration.ts", "line": 341 }, "name": "selectionPattern", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/integration:IntegrationResponse" }, "@aws-cdk/aws-apigateway.IntegrationType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.IntegrationType", "kind": "enum", "locationInModule": { "filename": "lib/integration.ts", "line": 260 }, "members": [ { "docs": { "remarks": "With the Lambda\nfunction-invoking action, this is referred to as the Lambda custom\nintegration. With any other AWS service action, this is known as AWS\nintegration.", "stability": "stable", "summary": "For integrating the API method request with an AWS service action, including the Lambda function-invoking action." }, "name": "AWS" }, { "docs": { "remarks": "This integration is\nalso referred to as the Lambda proxy integration", "stability": "stable", "summary": "For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is." }, "name": "AWS_PROXY" }, { "docs": { "remarks": "This integration is also referred to\nas the HTTP custom integration.", "stability": "stable", "summary": "For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC." }, "name": "HTTP" }, { "docs": { "remarks": "This is also referred to as the HTTP proxy integration", "stability": "stable", "summary": "For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is." }, "name": "HTTP_PROXY" }, { "docs": { "stability": "stable", "summary": "For integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend." }, "name": "MOCK" } ], "name": "IntegrationType", "symbolId": "lib/integration:IntegrationType" }, "@aws-cdk/aws-apigateway.JsonSchema": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "remarks": "Copied from npm module jsonschema.", "see": "https://github.com/tdegrunt/jsonschema", "stability": "stable", "summary": "Represents a JSON schema definition of the structure of a REST API model.", "example": "declare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.JsonSchema", "kind": "interface", "locationInModule": { "filename": "lib/json-schema.ts", "line": 27 }, "name": "JsonSchema", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 61 }, "name": "additionalItems", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 72 }, "name": "additionalProperties", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" } ] } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 78 }, "name": "allOf", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 79 }, "name": "anyOf", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 65 }, "name": "contains", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "default": "- not set", "stability": "stable", "summary": "The default value if you use an enum." }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 43 }, "name": "default", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 45 }, "name": "definitions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 74 }, "name": "dependencies", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } }, { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" } ] } }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 36 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 37 }, "name": "enum", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 50 }, "name": "exclusiveMaximum", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 52 }, "name": "exclusiveMinimum", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 44 }, "name": "format", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 30 }, "name": "id", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 60 }, "name": "items", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 49 }, "name": "maximum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 62 }, "name": "maxItems", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 55 }, "name": "maxLength", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 68 }, "name": "maxProperties", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 51 }, "name": "minimum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 63 }, "name": "minItems", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 56 }, "name": "minLength", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 69 }, "name": "minProperties", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 48 }, "name": "multipleOf", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 81 }, "name": "not", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 80 }, "name": "oneOf", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 57 }, "name": "pattern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 73 }, "name": "patternProperties", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 71 }, "name": "properties", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" }, "kind": "map" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 75 }, "name": "propertyNames", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 31 }, "name": "ref", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 70 }, "name": "required", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 29 }, "name": "schema", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.JsonSchemaVersion" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 35 }, "name": "title", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 34 }, "name": "type", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-apigateway.JsonSchemaType" }, { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.JsonSchemaType" }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/json-schema.ts", "line": 64 }, "name": "uniqueItems", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/json-schema:JsonSchema" }, "@aws-cdk/aws-apigateway.JsonSchemaType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "declare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.JsonSchemaType", "kind": "enum", "locationInModule": { "filename": "lib/json-schema.ts", "line": 10 }, "members": [ { "docs": { "stability": "stable" }, "name": "NULL" }, { "docs": { "stability": "stable" }, "name": "BOOLEAN" }, { "docs": { "stability": "stable" }, "name": "OBJECT" }, { "docs": { "stability": "stable" }, "name": "ARRAY" }, { "docs": { "stability": "stable" }, "name": "NUMBER" }, { "docs": { "stability": "stable" }, "name": "INTEGER" }, { "docs": { "stability": "stable" }, "name": "STRING" } ], "name": "JsonSchemaType", "symbolId": "lib/json-schema:JsonSchemaType" }, "@aws-cdk/aws-apigateway.JsonSchemaVersion": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "declare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.JsonSchemaVersion", "kind": "enum", "locationInModule": { "filename": "lib/json-schema.ts", "line": 1 }, "members": [ { "docs": { "see": "https://tools.ietf.org/html/draft-zyp-json-schema-04", "stability": "stable", "summary": "In API Gateway models are defined using the JSON schema draft 4." }, "name": "DRAFT4" }, { "docs": { "stability": "stable" }, "name": "DRAFT7" } ], "name": "JsonSchemaVersion", "symbolId": "lib/json-schema:JsonSchemaVersion" }, "@aws-cdk/aws-apigateway.JsonWithStandardFieldProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for controlling items output in JSON standard format.", "example": "// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.JsonWithStandardFieldProps", "kind": "interface", "locationInModule": { "filename": "lib/access-log.ts", "line": 442 }, "name": "JsonWithStandardFieldProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the principal identifier of the caller will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 450 }, "name": "caller", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the http method will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 462 }, "name": "httpMethod", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the source IP of request will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 446 }, "name": "ip", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the request protocol will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 474 }, "name": "protocol", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the CLF-formatted request time((dd/MMM/yyyy:HH:mm:ss +-hhmm) will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 458 }, "name": "requestTime", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the path to your resource will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 466 }, "name": "resourcePath", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the response payload length will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 478 }, "name": "responseLength", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the method response status will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 470 }, "name": "status", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If this flag is enabled, the principal identifier of the user will be output to the log." }, "immutable": true, "locationInModule": { "filename": "lib/access-log.ts", "line": 454 }, "name": "user", "type": { "primitive": "boolean" } } ], "symbolId": "lib/access-log:JsonWithStandardFieldProps" }, "@aws-cdk/aws-apigateway.LambdaAuthorizerProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Base properties for all lambda authorizers.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const function_: lambda.Function;\ndeclare const role: iam.Role;\nconst lambdaAuthorizerProps: apigateway.LambdaAuthorizerProps = {\n handler: function_,\n\n // the properties below are optional\n assumeRole: role,\n authorizerName: 'authorizerName',\n resultsCacheTtl: cdk.Duration.minutes(30),\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.LambdaAuthorizerProps", "kind": "interface", "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 12 }, "name": "LambdaAuthorizerProps", "properties": [ { "abstract": true, "docs": { "remarks": "The handler must follow a very specific protocol on the input it receives and the output it needs to produce.\nAPI Gateway has documented the handler's input specification\n{@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.html | here} and output specification\n{@link https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html | here}.", "stability": "stable", "summary": "The handler for the authorizer lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 28 }, "name": "handler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "abstract": true, "docs": { "default": "- A resource policy is added to the Lambda function allowing apigateway.amazonaws.com to invoke the function.", "remarks": "The IAM role must be\nassumable by 'apigateway.amazonaws.com'.", "stability": "stable", "summary": "An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 44 }, "name": "assumeRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- the unique construcrt ID", "remarks": "Note that, this is not the primary identifier of the authorizer.", "stability": "stable", "summary": "An optional human friendly name for the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 18 }, "name": "authorizerName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Duration.minutes(5)", "remarks": "Max 1 hour.\nDisable caching by setting this to 0.", "stability": "stable", "summary": "How long APIGateway should cache the results." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 36 }, "name": "resultsCacheTtl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } } ], "symbolId": "lib/authorizers/lambda:LambdaAuthorizerProps" }, "@aws-cdk/aws-apigateway.LambdaIntegration": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.AwsIntegration", "docs": { "example": " declare const resource: apigateway.Resource;\n declare const handler: lambda.Function;\n resource.addMethod('GET', new apigateway.LambdaIntegration(handler));", "stability": "stable", "summary": "Integrates an AWS Lambda function to an API Gateway method." }, "fqn": "@aws-cdk/aws-apigateway.LambdaIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 44 }, "parameters": [ { "name": "handler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.LambdaIntegrationOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 40 }, "methods": [ { "docs": { "stability": "stable", "summary": "Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc." }, "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 58 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.AwsIntegration", "parameters": [ { "name": "method", "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationConfig" } } } ], "name": "LambdaIntegration", "symbolId": "lib/integrations/lambda:LambdaIntegration" }, "@aws-cdk/aws-apigateway.LambdaIntegrationOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const getBookHandler: lambda.Function;\ndeclare const getBookIntegration: apigateway.LambdaIntegration;\n\nconst getBookIntegration = new apigateway.LambdaIntegration(getBookHandler, {\n contentHandling: apigateway.ContentHandling.CONVERT_TO_TEXT, // convert to base64\n credentialsPassthrough: true, // use caller identity to invoke the function\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.LambdaIntegrationOptions", "interfaces": [ "@aws-cdk/aws-apigateway.IntegrationOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 8 }, "name": "LambdaIntegrationOptions", "properties": [ { "abstract": true, "docs": { "default": "true", "remarks": "This will add another permission to the AWS Lambda resource policy which\nwill allow the `test-invoke-stage` stage to invoke this handler. If this\nis set to `false`, the function will only be usable from the deployment\nendpoint.", "stability": "stable", "summary": "Allow invoking method from AWS Console UI (for testing purposes)." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 27 }, "name": "allowTestInvoke", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format", "stability": "stable", "summary": "Use proxy integration or normal (request/response mapping) integration." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/lambda.ts", "line": 15 }, "name": "proxy", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/integrations/lambda:LambdaIntegrationOptions" }, "@aws-cdk/aws-apigateway.LambdaRestApi": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.RestApi", "docs": { "remarks": "Use the `proxy` property to define a greedy proxy (\"{proxy+}\") and \"ANY\"\nmethod from the specified path. If not defined, you will need to explicity\nadd resources and methods to the API.", "stability": "stable", "summary": "Defines an API Gateway REST API with AWS Lambda proxy integration.", "example": "declare const backend: lambda.Function;\nconst api = new apigateway.LambdaRestApi(this, 'myapi', {\n handler: backend,\n proxy: false\n});\n\nconst items = api.root.addResource('items');\nitems.addMethod('GET'); // GET /items\nitems.addMethod('POST'); // POST /items\n\nconst item = items.addResource('{item}');\nitem.addMethod('GET'); // GET /items/{item}\n\n// the default integration for methods is \"handler\", but one can\n// customize this behavior per method or even a sub path.\nitem.addMethod('DELETE', new apigateway.HttpIntegration('http://amazon.com'));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.LambdaRestApi", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/lambda-api.ts", "line": 45 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.LambdaRestApiProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/lambda-api.ts", "line": 44 }, "name": "LambdaRestApi", "symbolId": "lib/lambda-api:LambdaRestApi" }, "@aws-cdk/aws-apigateway.LambdaRestApiProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const backend: lambda.Function;\nconst api = new apigateway.LambdaRestApi(this, 'myapi', {\n handler: backend,\n proxy: false\n});\n\nconst items = api.root.addResource('items');\nitems.addMethod('GET'); // GET /items\nitems.addMethod('POST'); // POST /items\n\nconst item = items.addResource('{item}');\nitem.addMethod('GET'); // GET /items/{item}\n\n// the default integration for methods is \"handler\", but one can\n// customize this behavior per method or even a sub path.\nitem.addMethod('DELETE', new apigateway.HttpIntegration('http://amazon.com'));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.LambdaRestApiProps", "interfaces": [ "@aws-cdk/aws-apigateway.RestApiProps" ], "kind": "interface", "locationInModule": { "filename": "lib/lambda-api.ts", "line": 8 }, "name": "LambdaRestApiProps", "properties": [ { "abstract": true, "docs": { "remarks": "This handler will be used as a the default integration for all methods in\nthis API, unless specified otherwise in `addMethod`.", "stability": "stable", "summary": "The default Lambda function that handles all requests from this API." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-api.ts", "line": 15 }, "name": "handler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "abstract": true, "docs": { "default": "- no options.", "deprecated": "the `LambdaRestApiProps` now extends `RestApiProps`, so all\noptions are just available here. Note that the options specified in\n`options` will be overridden by any props specified at the root level.", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/lambda-api.ts", "line": 34 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RestApiProps" } }, { "abstract": true, "docs": { "default": "true", "remarks": "If set to false, you will need to explicitly define the API model using\n`addResource` and `addMethod` (or `addProxy`).", "stability": "stable", "summary": "If true, route all requests to the Lambda Function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-api.ts", "line": 25 }, "name": "proxy", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/lambda-api:LambdaRestApiProps" }, "@aws-cdk/aws-apigateway.LogGroupLogDestination": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Use CloudWatch Logs as a custom access log destination for API Gateway.", "example": "const logGroup = new logs.LogGroup(this, \"ApiGatewayAccessLogs\");\nnew apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),\n accessLogFormat: apigateway.AccessLogFormat.custom(\n `${apigateway.AccessLogField.contextRequestId()} ${apigateway.AccessLogField.contextErrorMessage()} ${apigateway.AccessLogField.contextErrorMessageString()}`\n )\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.LogGroupLogDestination", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/access-log.ts", "line": 28 }, "parameters": [ { "name": "logGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IAccessLogDestination" ], "kind": "class", "locationInModule": { "filename": "lib/access-log.ts", "line": 27 }, "methods": [ { "docs": { "stability": "stable", "summary": "Binds this destination to the CloudWatch Logs." }, "locationInModule": { "filename": "lib/access-log.ts", "line": 34 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.IAccessLogDestination", "parameters": [ { "name": "_stage", "type": { "fqn": "@aws-cdk/aws-apigateway.IStage" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogDestinationConfig" } } } ], "name": "LogGroupLogDestination", "symbolId": "lib/access-log:LogGroupLogDestination" }, "@aws-cdk/aws-apigateway.MTLSConfig": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "The mTLS authentication configuration for a custom domain name.", "example": "declare const acm: any;\n\nnew apigateway.DomainName(this, 'domain-name', {\n domainName: 'example.com',\n certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),\n mtls: {\n bucket: new s3.Bucket(this, 'bucket'),\n key: 'truststore.pem',\n version: 'version',\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.MTLSConfig", "kind": "interface", "locationInModule": { "filename": "lib/domain-name.ts", "line": 204 }, "name": "MTLSConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The bucket that the trust store is hosted in." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 208 }, "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The key in S3 to look at for the trust store." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 213 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- latest version", "remarks": "To specify a version, you must have versioning enabled for the S3 bucket.", "stability": "stable", "summary": "The version of the S3 object that contains your truststore." }, "immutable": true, "locationInModule": { "filename": "lib/domain-name.ts", "line": 220 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/domain-name:MTLSConfig" }, "@aws-cdk/aws-apigateway.Method": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "declare const integration: apigateway.LambdaIntegration;\n\nconst api = new apigateway.RestApi(this, 'hello-api');\n\nconst v1 = api.root.addResource('v1');\nconst echo = v1.addResource('echo');\nconst echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });\n\nconst plan = api.addUsagePlan('UsagePlan', {\n name: 'Easy',\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n});\n\nconst key = api.addApiKey('ApiKey');\nplan.addApiKey(key);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Method", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/method.ts", "line": 173 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.MethodProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/method.ts", "line": 160 }, "methods": [ { "docs": { "stability": "stable", "summary": "Add a method response to this method." }, "locationInModule": { "filename": "lib/method.ts", "line": 277 }, "name": "addMethodResponse", "parameters": [ { "name": "methodResponse", "type": { "fqn": "@aws-cdk/aws-apigateway.MethodResponse" } } ] } ], "name": "Method", "properties": [ { "docs": { "stability": "stable", "summary": "The API Gateway RestApi associated with this method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 169 }, "name": "api", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 164 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "remarks": "arn:aws:execute-api:{region}:{account}:{restApiId}/{stage}/{method}/{path}\n\nNOTE: {stage} will refer to the `restApi.deploymentStage`, which will\nautomatically set if auto-deploy is enabled, or can be explicitly assigned.\nWhen not configured, {stage} will be set to '*', as a shorthand for 'all stages'.", "stability": "stable", "summary": "Returns an execute-api ARN for this method:." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 261 }, "name": "methodArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 162 }, "name": "methodId", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 165 }, "name": "resource", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "docs": { "deprecated": "- Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.", "stability": "deprecated", "summary": "The RestApi associated with this Method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 246 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApi" } }, { "docs": { "remarks": "This stage is used by the AWS Console UI when testing the method.", "stability": "stable", "summary": "Returns an execute-api ARN for this method's \"test-invoke-stage\" stage." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 270 }, "name": "testMethodArn", "type": { "primitive": "string" } } ], "symbolId": "lib/method:Method" }, "@aws-cdk/aws-apigateway.MethodDeploymentOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "const api = new apigateway.RestApi(this, 'books');\nconst deployment = new apigateway.Deployment(this, 'my-deployment', { api });\nconst stage = new apigateway.Stage(this, 'my-stage', {\n deployment,\n methodOptions: {\n '/*/*': { // This special path applies to all resource paths and all HTTP methods\n throttlingRateLimit: 100,\n throttlingBurstLimit: 200\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.MethodDeploymentOptions", "kind": "interface", "locationInModule": { "filename": "lib/stage.ts", "line": 127 }, "name": "MethodDeploymentOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether the cached responses are encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 193 }, "name": "cacheDataEncrypted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "Duration.minutes(5)", "remarks": "The\nhigher the TTL, the longer the response will be cached.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html", "stability": "stable", "summary": "Specifies the time to live (TTL), in seconds, for cached responses." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 186 }, "name": "cacheTtl", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- Caching is Disabled.", "remarks": "A\ncache cluster must be enabled on the stage for responses to be cached.", "stability": "stable", "summary": "Specifies whether responses should be cached and returned for requests." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 177 }, "name": "cachingEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, API gateway will log the full API requests and responses.\nThis can be useful to troubleshoot APIs, but can result in logging sensitive data.\nWe recommend that you don't enable this feature for production APIs.", "stability": "stable", "summary": "Specifies whether data trace logging is enabled for this method." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 151 }, "name": "dataTraceEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Off", "stability": "stable", "summary": "Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 141 }, "name": "loggingLevel", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodLoggingLevel" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Specifies whether Amazon CloudWatch metrics are enabled for this method." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 133 }, "name": "metricsEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No additional restriction.", "remarks": "The total rate of all requests in your AWS account is limited to 5,000 requests.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html", "stability": "stable", "summary": "Specifies the throttling burst limit." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 160 }, "name": "throttlingBurstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- No additional restriction.", "remarks": "The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html", "stability": "stable", "summary": "Specifies the throttling rate limit." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 169 }, "name": "throttlingRateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/stage:MethodDeploymentOptions" }, "@aws-cdk/aws-apigateway.MethodLoggingLevel": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "const api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n loggingLevel: apigateway.MethodLoggingLevel.INFO,\n dataTraceEnabled: true\n }\n})", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.MethodLoggingLevel", "kind": "enum", "locationInModule": { "filename": "lib/stage.ts", "line": 121 }, "members": [ { "docs": { "stability": "stable" }, "name": "OFF" }, { "docs": { "stability": "stable" }, "name": "ERROR" }, { "docs": { "stability": "stable" }, "name": "INFO" } ], "name": "MethodLoggingLevel", "symbolId": "lib/stage:MethodLoggingLevel" }, "@aws-cdk/aws-apigateway.MethodOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": " declare const api: apigateway.RestApi;\n declare const userLambda: lambda.Function;\n\n const userModel: apigateway.Model = api.addModel('UserModel', {\n schema: {\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n userId: {\n type: apigateway.JsonSchemaType.STRING\n },\n name: {\n type: apigateway.JsonSchemaType.STRING\n }\n },\n required: ['userId']\n }\n });\n api.root.addResource('user').addMethod('POST',\n new apigateway.LambdaIntegration(userLambda), {\n requestModels: {\n 'application/json': userModel\n }\n }\n );", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.MethodOptions", "kind": "interface", "locationInModule": { "filename": "lib/method.ts", "line": 14 }, "name": "MethodOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether the method requires clients to submit a valid API key." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 45 }, "name": "apiKeyRequired", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no authorization scopes", "remarks": "The scopes are used with\na COGNITO_USER_POOLS authorizer to authorize the method invocation.", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes", "stability": "stable", "summary": "A list of authorization scopes configured on the method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 121 }, "name": "authorizationScopes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- open access unless `authorizer` is specified", "remarks": "If you're using one of the authorizers that are available via the {@link Authorizer} class, such as {@link Authorizer#token()},\nit is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type.\nHowever, specifying an authorization type using this property that conflicts with what is expected by the {@link Authorizer}\nwill result in an error.", "stability": "stable", "summary": "Method authorization. If the value is set of `Custom`, an `authorizer` must also be specified." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 32 }, "name": "authorizationType", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.AuthorizationType" } }, { "abstract": true, "docs": { "remarks": "If specified, the value of `authorizationType` must be set to `Custom`", "stability": "stable", "summary": "If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 39 }, "name": "authorizer", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IAuthorizer" } }, { "abstract": true, "docs": { "default": "None\n\nThis property is not required, but if these are not supplied for a Lambda\nproxy integration, the Lambda function must return a value of the correct format,\nfor the integration response to be correctly mapped to a response to the client.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-response.html", "stability": "stable", "summary": "The responses that can be sent to the client who calls the method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 56 }, "name": "methodResponses", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.MethodResponse" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "For example, you can assign the\nOperationName of ListPets for the GET /pets method.", "stability": "stable", "summary": "A friendly operation name for the method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 19 }, "name": "operationName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": " declare const api: apigateway.RestApi;\n declare const userLambda: lambda.Function;\n\n const userModel: apigateway.Model = api.addModel('UserModel', {\n schema: {\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n userId: {\n type: apigateway.JsonSchemaType.STRING\n },\n name: {\n type: apigateway.JsonSchemaType.STRING\n }\n },\n required: ['userId']\n }\n });\n api.root.addResource('user').addMethod('POST',\n new apigateway.LambdaIntegration(userLambda), {\n requestModels: {\n 'application/json': userModel\n }\n }\n );", "remarks": "When\ncombined with `requestValidator` or `requestValidatorOptions`, the service\nwill validate the API request payload before it reaches the API's Integration (including proxies).\nSpecify `requestModels` as key-value pairs, with a content type\n(e.g. `'application/json'`) as the key and an API Gateway Model as the value.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-request-model", "stability": "stable", "summary": "The models which describe data structure of request payload." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 104 }, "name": "requestModels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.IModel" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "None", "remarks": "Specify request parameters\nas key-value pairs (string-to-Boolean mapping), with a source as the key and\na Boolean as the value. The Boolean specifies whether a parameter is required.\nA source must match the format method.request.location.name, where the location\nis querystring, path, or header, and name is a valid, unique parameter name.", "stability": "stable", "summary": "The request parameters that API Gateway accepts." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 66 }, "name": "requestParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "boolean" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No default validator", "remarks": "Only one of `requestValidator` or `requestValidatorOptions` must be specified.\nWorks together with `requestModels` or `requestParameters` to validate\nthe request before it reaches integration like Lambda Proxy Integration.", "stability": "stable", "summary": "The ID of the associated request validator." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 113 }, "name": "requestValidator", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IRequestValidator" } }, { "abstract": true, "docs": { "default": "- No default validator", "remarks": "Works together with `requestModels` or `requestParameters` to validate\nthe request before it reaches integration like Lambda Proxy Integration.", "stability": "stable", "summary": "Request validator options to create new validator Only one of `requestValidator` or `requestValidatorOptions` must be specified." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 130 }, "name": "requestValidatorOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RequestValidatorOptions" } } ], "symbolId": "lib/method:MethodOptions" }, "@aws-cdk/aws-apigateway.MethodProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const authorizer: apigateway.Authorizer;\ndeclare const integration: apigateway.Integration;\ndeclare const model: apigateway.Model;\ndeclare const requestValidator: apigateway.RequestValidator;\ndeclare const resource: apigateway.Resource;\nconst methodProps: apigateway.MethodProps = {\n httpMethod: 'httpMethod',\n resource: resource,\n\n // the properties below are optional\n integration: integration,\n options: {\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: apigateway.AuthorizationType.NONE,\n authorizer: authorizer,\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: model,\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidator: requestValidator,\n requestValidatorOptions: {\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n },\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.MethodProps", "kind": "interface", "locationInModule": { "filename": "lib/method.ts", "line": 133 }, "name": "MethodProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The HTTP method (\"GET\", \"POST\", \"PUT\", ...) that clients use to call this method." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 143 }, "name": "httpMethod", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "For root resource methods,\nspecify the `RestApi` object.", "stability": "stable", "summary": "The resource this method is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 138 }, "name": "resource", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "abstract": true, "docs": { "default": "- a new `MockIntegration`.", "stability": "stable", "summary": "The backend system that the method calls when it receives a request." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 150 }, "name": "integration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "abstract": true, "docs": { "default": "- No options.", "stability": "stable", "summary": "Method options." }, "immutable": true, "locationInModule": { "filename": "lib/method.ts", "line": 157 }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } } ], "symbolId": "lib/method:MethodProps" }, "@aws-cdk/aws-apigateway.MethodResponse": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const model: apigateway.Model;\nconst methodResponse: apigateway.MethodResponse = {\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.MethodResponse", "kind": "interface", "locationInModule": { "filename": "lib/methodresponse.ts", "line": 3 }, "name": "MethodResponse", "properties": [ { "abstract": true, "docs": { "remarks": "Required.", "stability": "stable", "summary": "The method response's status code, which you map to an IntegrationResponse." }, "immutable": true, "locationInModule": { "filename": "lib/methodresponse.ts", "line": 9 }, "name": "statusCode", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "None", "remarks": "Specify response models as\nkey-value pairs (string-to-string maps), with a content type as the key and a Model\nresource name as the value.", "stability": "stable", "summary": "The resources used for the response's content type." }, "immutable": true, "locationInModule": { "filename": "lib/methodresponse.ts", "line": 27 }, "name": "responseModels", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.IModel" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "None", "remarks": "Specify response parameters as key-value pairs (string-to-Boolean maps), with\na destination as the key and a Boolean as the value. Specify the destination\nusing the following pattern: method.response.header.name, where the name is a\nvalid, unique header name. The Boolean specifies whether a parameter is required.", "stability": "stable", "summary": "Response parameters that API Gateway sends to the client that called a method." }, "immutable": true, "locationInModule": { "filename": "lib/methodresponse.ts", "line": 19 }, "name": "responseParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "boolean" }, "kind": "map" } } } ], "symbolId": "lib/methodresponse:MethodResponse" }, "@aws-cdk/aws-apigateway.MockIntegration": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Integration", "docs": { "remarks": "This is useful for API testing because it\ncan be used to test the integration set up without incurring charges for\nusing the backend and to enable collaborative development of an API. In\ncollaborative development, a team can isolate their development effort by\nsetting up simulations of API components owned by other teams by using the\nMOCK integrations. It is also used to return CORS-related headers to ensure\nthat the API method permits CORS access. In fact, the API Gateway console\nintegrates the OPTIONS method to support CORS with a mock integration.\nGateway responses are other examples of mock integrations.", "stability": "stable", "summary": "This type of integration lets API Gateway return a response without sending the request further to the backend.", "example": "import * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi } from '../../lib';\nimport { RequestAuthorizer } from '../../lib/authorizers';\nimport { IdentitySource } from '../../lib/authorizers/identity-source';\n\n// Against the RestApi endpoint from the stack output, run\n// `curl -s -o /dev/null -w \"%{http_code}\" ` should return 401\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' ?allow=yes` should return 403\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' ?allow=yes` should return 200\n\nconst app = new App();\nconst stack = new Stack(app, 'RequestAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new RequestAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});", "custom": { "exampleMetadata": "lit=test/authorizers/integ.request-authorizer.lit.ts infused" } }, "fqn": "@aws-cdk/aws-apigateway.MockIntegration", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/integrations/mock.ts", "line": 16 }, "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IntegrationOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/integrations/mock.ts", "line": 15 }, "name": "MockIntegration", "symbolId": "lib/integrations/mock:MockIntegration" }, "@aws-cdk/aws-apigateway.Model": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "declare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Model", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/model.ts", "line": 163 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.ModelProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IModel" ], "kind": "class", "locationInModule": { "filename": "lib/model.ts", "line": 110 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/model.ts", "line": 148 }, "name": "fromModelName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "modelName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IModel" } }, "static": true } ], "name": "Model", "properties": [ { "const": true, "docs": { "remarks": "This can be used for mapping\nJSON responses from an integration to what is returned to a client,\nwhere strong typing is not required. In the absence of any defined\nmodel, the Empty model will be used to return the response payload\nunmapped.\n\nDefinition\n{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}", "see": "https://docs.amazonaws.cn/en_us/apigateway/latest/developerguide/models-mappings.html#models-mappings-models", "stability": "stable", "summary": "Represents a reference to a REST API's Empty model, which is available as part of the model collection by default." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 146 }, "name": "EMPTY_MODEL", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IModel" } }, { "const": true, "docs": { "remarks": "This can be used for mapping\nerror JSON responses from an integration to a client, where a simple\ngeneric message field is sufficient to map and return an error payload.\n\nDefinition\n{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Error Schema\",\n \"type\" : \"object\",\n \"properties\" : {\n \"message\" : { \"type\" : \"string\" }\n }\n}", "stability": "stable", "summary": "Represents a reference to a REST API's Error model, which is available as part of the model collection by default." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 127 }, "name": "ERROR_MODEL", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IModel" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Returns the model name, such as 'myModel'." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 161 }, "name": "modelId", "overrides": "@aws-cdk/aws-apigateway.IModel", "type": { "primitive": "string" } } ], "symbolId": "lib/model:Model" }, "@aws-cdk/aws-apigateway.ModelOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const api: apigateway.RestApi;\n\n// We define the JSON Schema for the transformed valid response\nconst responseModel = api.addModel('ResponseModel', {\n contentType: 'application/json',\n modelName: 'ResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'pollResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n greeting: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});\n\n// We define the JSON Schema for the transformed error response\nconst errorResponseModel = api.addModel('ErrorResponseModel', {\n contentType: 'application/json',\n modelName: 'ErrorResponseModel',\n schema: {\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'errorResponse',\n type: apigateway.JsonSchemaType.OBJECT,\n properties: {\n state: { type: apigateway.JsonSchemaType.STRING },\n message: { type: apigateway.JsonSchemaType.STRING }\n }\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ModelOptions", "kind": "interface", "locationInModule": { "filename": "lib/model.ts", "line": 60 }, "name": "ModelOptions", "properties": [ { "abstract": true, "docs": { "remarks": "Specify null ({}) if you don't want to specify a schema.", "stability": "stable", "summary": "The schema to use to transform data to one or more output formats." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 95 }, "name": "schema", "type": { "fqn": "@aws-cdk/aws-apigateway.JsonSchema" } }, { "abstract": true, "docs": { "default": "'application/json'", "remarks": "You can also force a\ncontent type in the request or response model mapping.", "stability": "stable", "summary": "The content type for the model." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 67 }, "name": "contentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "None", "stability": "stable", "summary": "A description that identifies this model." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 73 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": " If you don't specify a name,\nAWS CloudFormation generates a unique physical ID and\nuses that ID for the model name. For more information,\nsee Name Type.", "remarks": "Important\n If you specify a name, you cannot perform updates that\n require replacement of this resource. You can perform\n updates that require no or some interruption. If you\n must replace the resource, specify a new name.", "stability": "stable", "summary": "A name for the model." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 89 }, "name": "modelName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/model:ModelOptions" }, "@aws-cdk/aws-apigateway.ModelProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const default_: any;\ndeclare const enum_: any;\ndeclare const jsonSchema_: apigateway.JsonSchema;\ndeclare const restApi: apigateway.RestApi;\nconst modelProps: apigateway.ModelProps = {\n restApi: restApi,\n schema: {\n additionalItems: [jsonSchema_],\n additionalProperties: false,\n allOf: [jsonSchema_],\n anyOf: [jsonSchema_],\n contains: jsonSchema_,\n default: default_,\n definitions: {\n definitionsKey: jsonSchema_,\n },\n dependencies: {\n dependenciesKey: ['dependencies'],\n },\n description: 'description',\n enum: [enum_],\n exclusiveMaximum: false,\n exclusiveMinimum: false,\n format: 'format',\n id: 'id',\n items: jsonSchema_,\n maximum: 123,\n maxItems: 123,\n maxLength: 123,\n maxProperties: 123,\n minimum: 123,\n minItems: 123,\n minLength: 123,\n minProperties: 123,\n multipleOf: 123,\n not: jsonSchema_,\n oneOf: [jsonSchema_],\n pattern: 'pattern',\n patternProperties: {\n patternPropertiesKey: jsonSchema_,\n },\n properties: {\n propertiesKey: jsonSchema_,\n },\n propertyNames: jsonSchema_,\n ref: 'ref',\n required: ['required'],\n schema: apigateway.JsonSchemaVersion.DRAFT4,\n title: 'title',\n type: apigateway.JsonSchemaType.NULL,\n uniqueItems: false,\n },\n\n // the properties below are optional\n contentType: 'contentType',\n description: 'description',\n modelName: 'modelName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ModelProps", "interfaces": [ "@aws-cdk/aws-apigateway.ModelOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/model.ts", "line": 98 }, "name": "ModelProps", "properties": [ { "abstract": true, "docs": { "remarks": "The reason we need the RestApi object itself and not just the ID is because the model\nis being tracked by the top-level RestApi object for the purpose of calculating it's\nhash to determine the ID of the deployment. This allows us to automatically update\nthe deployment when the model of the REST API changes.", "stability": "stable", "summary": "The rest API that this model is part of." }, "immutable": true, "locationInModule": { "filename": "lib/model.ts", "line": 107 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/model:ModelProps" }, "@aws-cdk/aws-apigateway.PassthroughBehavior": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "example": "import * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi } from '../../lib';\nimport { RequestAuthorizer } from '../../lib/authorizers';\nimport { IdentitySource } from '../../lib/authorizers/identity-source';\n\n// Against the RestApi endpoint from the stack output, run\n// `curl -s -o /dev/null -w \"%{http_code}\" ` should return 401\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' ?allow=yes` should return 403\n// `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' ?allow=yes` should return 200\n\nconst app = new App();\nconst stack = new Stack(app, 'RequestAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new RequestAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});", "custom": { "exampleMetadata": "lit=test/authorizers/integ.request-authorizer.lit.ts infused" } }, "fqn": "@aws-cdk/aws-apigateway.PassthroughBehavior", "kind": "enum", "locationInModule": { "filename": "lib/integration.ts", "line": 298 }, "members": [ { "docs": { "stability": "stable", "summary": "Passes the request body for unmapped content types through to the integration back end without transformation." }, "name": "WHEN_NO_MATCH" }, { "docs": { "stability": "stable", "summary": "Rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response." }, "name": "NEVER" }, { "docs": { "remarks": "However if there is at least one content type defined,\nunmapped content types will be rejected with the same 415 response.", "stability": "stable", "summary": "Allows pass-through when the integration has NO content types mapped to templates." }, "name": "WHEN_NO_TEMPLATES" } ], "name": "PassthroughBehavior", "symbolId": "lib/integration:PassthroughBehavior" }, "@aws-cdk/aws-apigateway.Period": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Time period for which quota settings apply.", "example": "declare const api: apigateway.RestApi;\n\nconst key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {\n customerId: 'hello-customer',\n resources: [api],\n quota: {\n limit: 10000,\n period: apigateway.Period.MONTH\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Period", "kind": "enum", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 32 }, "members": [ { "docs": { "stability": "stable" }, "name": "DAY" }, { "docs": { "stability": "stable" }, "name": "WEEK" }, { "docs": { "stability": "stable" }, "name": "MONTH" } ], "name": "Period", "symbolId": "lib/usage-plan:Period" }, "@aws-cdk/aws-apigateway.ProxyResource": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Resource", "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html", "stability": "stable", "summary": "Defines a {proxy+} greedy resource and an ANY method on a route.", "example": "declare const resource: apigateway.Resource;\ndeclare const handler: lambda.Function;\nconst proxy = resource.addProxy({\n defaultIntegration: new apigateway.LambdaIntegration(handler),\n\n // \"false\" will require explicitly adding methods on the `proxy` resource\n anyMethod: true // \"true\" is the default\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ProxyResource", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 517 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.ProxyResourceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/resource.ts", "line": 510 }, "methods": [ { "docs": { "stability": "stable", "summary": "Defines a new method for this resource." }, "locationInModule": { "filename": "lib/resource.ts", "line": 531 }, "name": "addMethod", "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "parameters": [ { "name": "httpMethod", "type": { "primitive": "string" } }, { "name": "integration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } } ], "name": "ProxyResource", "properties": [ { "docs": { "stability": "stable", "summary": "If `props.anyMethod` is `true`, this will be the reference to the 'ANY' method associated with this proxy resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 515 }, "name": "anyMethod", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } ], "symbolId": "lib/resource:ProxyResource" }, "@aws-cdk/aws-apigateway.ProxyResourceOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const resource: apigateway.Resource;\ndeclare const handler: lambda.Function;\nconst proxy = resource.addProxy({\n defaultIntegration: new apigateway.LambdaIntegration(handler),\n\n // \"false\" will require explicitly adding methods on the `proxy` resource\n anyMethod: true // \"true\" is the default\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ProxyResourceOptions", "interfaces": [ "@aws-cdk/aws-apigateway.ResourceOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 488 }, "name": "ProxyResourceOptions", "properties": [ { "abstract": true, "docs": { "default": "true", "remarks": "If set to `false`, you will have to explicitly\nadd methods to this resource after it's created.", "stability": "stable", "summary": "Adds an \"ANY\" method to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 495 }, "name": "anyMethod", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/resource:ProxyResourceOptions" }, "@aws-cdk/aws-apigateway.ProxyResourceProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const authorizer: apigateway.Authorizer;\ndeclare const integration: apigateway.Integration;\ndeclare const model: apigateway.Model;\ndeclare const requestValidator: apigateway.RequestValidator;\ndeclare const resource: apigateway.Resource;\nconst proxyResourceProps: apigateway.ProxyResourceProps = {\n parent: resource,\n\n // the properties below are optional\n anyMethod: false,\n defaultCorsPreflightOptions: {\n allowOrigins: ['allowOrigins'],\n\n // the properties below are optional\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n disableCache: false,\n exposeHeaders: ['exposeHeaders'],\n maxAge: cdk.Duration.minutes(30),\n statusCode: 123,\n },\n defaultIntegration: integration,\n defaultMethodOptions: {\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: apigateway.AuthorizationType.NONE,\n authorizer: authorizer,\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: model,\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidator: requestValidator,\n requestValidatorOptions: {\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n },\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ProxyResourceProps", "interfaces": [ "@aws-cdk/aws-apigateway.ProxyResourceOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 498 }, "name": "ProxyResourceProps", "properties": [ { "abstract": true, "docs": { "remarks": "You can either pass another\n`Resource` object or a `RestApi` object here.", "stability": "stable", "summary": "The parent resource of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 503 }, "name": "parent", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } ], "symbolId": "lib/resource:ProxyResourceProps" }, "@aws-cdk/aws-apigateway.QuotaSettings": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Specifies the maximum number of requests that clients can make to API Gateway APIs.", "example": "declare const api: apigateway.RestApi;\n\nconst key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {\n customerId: 'hello-customer',\n resources: [api],\n quota: {\n limit: 10000,\n period: apigateway.Period.MONTH\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.QuotaSettings", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 41 }, "name": "QuotaSettings", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "The maximum number of requests that users can make within the specified time period." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 46 }, "name": "limit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "For the initial time period, the number of requests to subtract from the specified limit." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 52 }, "name": "offset", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "The time period for which the maximum limit of requests applies." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 58 }, "name": "period", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Period" } } ], "symbolId": "lib/usage-plan:QuotaSettings" }, "@aws-cdk/aws-apigateway.RateLimitedApiKey": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::ApiGateway::ApiKey", "exampleMetadata": "infused" }, "stability": "stable", "summary": "An API Gateway ApiKey, for which a rate limiting configuration can be specified.", "example": "declare const api: apigateway.RestApi;\n\nconst key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {\n customerId: 'hello-customer',\n resources: [api],\n quota: {\n limit: 10000,\n period: apigateway.Period.MONTH\n }\n});" }, "fqn": "@aws-cdk/aws-apigateway.RateLimitedApiKey", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-key.ts", "line": 231 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RateLimitedApiKeyProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IApiKey" ], "kind": "class", "locationInModule": { "filename": "lib/api-key.ts", "line": 227 }, "methods": [ { "docs": { "stability": "stable", "summary": "Permits the IAM principal all read operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 96 }, "name": "grantRead", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Permits the IAM principal all read and write operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 122 }, "name": "grantReadWrite", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Permits the IAM principal all write operations through this key." }, "locationInModule": { "filename": "lib/api-key.ts", "line": 109 }, "name": "grantWrite", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "RateLimitedApiKey", "properties": [ { "docs": { "stability": "stable", "summary": "The API key ARN." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 229 }, "name": "keyArn", "overrides": "@aws-cdk/aws-apigateway.IApiKey", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The API key ID." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 228 }, "name": "keyId", "overrides": "@aws-cdk/aws-apigateway.IApiKey", "type": { "primitive": "string" } } ], "symbolId": "lib/api-key:RateLimitedApiKey" }, "@aws-cdk/aws-apigateway.RateLimitedApiKeyProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "RateLimitedApiKey properties.", "example": "declare const api: apigateway.RestApi;\n\nconst key = new apigateway.RateLimitedApiKey(this, 'rate-limited-api-key', {\n customerId: 'hello-customer',\n resources: [api],\n quota: {\n limit: 10000,\n period: apigateway.Period.MONTH\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RateLimitedApiKeyProps", "interfaces": [ "@aws-cdk/aws-apigateway.ApiKeyProps" ], "kind": "interface", "locationInModule": { "filename": "lib/api-key.ts", "line": 202 }, "name": "RateLimitedApiKeyProps", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "API Stages to be associated with the RateLimitedApiKey." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 207 }, "name": "apiStages", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.UsagePlanPerApiStage" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Number of requests clients can make in a given time period." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 213 }, "name": "quota", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.QuotaSettings" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Overall throttle settings for the API." }, "immutable": true, "locationInModule": { "filename": "lib/api-key.ts", "line": 219 }, "name": "throttle", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ThrottleSettings" } } ], "symbolId": "lib/api-key:RateLimitedApiKeyProps" }, "@aws-cdk/aws-apigateway.RequestAuthorizer": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Authorizer", "docs": { "custom": { "resource": "AWS::ApiGateway::Authorizer", "exampleMetadata": "infused" }, "remarks": "Based on the request, authorization is performed by a lambda function.", "stability": "stable", "summary": "Request-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.RequestAuthorizer(this, 'booksAuthorizer', {\n handler: authFn,\n identitySources: [apigateway.IdentitySource.header('Authorization')]\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});" }, "fqn": "@aws-cdk/aws-apigateway.RequestAuthorizer", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 224 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.RequestAuthorizerProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IAuthorizer" ], "kind": "class", "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 218 }, "methods": [ { "docs": { "remarks": "Throws an error, during token resolution, if no RestApi is attached to this authorizer.", "stability": "stable", "summary": "Returns a token that resolves to the Rest Api Id at the time of synthesis." }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 120 }, "name": "lazyRestApiId", "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Sets up the permissions necessary for the API Gateway service to invoke the Lambda function." }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 98 }, "name": "setupPermissions", "protected": true } ], "name": "RequestAuthorizer", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 222 }, "name": "authorizerArn", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The id of the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 220 }, "name": "authorizerId", "overrides": "@aws-cdk/aws-apigateway.Authorizer", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The Lambda function handler that this authorizer uses." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 63 }, "name": "handler", "protected": true, "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "docs": { "stability": "stable", "summary": "The IAM role that the API Gateway service assumes while invoking the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 68 }, "name": "role", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 70 }, "name": "restApiId", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/authorizers/lambda:RequestAuthorizer" }, "@aws-cdk/aws-apigateway.RequestAuthorizerProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for RequestAuthorizer.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.RequestAuthorizer(this, 'booksAuthorizer', {\n handler: authFn,\n identitySources: [apigateway.IdentitySource.header('Authorization')]\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RequestAuthorizerProps", "interfaces": [ "@aws-cdk/aws-apigateway.LambdaAuthorizerProps" ], "kind": "interface", "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 195 }, "name": "RequestAuthorizerProps", "properties": [ { "abstract": true, "docs": { "remarks": "Supported parameter types are\nHeader, Query String, Stage Variable, and Context. For instance, extracting an authorization\ntoken from a header would use the identity source `IdentitySource.header('Authorizer')`.\n\nNote: API Gateway uses the specified identity sources as the request authorizer caching key. When caching is\nenabled, API Gateway calls the authorizer's Lambda function only after successfully verifying that all the\nspecified identity sources are present at runtime. If a specified identify source is missing, null, or empty,\nAPI Gateway returns a 401 Unauthorized response without calling the authorizer Lambda function.", "see": "https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource", "stability": "stable", "summary": "An array of request header mapping expressions for identities." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 208 }, "name": "identitySources", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/authorizers/lambda:RequestAuthorizerProps" }, "@aws-cdk/aws-apigateway.RequestContext": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "remarks": "More details can be found at mapping templates documentation.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html", "stability": "stable", "summary": "Configure what must be included in the `requestContext`.", "example": "new apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {\n stateMachine: machine,\n headers: true,\n path: false,\n querystring: false,\n authorizer: false,\n requestContext: {\n caller: true,\n user: true,\n },\n});", "custom": { "exampleMetadata": "fixture=stepfunctions infused" } }, "fqn": "@aws-cdk/aws-apigateway.RequestContext", "kind": "interface", "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 7 }, "name": "RequestContext", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "Whether the AWS account of the API owner should be included in the request context", "stability": "stable", "summary": "Represents the information of $context.identity.accountId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 14 }, "name": "accountId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the identifier API Gateway assigns to your API should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.apiId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 22 }, "name": "apiId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the API key associated with the request should be included in request context.", "stability": "stable", "summary": "Represents the information of $context.identity.apiKey." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 30 }, "name": "apiKey", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the principal user identifier associated with the token sent by the client and returned\nfrom an API Gateway Lambda authorizer should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.authorizer.principalId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 39 }, "name": "authorizerPrincipalId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the principal identifier of the caller that signed the request should be included in the request context.\nSupported for resources that use IAM authorization.", "stability": "stable", "summary": "Represents the information of $context.identity.caller." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 48 }, "name": "caller", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the list of the Amazon Cognito authentication providers used by the caller making the request should be included in the request context.\nAvailable only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "Represents the information of $context.identity.cognitoAuthenticationProvider." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 57 }, "name": "cognitoAuthenticationProvider", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the Amazon Cognito authentication type of the caller making the request should be included in the request context.\nAvailable only if the request was signed with Amazon Cognito credentials.\nPossible values include authenticated for authenticated identities and unauthenticated for unauthenticated identities.", "stability": "stable", "summary": "Represents the information of $context.identity.cognitoAuthenticationType." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 67 }, "name": "cognitoAuthenticationType", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the Amazon Cognito identity ID of the caller making the request should be included in the request context.\nAvailable only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "Represents the information of $context.identity.cognitoIdentityId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 76 }, "name": "cognitoIdentityId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the Amazon Cognito identity pool ID of the caller making the request should be included in the request context.\nAvailable only if the request was signed with Amazon Cognito credentials.", "stability": "stable", "summary": "Represents the information of $context.identity.cognitoIdentityPoolId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 85 }, "name": "cognitoIdentityPoolId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the HTTP method used should be included in the request context.\nValid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.", "stability": "stable", "summary": "Represents the information of $context.httpMethod." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 94 }, "name": "httpMethod", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the ID for the request should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.requestId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 144 }, "name": "requestId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the identifier that API Gateway assigns to your resource should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.resourceId." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 152 }, "name": "resourceId", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the path to the resource should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.resourcePath." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 160 }, "name": "resourcePath", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the source IP address of the immediate TCP connection making the request\nto API Gateway endpoint should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.identity.sourceIp." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 111 }, "name": "sourceIp", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the deployment stage of the API request should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.stage." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 102 }, "name": "stage", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the principal identifier of the user that will be authorized should be included in the request context.\nSupported for resources that use IAM authorization.", "stability": "stable", "summary": "Represents the information of $context.identity.user." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 120 }, "name": "user", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the User-Agent header of the API caller should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.identity.userAgent." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 128 }, "name": "userAgent", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Whether the Amazon Resource Name (ARN) of the effective user identified after authentication should be included in the request context.", "stability": "stable", "summary": "Represents the information of $context.identity.userArn." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/request-context.ts", "line": 136 }, "name": "userArn", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/integrations/request-context:RequestContext" }, "@aws-cdk/aws-apigateway.RequestValidator": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const restApi: apigateway.RestApi;\nconst requestValidator = new apigateway.RequestValidator(this, 'MyRequestValidator', {\n restApi: restApi,\n\n // the properties below are optional\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.RequestValidator", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 67 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.RequestValidatorProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IRequestValidator" ], "kind": "class", "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 51 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 52 }, "name": "fromRequestValidatorId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "requestValidatorId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IRequestValidator" } }, "static": true } ], "name": "RequestValidator", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "ID of the request validator, such as abc123." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 65 }, "name": "requestValidatorId", "overrides": "@aws-cdk/aws-apigateway.IRequestValidator", "type": { "primitive": "string" } } ], "symbolId": "lib/requestvalidator:RequestValidator" }, "@aws-cdk/aws-apigateway.RequestValidatorOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const integration: apigateway.LambdaIntegration;\ndeclare const resource: apigateway.Resource;\ndeclare const responseModel: apigateway.Model;\ndeclare const errorResponseModel: apigateway.Model;\n\nresource.addMethod('GET', integration, {\n // We can mark the parameters as required\n requestParameters: {\n 'method.request.querystring.who': true\n },\n // we can set request validator options like below\n requestValidatorOptions: {\n requestValidatorName: 'test-validator',\n validateRequestBody: true,\n validateRequestParameters: false\n },\n methodResponses: [\n {\n // Successful response from the integration\n statusCode: '200',\n // Define what parameters are allowed or not\n responseParameters: {\n 'method.response.header.Content-Type': true,\n 'method.response.header.Access-Control-Allow-Origin': true,\n 'method.response.header.Access-Control-Allow-Credentials': true\n },\n // Validate the schema on the response\n responseModels: {\n 'application/json': responseModel\n }\n },\n {\n // Same thing for the error responses\n statusCode: '400',\n responseParameters: {\n 'method.response.header.Content-Type': true,\n 'method.response.header.Access-Control-Allow-Origin': true,\n 'method.response.header.Access-Control-Allow-Credentials': true\n },\n responseModels: {\n 'application/json': errorResponseModel\n }\n }\n ]\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RequestValidatorOptions", "kind": "interface", "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 15 }, "name": "RequestValidatorOptions", "properties": [ { "abstract": true, "docs": { "default": "None", "stability": "stable", "summary": "The name of this request validator." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 21 }, "name": "requestValidatorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether to validate the request body according to the configured schema for the targeted API and method." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 29 }, "name": "validateRequestBody", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether to validate request parameters." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 36 }, "name": "validateRequestParameters", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/requestvalidator:RequestValidatorOptions" }, "@aws-cdk/aws-apigateway.RequestValidatorProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const restApi: apigateway.RestApi;\nconst requestValidatorProps: apigateway.RequestValidatorProps = {\n restApi: restApi,\n\n // the properties below are optional\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.RequestValidatorProps", "interfaces": [ "@aws-cdk/aws-apigateway.RequestValidatorOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 39 }, "name": "RequestValidatorProps", "properties": [ { "abstract": true, "docs": { "remarks": "The reason we need the RestApi object itself and not just the ID is because the model\nis being tracked by the top-level RestApi object for the purpose of calculating it's\nhash to determine the ID of the deployment. This allows us to automatically update\nthe deployment when the model of the REST API changes.", "stability": "stable", "summary": "The rest API that this model is part of." }, "immutable": true, "locationInModule": { "filename": "lib/requestvalidator.ts", "line": 48 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/requestvalidator:RequestValidatorProps" }, "@aws-cdk/aws-apigateway.Resource": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.ResourceBase", "docs": { "stability": "stable", "example": "declare const booksBackend: apigateway.LambdaIntegration;\nconst api = new apigateway.RestApi(this, 'books', {\n defaultIntegration: booksBackend\n});\n\nconst books = api.root.addResource('books');\nbooks.addMethod('GET'); // integrated with `booksBackend`\nbooks.addMethod('POST'); // integrated with `booksBackend`\n\nconst book = books.addResource('{book_id}');\nbook.addMethod('GET'); // integrated with `booksBackend`", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Resource", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 430 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.ResourceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/resource.ts", "line": 396 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing resource." }, "locationInModule": { "filename": "lib/resource.ts", "line": 400 }, "name": "fromResourceAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-apigateway.ResourceAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, "static": true } ], "name": "Resource", "properties": [ { "docs": { "remarks": "The reason we need the RestApi object itself and not just the ID is because the model\nis being tracked by the top-level RestApi object for the purpose of calculating it's\nhash to determine the ID of the deployment. This allows us to automatically update\nthe deployment when the model of the REST API changes.", "stability": "stable", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 422 }, "name": "api", "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "docs": { "stability": "stable", "summary": "The full path of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 424 }, "name": "path", "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 423 }, "name": "resourceId", "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "primitive": "string" } }, { "docs": { "deprecated": "- Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.", "stability": "deprecated", "summary": "The RestApi associated with this Resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 480 }, "name": "restApi", "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApi" } }, { "docs": { "stability": "stable", "summary": "Default options for CORS preflight OPTIONS method." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 428 }, "name": "defaultCorsPreflightOptions", "optional": true, "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } }, { "docs": { "stability": "stable", "summary": "An integration to use as a default for all methods created within this API unless an integration is specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 426 }, "name": "defaultIntegration", "optional": true, "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "docs": { "stability": "stable", "summary": "Method options to use as a default for all methods created within this API unless custom options are specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 427 }, "name": "defaultMethodOptions", "optional": true, "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } }, { "docs": { "stability": "stable", "summary": "The parent of this resource or undefined for the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 421 }, "name": "parentResource", "optional": true, "overrides": "@aws-cdk/aws-apigateway.ResourceBase", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } ], "symbolId": "lib/resource:Resource" }, "@aws-cdk/aws-apigateway.ResourceAttributes": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes that can be specified when importing a Resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const restApi: apigateway.RestApi;\nconst resourceAttributes: apigateway.ResourceAttributes = {\n path: 'path',\n resourceId: 'resourceId',\n restApi: restApi,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ResourceAttributes", "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 379 }, "name": "ResourceAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The full path of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 393 }, "name": "path", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 383 }, "name": "resourceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 388 }, "name": "restApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } } ], "symbolId": "lib/resource:ResourceAttributes" }, "@aws-cdk/aws-apigateway.ResourceBase": { "abstract": true, "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-apigateway.ResourceBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 178 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IResource" ], "kind": "class", "locationInModule": { "filename": "lib/resource.ts", "line": 163 }, "methods": [ { "docs": { "remarks": "Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional\nHTTP headers to tell browsers to give a web application running at one\norigin, access to selected resources from a different origin. A web\napplication executes a cross-origin HTTP request when it requests a\nresource that has a different origin (domain, protocol, or port) from its\nown.", "stability": "stable", "summary": "Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests." }, "locationInModule": { "filename": "lib/resource.ts", "line": 194 }, "name": "addCorsPreflight", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } }, { "docs": { "stability": "stable", "summary": "Defines a new method for this resource." }, "locationInModule": { "filename": "lib/resource.ts", "line": 186 }, "name": "addMethod", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "httpMethod", "type": { "primitive": "string" } }, { "name": "integration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } } }, { "docs": { "stability": "stable", "summary": "Adds a greedy proxy resource (\"{proxy+}\") and an ANY method to this route." }, "locationInModule": { "filename": "lib/resource.ts", "line": 190 }, "name": "addProxy", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ProxyResourceOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ProxyResource" } } }, { "docs": { "stability": "stable", "summary": "Defines a new child resource where this resource is the parent." }, "locationInModule": { "filename": "lib/resource.ts", "line": 182 }, "name": "addResource", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "pathPart", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResourceOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Resource" } } }, { "docs": { "stability": "stable", "summary": "Retrieves a child resource by path part." }, "locationInModule": { "filename": "lib/resource.ts", "line": 329 }, "name": "getResource", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "pathPart", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } }, { "docs": { "remarks": "- Path may only start with \"/\" if this method is called on the root resource.\n- All resources are created using default options.", "stability": "stable", "summary": "Gets or create all resources leading up to the specified path." }, "locationInModule": { "filename": "lib/resource.ts", "line": 340 }, "name": "resourceForPath", "overrides": "@aws-cdk/aws-apigateway.IResource", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Resource" } } } ], "name": "ResourceBase", "properties": [ { "abstract": true, "docs": { "remarks": "The reason we need the RestApi object itself and not just the ID is because the model\nis being tracked by the top-level RestApi object for the purpose of calculating it's\nhash to determine the ID of the deployment. This allows us to automatically update\nthe deployment when the model of the REST API changes.", "stability": "stable", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 169 }, "name": "api", "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The full path of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 171 }, "name": "path", "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 170 }, "name": "resourceId", "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- Throws an error if this Resource is not associated with an instance of `RestApi`. Use `api` instead.", "stability": "deprecated", "summary": "The rest API that this resource is part of." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 168 }, "name": "restApi", "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApi" } }, { "docs": { "deprecated": "- Throws error in some use cases that have been enabled since this deprecation notice. Use `RestApi.urlForPath()` instead.", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 371 }, "name": "url", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Default options for CORS preflight OPTIONS method." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 174 }, "name": "defaultCorsPreflightOptions", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "An integration to use as a default for all methods created within this API unless an integration is specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 172 }, "name": "defaultIntegration", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Method options to use as a default for all methods created within this API unless custom options are specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 173 }, "name": "defaultMethodOptions", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent of this resource or undefined for the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 164 }, "name": "parentResource", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IResource", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } ], "symbolId": "lib/resource:ResourceBase" }, "@aws-cdk/aws-apigateway.ResourceOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const resource: apigateway.Resource;\n\nconst subtree = resource.addResource('subtree', {\n defaultCorsPreflightOptions: {\n allowOrigins: [ 'https://amazon.com' ]\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ResourceOptions", "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 122 }, "name": "ResourceOptions", "properties": [ { "abstract": true, "docs": { "default": "- CORS is disabled", "remarks": "You can add CORS at the resource-level using `addCorsPreflight`.", "stability": "stable", "summary": "Adds a CORS preflight OPTIONS method to this resource and all child resources." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 147 }, "name": "defaultCorsPreflightOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CorsOptions" } }, { "abstract": true, "docs": { "default": "- Inherited from parent.", "stability": "stable", "summary": "An integration to use as a default for all methods created within this API unless an integration is specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 129 }, "name": "defaultIntegration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Integration" } }, { "abstract": true, "docs": { "default": "- Inherited from parent.", "stability": "stable", "summary": "Method options to use as a default for all methods created within this API unless custom options are specified." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 137 }, "name": "defaultMethodOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.MethodOptions" } } ], "symbolId": "lib/resource:ResourceOptions" }, "@aws-cdk/aws-apigateway.ResourceProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const authorizer: apigateway.Authorizer;\ndeclare const integration: apigateway.Integration;\ndeclare const model: apigateway.Model;\ndeclare const requestValidator: apigateway.RequestValidator;\ndeclare const resource: apigateway.Resource;\nconst resourceProps: apigateway.ResourceProps = {\n parent: resource,\n pathPart: 'pathPart',\n\n // the properties below are optional\n defaultCorsPreflightOptions: {\n allowOrigins: ['allowOrigins'],\n\n // the properties below are optional\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n disableCache: false,\n exposeHeaders: ['exposeHeaders'],\n maxAge: cdk.Duration.minutes(30),\n statusCode: 123,\n },\n defaultIntegration: integration,\n defaultMethodOptions: {\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: apigateway.AuthorizationType.NONE,\n authorizer: authorizer,\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: model,\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidator: requestValidator,\n requestValidatorOptions: {\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n },\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ResourceProps", "interfaces": [ "@aws-cdk/aws-apigateway.ResourceOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/resource.ts", "line": 150 }, "name": "ResourceProps", "properties": [ { "abstract": true, "docs": { "remarks": "You can either pass another\n`Resource` object or a `RestApi` object here.", "stability": "stable", "summary": "The parent resource of this resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 155 }, "name": "parent", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A path name for the resource." }, "immutable": true, "locationInModule": { "filename": "lib/resource.ts", "line": 160 }, "name": "pathPart", "type": { "primitive": "string" } } ], "symbolId": "lib/resource:ResourceProps" }, "@aws-cdk/aws-apigateway.ResponseType": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html", "stability": "stable", "summary": "Supported types of gateway responses.", "example": "const api = new apigateway.RestApi(this, 'books-api');\napi.addGatewayResponse('test-response', {\n type: apigateway.ResponseType.ACCESS_DENIED,\n statusCode: '500',\n responseHeaders: {\n 'Access-Control-Allow-Origin': \"test.com\",\n 'test-key': 'test-value'\n },\n templates: {\n 'application/json': '{ \"message\": $context.error.messageString, \"statusCode\": \"488\", \"type\": \"$context.error.responseType\" }'\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.ResponseType", "kind": "class", "locationInModule": { "filename": "lib/gateway-response.ts", "line": 101 }, "methods": [ { "docs": { "stability": "stable", "summary": "A custom response type to support future cases." }, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 210 }, "name": "of", "parameters": [ { "name": "type", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, "static": true } ], "name": "ResponseType", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for authorization failure." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 105 }, "name": "ACCESS_DENIED", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an invalid API configuration." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 110 }, "name": "API_CONFIGURATION_ERROR", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for failing to connect to a custom or Amazon Cognito authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 120 }, "name": "AUTHORIZER_CONFIGURATION_ERROR", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when a custom or Amazon Cognito authorizer failed to authenticate the caller." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 115 }, "name": "AUTHORIZER_FAILURE", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when the request body cannot be validated according to an enabled request validator." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 130 }, "name": "BAD_REQUEST_BODY", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when the request parameter cannot be validated according to an enabled request validator." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 125 }, "name": "BAD_REQUEST_PARAMETERS", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The default gateway response for an unspecified response type with the status code of 4XX." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 135 }, "name": "DEFAULT_4XX", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The default gateway response for an unspecified response type with a status code of 5XX." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 140 }, "name": "DEFAULT_5XX", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an AWS authentication token expired error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 145 }, "name": "EXPIRED_TOKEN", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an integration failed error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 155 }, "name": "INTEGRATION_FAILURE", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an integration timed out error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 160 }, "name": "INTEGRATION_TIMEOUT", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an invalid API key submitted for a method requiring an API key." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 165 }, "name": "INVALID_API_KEY", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for an invalid AWS signature error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 150 }, "name": "INVALID_SIGNATURE", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for a missing authentication token error, including the cases when the client attempts to invoke an unsupported API method or resource." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 171 }, "name": "MISSING_AUTHENTICATION_TOKEN", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for the usage plan quota exceeded error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 176 }, "name": "QUOTA_EXCEEDED", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response for the request too large error." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 181 }, "name": "REQUEST_TOO_LARGE", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when API Gateway cannot find the specified resource after an API request passes authentication and authorization." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 187 }, "name": "RESOURCE_NOT_FOUND", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when usage plan, method, stage, or account level throttling limits exceeded." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 192 }, "name": "THROTTLED", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when the custom or Amazon Cognito authorizer failed to authenticate the caller." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 197 }, "name": "UNAUTHORIZED", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when a payload is of an unsupported media type, if strict passthrough behavior is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 202 }, "name": "UNSUPPORTED_MEDIA_TYPE", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "const": true, "docs": { "stability": "stable", "summary": "The gateway response when a request is blocked by AWS WAF." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 207 }, "name": "WAF_FILTERED", "static": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ResponseType" } }, { "docs": { "stability": "stable", "summary": "Valid value of response type." }, "immutable": true, "locationInModule": { "filename": "lib/gateway-response.ts", "line": 217 }, "name": "responseType", "type": { "primitive": "string" } } ], "symbolId": "lib/gateway-response:ResponseType" }, "@aws-cdk/aws-apigateway.RestApi": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.RestApiBase", "docs": { "remarks": "Use `addResource` and `addMethod` to configure the API model.\n\nBy default, the API will automatically be deployed and accessible from a\npublic endpoint.", "stability": "stable", "summary": "Represents a REST API in Amazon API Gateway.", "example": " const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),\n });\n\n const api = new apigateway.RestApi(this, 'Api', {\n restApiName: 'MyApi',\n });\n api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RestApi", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 738 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RestApiProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/restapi.ts", "line": 689 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing RestApi that can be configured with additional Methods and Resources." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 712 }, "name": "fromRestApiAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApiAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Import an existing RestApi." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 693 }, "name": "fromRestApiId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "restApiId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a new model." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 781 }, "name": "addModel", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.ModelOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.Model" } } }, { "docs": { "stability": "stable", "summary": "Adds a new request validator." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 791 }, "name": "addRequestValidator", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.RequestValidatorOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.RequestValidator" } } }, { "docs": { "stability": "stable", "summary": "Performs validation of the REST API." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 834 }, "name": "validate", "overrides": "@aws-cdk/core.Construct", "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "RestApi", "properties": [ { "docs": { "stability": "stable", "summary": "The list of methods bound to this RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 731 }, "name": "methods", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.Method" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The ID of this API Gateway RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 722 }, "name": "restApiId", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The resource ID of the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 726 }, "name": "restApiRootResourceId", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "primitive": "string" } }, { "docs": { "remarks": "Resources and Methods are added to this resource.", "stability": "stable", "summary": "Represents the root resource of this API endpoint ('/')." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 724 }, "name": "root", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "docs": { "stability": "stable", "summary": "The deployed root URL of this REST API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 774 }, "name": "url", "type": { "primitive": "string" } } ], "symbolId": "lib/restapi:RestApi" }, "@aws-cdk/aws-apigateway.RestApiAttributes": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes that can be specified when importing a RestApi.", "example": "import { App, CfnOutput, NestedStack, NestedStackProps, Stack } from '@aws-cdk/core';\nimport { Construct } from 'constructs';\nimport { Deployment, Method, MockIntegration, PassthroughBehavior, RestApi, Stage } from '../lib';\n\n/**\n * This file showcases how to split up a RestApi's Resources and Methods across nested stacks.\n *\n * The root stack 'RootStack' first defines a RestApi.\n * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.\n * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.\n *\n * To verify this worked, go to the APIGateway\n */\n\nclass RootStack extends Stack {\n constructor(scope: Construct) {\n super(scope, 'integ-restapi-import-RootStack');\n\n const restApi = new RestApi(this, 'RestApi', {\n deploy: false,\n });\n restApi.root.addMethod('ANY');\n\n const petsStack = new PetsStack(this, {\n restApiId: restApi.restApiId,\n rootResourceId: restApi.restApiRootResourceId,\n });\n const booksStack = new BooksStack(this, {\n restApiId: restApi.restApiId,\n rootResourceId: restApi.restApiRootResourceId,\n });\n new DeployStack(this, {\n restApiId: restApi.restApiId,\n methods: petsStack.methods.concat(booksStack.methods),\n });\n\n new CfnOutput(this, 'PetsURL', {\n value: `https://${restApi.restApiId}.execute-api.${this.region}.amazonaws.com/prod/pets`,\n });\n\n new CfnOutput(this, 'BooksURL', {\n value: `https://${restApi.restApiId}.execute-api.${this.region}.amazonaws.com/prod/books`,\n });\n }\n}\n\ninterface ResourceNestedStackProps extends NestedStackProps {\n readonly restApiId: string;\n\n readonly rootResourceId: string;\n}\n\nclass PetsStack extends NestedStack {\n public readonly methods: Method[] = [];\n\n constructor(scope: Construct, props: ResourceNestedStackProps) {\n super(scope, 'integ-restapi-import-PetsStack', props);\n\n const api = RestApi.fromRestApiAttributes(this, 'RestApi', {\n restApiId: props.restApiId,\n rootResourceId: props.rootResourceId,\n });\n\n const method = api.root.addResource('pets').addMethod('GET', new MockIntegration({\n integrationResponses: [{\n statusCode: '200',\n }],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n }), {\n methodResponses: [{ statusCode: '200' }],\n });\n\n this.methods.push(method);\n }\n}\n\nclass BooksStack extends NestedStack {\n public readonly methods: Method[] = [];\n\n constructor(scope: Construct, props: ResourceNestedStackProps) {\n super(scope, 'integ-restapi-import-BooksStack', props);\n\n const api = RestApi.fromRestApiAttributes(this, 'RestApi', {\n restApiId: props.restApiId,\n rootResourceId: props.rootResourceId,\n });\n\n const method = api.root.addResource('books').addMethod('GET', new MockIntegration({\n integrationResponses: [{\n statusCode: '200',\n }],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n }), {\n methodResponses: [{ statusCode: '200' }],\n });\n\n this.methods.push(method);\n }\n}\n\ninterface DeployStackProps extends NestedStackProps {\n readonly restApiId: string;\n\n readonly methods?: Method[];\n}\n\nclass DeployStack extends NestedStack {\n constructor(scope: Construct, props: DeployStackProps) {\n super(scope, 'integ-restapi-import-DeployStack', props);\n\n const deployment = new Deployment(this, 'Deployment', {\n api: RestApi.fromRestApiId(this, 'RestApi', props.restApiId),\n });\n if (props.methods) {\n for (const method of props.methods) {\n deployment.node.addDependency(method);\n }\n }\n new Stage(this, 'Stage', { deployment });\n }\n}\n\nnew RootStack(new App());", "custom": { "exampleMetadata": "lit=test/integ.restapi-import.lit.ts infused" } }, "fqn": "@aws-cdk/aws-apigateway.RestApiAttributes", "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 669 }, "name": "RestApiAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the API Gateway RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 673 }, "name": "restApiId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The resource ID of the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 678 }, "name": "rootResourceId", "type": { "primitive": "string" } } ], "symbolId": "lib/restapi:RestApiAttributes" }, "@aws-cdk/aws-apigateway.RestApiBase": { "abstract": true, "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Base implementation that are common to various implementations of IRestApi.", "example": "import * as route53 from '@aws-cdk/aws-route53';\nimport * as targets from '@aws-cdk/aws-route53-targets';\n\ndeclare const api: apigateway.RestApi;\ndeclare const hostedZoneForExampleCom: any;\n\nnew route53.ARecord(this, 'CustomDomainAliasRecord', {\n zone: hostedZoneForExampleCom,\n target: route53.RecordTarget.fromAlias(new targets.ApiGateway(api))\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RestApiBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 324 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RestApiBaseProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IRestApi" ], "kind": "class", "locationInModule": { "filename": "lib/restapi.ts", "line": 261 }, "methods": [ { "docs": { "stability": "stable", "summary": "Add an ApiKey." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 400 }, "name": "addApiKey", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ApiKeyOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IApiKey" } } }, { "docs": { "stability": "stable", "summary": "Defines an API Gateway domain name and maps it to this API." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 352 }, "name": "addDomainName", "parameters": [ { "docs": { "summary": "The construct id." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "custom domain options." }, "name": "options", "type": { "fqn": "@aws-cdk/aws-apigateway.DomainNameOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.DomainName" } } }, { "docs": { "stability": "stable", "summary": "Adds a new gateway response." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 390 }, "name": "addGatewayResponse", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-apigateway.GatewayResponseOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.GatewayResponse" } } }, { "docs": { "stability": "stable", "summary": "Adds a usage plan." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 366 }, "name": "addUsagePlan", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.UsagePlanProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.UsagePlan" } } }, { "docs": { "stability": "stable", "summary": "Gets the \"execute-api\" ARN." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 370 }, "name": "arnForExecuteApi", "overrides": "@aws-cdk/aws-apigateway.IRestApi", "parameters": [ { "name": "method", "optional": true, "type": { "primitive": "string" } }, { "name": "path", "optional": true, "type": { "primitive": "string" } }, { "name": "stage", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } }, { "docs": { "deprecated": "This method will be made internal. No replacement", "stability": "deprecated" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 538 }, "name": "configureCloudWatchRole", "parameters": [ { "name": "apiResource", "type": { "fqn": "@aws-cdk/aws-apigateway.CfnRestApi" } } ], "protected": true }, { "docs": { "deprecated": "This method will be made internal. No replacement", "stability": "deprecated" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 545 }, "name": "configureDeployment", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.RestApiBaseProps" } } ], "protected": true }, { "docs": { "stability": "stable", "summary": "Returns the given named metric for this API." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 410 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of requests served from the API cache in a given period." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 442 }, "name": "metricCacheHitCount", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of requests served from the backend in a given period, when API caching is enabled." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 452 }, "name": "metricCacheMissCount", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of client-side errors captured in a given period." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 424 }, "name": "metricClientError", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sample count over 5 minutes", "stability": "stable", "summary": "Metric for the total number API requests in a given period." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 461 }, "name": "metricCount", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: average over 5 minutes.", "stability": "stable", "summary": "Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 474 }, "name": "metricIntegrationLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "The latency includes the integration latency and other API Gateway overhead.\n\nDefault: average over 5 minutes.", "stability": "stable", "summary": "The time between when API Gateway receives a request from a client and when it returns a response to the client." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 485 }, "name": "metricLatency", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Default: sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of server-side errors captured in a given period." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 433 }, "name": "metricServerError", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Fails if `deploymentStage` is not set either by `deploy` or explicitly.", "stability": "stable", "summary": "Returns the URL for an HTTP path." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 339 }, "name": "urlForPath", "parameters": [ { "name": "path", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "RestApiBase", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of this API Gateway RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 290 }, "name": "restApiId", "overrides": "@aws-cdk/aws-apigateway.IRestApi", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "remarks": "Note that this is different from `restApiId`.", "stability": "stable", "summary": "A human friendly name for this Rest API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 317 }, "name": "restApiName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The resource ID of the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 297 }, "name": "restApiRootResourceId", "overrides": "@aws-cdk/aws-apigateway.IRestApi", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Resources and Methods are added to this resource.", "stability": "stable", "summary": "Represents the root resource of this API endpoint ('/')." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 303 }, "name": "root", "overrides": "@aws-cdk/aws-apigateway.IRestApi", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } }, { "docs": { "stability": "stable", "summary": "The first domain name mapped to this API, if defined through the `domainName` configuration prop, or added via `addDomainName`." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 283 }, "name": "domainName", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.DomainName" } }, { "docs": { "remarks": "This resource will be automatically updated every time the REST API model changes.\nThis will be undefined if `deploy` is false.", "stability": "stable", "summary": "API Gateway deployment that represents the latest changes of the API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 275 }, "name": "latestDeployment", "optional": true, "overrides": "@aws-cdk/aws-apigateway.IRestApi", "type": { "fqn": "@aws-cdk/aws-apigateway.Deployment" } }, { "docs": { "remarks": "If `deploy` is disabled, you will need to explicitly assign this value in order to\nset up integrations.", "stability": "stable", "summary": "API Gateway stage that points to the latest deployment (if defined)." }, "locationInModule": { "filename": "lib/restapi.ts", "line": 311 }, "name": "deploymentStage", "overrides": "@aws-cdk/aws-apigateway.IRestApi", "type": { "fqn": "@aws-cdk/aws-apigateway.Stage" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 322 }, "name": "cloudWatchAccount", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-apigateway.CfnAccount" } } ], "symbolId": "lib/restapi:RestApiBase" }, "@aws-cdk/aws-apigateway.RestApiBaseProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Represents the props that all Rest APIs share.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as certificatemanager from '@aws-cdk/aws-certificatemanager';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const accessLogDestination: apigateway.IAccessLogDestination;\ndeclare const accessLogFormat: apigateway.AccessLogFormat;\ndeclare const bucket: s3.Bucket;\ndeclare const certificate: certificatemanager.Certificate;\ndeclare const policyDocument: iam.PolicyDocument;\nconst restApiBaseProps: apigateway.RestApiBaseProps = {\n cloudWatchRole: false,\n deploy: false,\n deployOptions: {\n accessLogDestination: accessLogDestination,\n accessLogFormat: accessLogFormat,\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n cacheDataEncrypted: false,\n cacheTtl: cdk.Duration.minutes(30),\n cachingEnabled: false,\n clientCertificateId: 'clientCertificateId',\n dataTraceEnabled: false,\n description: 'description',\n documentationVersion: 'documentationVersion',\n loggingLevel: apigateway.MethodLoggingLevel.OFF,\n methodOptions: {\n methodOptionsKey: {\n cacheDataEncrypted: false,\n cacheTtl: cdk.Duration.minutes(30),\n cachingEnabled: false,\n dataTraceEnabled: false,\n loggingLevel: apigateway.MethodLoggingLevel.OFF,\n metricsEnabled: false,\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n },\n },\n metricsEnabled: false,\n stageName: 'stageName',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n },\n disableExecuteApiEndpoint: false,\n domainName: {\n certificate: certificate,\n domainName: 'domainName',\n\n // the properties below are optional\n basePath: 'basePath',\n endpointType: apigateway.EndpointType.EDGE,\n mtls: {\n bucket: bucket,\n key: 'key',\n\n // the properties below are optional\n version: 'version',\n },\n securityPolicy: apigateway.SecurityPolicy.TLS_1_0,\n },\n endpointExportName: 'endpointExportName',\n endpointTypes: [apigateway.EndpointType.EDGE],\n failOnWarnings: false,\n parameters: {\n parametersKey: 'parameters',\n },\n policy: policyDocument,\n restApiName: 'restApiName',\n retainDeployments: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.RestApiBaseProps", "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 73 }, "name": "RestApiBaseProps", "properties": [ { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically configure an AWS CloudWatch role for API Gateway." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 157 }, "name": "cloudWatchRole", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Since API Gateway deployments are immutable, When this option is enabled\n(by default), an AWS::ApiGateway::Deployment resource will automatically\ncreated with a logical ID that hashes the API model (methods, resources\nand options). This means that when the model changes, the logical ID of\nthis CloudFormation resource will change, and a new deployment will be\ncreated.\n\nIf this is set, `latestDeployment` will refer to the `Deployment` object\nand `deploymentStage` will refer to a `Stage` that points to this\ndeployment. To customize the stage options, use the `deployOptions`\nproperty.\n\nA CloudFormation Output will also be defined with the root URL endpoint\nof this REST API.", "stability": "stable", "summary": "Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 95 }, "name": "deploy", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Based on defaults of `StageOptions`.", "remarks": "If `deploy` is disabled,\nthis value cannot be set.", "stability": "stable", "summary": "Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 104 }, "name": "deployOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.StageOptions" } }, { "abstract": true, "docs": { "default": "false", "remarks": "To require that clients use a custom domain name to invoke the\nAPI, disable the default endpoint.", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html", "stability": "stable", "summary": "Specifies whether clients can invoke the API using the default execute-api endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 182 }, "name": "disableExecuteApiEndpoint", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no domain name is defined, use `addDomainName` or directly define a `DomainName`.", "stability": "stable", "summary": "Configure a custom domain name and map it to this API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 150 }, "name": "domainName", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.DomainNameOptions" } }, { "abstract": true, "docs": { "default": "- when no export name is given, output will be created without export", "stability": "stable", "summary": "Export name for the CfnOutput containing the API endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 164 }, "name": "endpointExportName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "EndpointType.EDGE", "remarks": "Use this property when creating\nan API.", "stability": "stable", "summary": "A list of the endpoint types of the API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 172 }, "name": "endpointTypes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.EndpointType" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 143 }, "name": "failOnWarnings", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No parameters.", "see": "https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html", "stability": "stable", "summary": "Custom header parameters for the request." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 128 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No policy.", "stability": "stable", "summary": "A policy document that contains the permissions for this RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 135 }, "name": "policy", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.PolicyDocument" } }, { "abstract": true, "docs": { "default": "- ID of the RestApi construct.", "stability": "stable", "summary": "A name for the API Gateway RestApi resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 120 }, "name": "restApiName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "This allows\nmanually reverting stages to point to old deployments via the AWS\nConsole.", "stability": "stable", "summary": "Retains old deployment resources when the API changes." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 113 }, "name": "retainDeployments", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/restapi:RestApiBaseProps" }, "@aws-cdk/aws-apigateway.RestApiOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "deprecated": "- superseded by `RestApiBaseProps`", "stability": "deprecated", "summary": "Represents the props that all Rest APIs share.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as certificatemanager from '@aws-cdk/aws-certificatemanager';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const accessLogDestination: apigateway.IAccessLogDestination;\ndeclare const accessLogFormat: apigateway.AccessLogFormat;\ndeclare const authorizer: apigateway.Authorizer;\ndeclare const bucket: s3.Bucket;\ndeclare const certificate: certificatemanager.Certificate;\ndeclare const integration: apigateway.Integration;\ndeclare const model: apigateway.Model;\ndeclare const policyDocument: iam.PolicyDocument;\ndeclare const requestValidator: apigateway.RequestValidator;\nconst restApiOptions: apigateway.RestApiOptions = {\n cloudWatchRole: false,\n defaultCorsPreflightOptions: {\n allowOrigins: ['allowOrigins'],\n\n // the properties below are optional\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n disableCache: false,\n exposeHeaders: ['exposeHeaders'],\n maxAge: cdk.Duration.minutes(30),\n statusCode: 123,\n },\n defaultIntegration: integration,\n defaultMethodOptions: {\n apiKeyRequired: false,\n authorizationScopes: ['authorizationScopes'],\n authorizationType: apigateway.AuthorizationType.NONE,\n authorizer: authorizer,\n methodResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n responseModels: {\n responseModelsKey: model,\n },\n responseParameters: {\n responseParametersKey: false,\n },\n }],\n operationName: 'operationName',\n requestModels: {\n requestModelsKey: model,\n },\n requestParameters: {\n requestParametersKey: false,\n },\n requestValidator: requestValidator,\n requestValidatorOptions: {\n requestValidatorName: 'requestValidatorName',\n validateRequestBody: false,\n validateRequestParameters: false,\n },\n },\n deploy: false,\n deployOptions: {\n accessLogDestination: accessLogDestination,\n accessLogFormat: accessLogFormat,\n cacheClusterEnabled: false,\n cacheClusterSize: 'cacheClusterSize',\n cacheDataEncrypted: false,\n cacheTtl: cdk.Duration.minutes(30),\n cachingEnabled: false,\n clientCertificateId: 'clientCertificateId',\n dataTraceEnabled: false,\n description: 'description',\n documentationVersion: 'documentationVersion',\n loggingLevel: apigateway.MethodLoggingLevel.OFF,\n methodOptions: {\n methodOptionsKey: {\n cacheDataEncrypted: false,\n cacheTtl: cdk.Duration.minutes(30),\n cachingEnabled: false,\n dataTraceEnabled: false,\n loggingLevel: apigateway.MethodLoggingLevel.OFF,\n metricsEnabled: false,\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n },\n },\n metricsEnabled: false,\n stageName: 'stageName',\n throttlingBurstLimit: 123,\n throttlingRateLimit: 123,\n tracingEnabled: false,\n variables: {\n variablesKey: 'variables',\n },\n },\n disableExecuteApiEndpoint: false,\n domainName: {\n certificate: certificate,\n domainName: 'domainName',\n\n // the properties below are optional\n basePath: 'basePath',\n endpointType: apigateway.EndpointType.EDGE,\n mtls: {\n bucket: bucket,\n key: 'key',\n\n // the properties below are optional\n version: 'version',\n },\n securityPolicy: apigateway.SecurityPolicy.TLS_1_0,\n },\n endpointExportName: 'endpointExportName',\n endpointTypes: [apigateway.EndpointType.EDGE],\n failOnWarnings: false,\n parameters: {\n parametersKey: 'parameters',\n },\n policy: policyDocument,\n restApiName: 'restApiName',\n retainDeployments: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.RestApiOptions", "interfaces": [ "@aws-cdk/aws-apigateway.RestApiBaseProps", "@aws-cdk/aws-apigateway.ResourceOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 189 }, "name": "RestApiOptions", "symbolId": "lib/restapi:RestApiOptions" }, "@aws-cdk/aws-apigateway.RestApiProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Props to create a new instance of RestApi.", "example": " const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),\n });\n\n const api = new apigateway.RestApi(this, 'Api', {\n restApiName: 'MyApi',\n });\n api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.RestApiProps", "interfaces": [ "@aws-cdk/aws-apigateway.RestApiOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 195 }, "name": "RestApiProps", "properties": [ { "abstract": true, "docs": { "default": "- Metering is disabled.", "stability": "stable", "summary": "The source of the API key for metering requests according to a usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 236 }, "name": "apiKeySourceType", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ApiKeySourceType" } }, { "abstract": true, "docs": { "default": "- RestApi supports only UTF-8-encoded text payloads.", "stability": "stable", "summary": "The list of binary media mime-types that are supported by the RestApi resource, such as \"image/png\" or \"application/octet-stream\"." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 209 }, "name": "binaryMediaTypes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- None.", "stability": "stable", "summary": "The ID of the API Gateway RestApi resource that you want to clone." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 228 }, "name": "cloneFrom", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "A description of the purpose of this API Gateway RestApi resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 201 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "EndpointType.EDGE", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html", "stability": "stable", "summary": "The EndpointConfiguration property type specifies the endpoint types of a REST API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 244 }, "name": "endpointConfiguration", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.EndpointConfiguration" } }, { "abstract": true, "docs": { "default": "- Compression is disabled.", "remarks": "When compression is enabled, compression or\ndecompression is not applied on the payload if the payload size is\nsmaller than this value. Setting it to zero allows compression for any\npayload size.", "stability": "stable", "summary": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 221 }, "name": "minimumCompressionSize", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/restapi:RestApiProps" }, "@aws-cdk/aws-apigateway.S3ApiDefinition": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.ApiDefinition", "docs": { "stability": "stable", "summary": "OpenAPI specification from an S3 archive.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as s3 from '@aws-cdk/aws-s3';\n\ndeclare const bucket: s3.Bucket;\nconst s3ApiDefinition = new apigateway.S3ApiDefinition(bucket, 'key', /* all optional props */ 'objectVersion');", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.S3ApiDefinition", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 140 }, "parameters": [ { "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "name": "key", "type": { "primitive": "string" } }, { "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/api-definition.ts", "line": 137 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/api-definition.ts", "line": 150 }, "name": "bind", "overrides": "@aws-cdk/aws-apigateway.ApiDefinition", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinitionConfig" } } } ], "name": "S3ApiDefinition", "symbolId": "lib/api-definition:S3ApiDefinition" }, "@aws-cdk/aws-apigateway.SecurityPolicy": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.", "example": "declare const acmCertificateForExampleCom: any;\n\nnew apigateway.DomainName(this, 'custom-domain', {\n domainName: 'example.com',\n certificate: acmCertificateForExampleCom,\n endpointType: apigateway.EndpointType.EDGE, // default is REGIONAL\n securityPolicy: apigateway.SecurityPolicy.TLS_1_2\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.SecurityPolicy", "kind": "enum", "locationInModule": { "filename": "lib/domain-name.ts", "line": 12 }, "members": [ { "docs": { "stability": "stable", "summary": "Cipher suite TLS 1.0." }, "name": "TLS_1_0" }, { "docs": { "stability": "stable", "summary": "Cipher suite TLS 1.2." }, "name": "TLS_1_2" } ], "name": "SecurityPolicy", "symbolId": "lib/domain-name:SecurityPolicy" }, "@aws-cdk/aws-apigateway.SpecRestApi": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.RestApiBase", "docs": { "custom": { "resource": "AWS::ApiGateway::RestApi", "exampleMetadata": "infused" }, "remarks": "Some properties normally accessible on @see {@link RestApi} - such as the description -\nmust be declared in the specification. All Resources and Methods need to be defined as\npart of the OpenAPI specification file, and cannot be added via the CDK.\n\nBy default, the API will automatically be deployed and accessible from a\npublic endpoint.", "stability": "stable", "summary": "Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.", "example": "declare const integration: apigateway.Integration;\n\nconst api = new apigateway.SpecRestApi(this, 'books-api', {\n apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')\n});\n\nconst booksResource = api.root.addResource('books')\nbooksResource.addMethod('GET', integration);" }, "fqn": "@aws-cdk/aws-apigateway.SpecRestApi", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/restapi.ts", "line": 634 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.SpecRestApiProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/restapi.ts", "line": 619 }, "name": "SpecRestApi", "properties": [ { "docs": { "stability": "stable", "summary": "The ID of this API Gateway RestApi." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 623 }, "name": "restApiId", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The resource ID of the root resource." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 630 }, "name": "restApiRootResourceId", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "primitive": "string" } }, { "docs": { "remarks": "Resources and Methods are added to this resource.", "stability": "stable", "summary": "Represents the root resource of this API endpoint ('/')." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 632 }, "name": "root", "overrides": "@aws-cdk/aws-apigateway.RestApiBase", "type": { "fqn": "@aws-cdk/aws-apigateway.IResource" } } ], "symbolId": "lib/restapi:SpecRestApi" }, "@aws-cdk/aws-apigateway.SpecRestApiProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Props to instantiate a new SpecRestApi.", "example": "declare const integration: apigateway.Integration;\n\nconst api = new apigateway.SpecRestApi(this, 'books-api', {\n apiDefinition: apigateway.ApiDefinition.fromAsset('path-to-file.json')\n});\n\nconst booksResource = api.root.addResource('books')\nbooksResource.addMethod('GET', integration);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.SpecRestApiProps", "interfaces": [ "@aws-cdk/aws-apigateway.RestApiBaseProps" ], "kind": "interface", "locationInModule": { "filename": "lib/restapi.ts", "line": 250 }, "name": "SpecRestApiProps", "properties": [ { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html", "stability": "stable", "summary": "An OpenAPI definition compatible with API Gateway." }, "immutable": true, "locationInModule": { "filename": "lib/restapi.ts", "line": 255 }, "name": "apiDefinition", "type": { "fqn": "@aws-cdk/aws-apigateway.ApiDefinition" } } ], "symbolId": "lib/restapi:SpecRestApiProps" }, "@aws-cdk/aws-apigateway.Stage": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.Stage", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/stage.ts", "line": 202 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.StageProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IStage" ], "kind": "class", "locationInModule": { "filename": "lib/stage.ts", "line": 196 }, "methods": [ { "docs": { "stability": "stable", "summary": "Returns the invoke URL for a certain path." }, "locationInModule": { "filename": "lib/stage.ts", "line": 269 }, "name": "urlForPath", "parameters": [ { "docs": { "summary": "The resource path." }, "name": "path", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } } } ], "name": "Stage", "properties": [ { "docs": { "stability": "stable", "summary": "RestApi to which this stage is associated." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 199 }, "name": "restApi", "overrides": "@aws-cdk/aws-apigateway.IStage", "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "docs": { "custom": { "attribute": "true" }, "remarks": "arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}\n\nNote that this is separate from the execute-api ARN for methods and resources\nwithin this stage.", "stability": "stable", "summary": "Returns the resource ARN for this stage:." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 286 }, "name": "stageArn", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Name of this stage." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 197 }, "name": "stageName", "overrides": "@aws-cdk/aws-apigateway.IStage", "type": { "primitive": "string" } } ], "symbolId": "lib/stage:Stage" }, "@aws-cdk/aws-apigateway.StageOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "const logGroup = new logs.LogGroup(this, \"ApiGatewayAccessLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),\n accessLogFormat: apigateway.AccessLogFormat.clf(),\n }});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.StageOptions", "interfaces": [ "@aws-cdk/aws-apigateway.MethodDeploymentOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/stage.ts", "line": 25 }, "name": "StageOptions", "properties": [ { "abstract": true, "docs": { "default": "- No destination", "stability": "stable", "summary": "The CloudWatch Logs log group." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 39 }, "name": "accessLogDestination", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IAccessLogDestination" } }, { "abstract": true, "docs": { "default": "- Common Log Format", "remarks": "The format must include at least `AccessLogFormat.contextRequestId()`.", "see": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference", "stability": "stable", "summary": "A single line format of access logs of data, as specified by selected $content variables." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 48 }, "name": "accessLogFormat", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.AccessLogFormat" } }, { "abstract": true, "docs": { "default": "- Disabled for the stage.", "stability": "stable", "summary": "Indicates whether cache clustering is enabled for the stage." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 62 }, "name": "cacheClusterEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "0.5", "stability": "stable", "summary": "The stage's cache cluster size." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 68 }, "name": "cacheClusterSize", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- None.", "stability": "stable", "summary": "The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 76 }, "name": "clientCertificateId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "A description of the purpose of the stage." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 83 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No documentation version.", "stability": "stable", "summary": "The version identifier of the API documentation snapshot." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 90 }, "name": "documentationVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Common options will be used.", "remarks": "These will\noverride common options defined in `StageOptions#methodOptions`.", "stability": "stable", "summary": "Method deployment options for specific resources/methods." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 111 }, "name": "methodOptions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.MethodDeploymentOptions" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- \"prod\"", "stability": "stable", "summary": "The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI)." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 32 }, "name": "stageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Specifies whether Amazon X-Ray tracing is enabled for this method." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 55 }, "name": "tracingEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No stage variables.", "remarks": "Variable names must consist of\nalphanumeric characters, and the values must match the following regular\nexpression: [A-Za-z0-9-._~:/?#&=,]+.", "stability": "stable", "summary": "A map that defines the stage variables." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 99 }, "name": "variables", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/stage:StageOptions" }, "@aws-cdk/aws-apigateway.StageProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "// production stage\nconst prdLogGroup = new logs.LogGroup(this, \"PrdLogs\");\nconst api = new apigateway.RestApi(this, 'books', {\n deployOptions: {\n accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()\n }\n})\nconst deployment = new apigateway.Deployment(this, 'Deployment', {api});\n\n// development stage\nconst devLogGroup = new logs.LogGroup(this, \"DevLogs\");\nnew apigateway.Stage(this, 'dev', {\n deployment,\n accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),\n accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({\n caller: false,\n httpMethod: true,\n ip: true,\n protocol: true,\n requestTime: true,\n resourcePath: true,\n responseLength: true,\n status: true,\n user: true\n })\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.StageProps", "interfaces": [ "@aws-cdk/aws-apigateway.StageOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/stage.ts", "line": 114 }, "name": "StageProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The deployment that this stage points to [disable-awslint:ref-via-interface]." }, "immutable": true, "locationInModule": { "filename": "lib/stage.ts", "line": 118 }, "name": "deployment", "type": { "fqn": "@aws-cdk/aws-apigateway.Deployment" } } ], "symbolId": "lib/stage:StageProps" }, "@aws-cdk/aws-apigateway.StepFunctionsExecutionIntegrationOptions": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Options when configuring Step Functions synchronous integration with Rest API.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\ndeclare const vpcLink: apigateway.VpcLink;\nconst stepFunctionsExecutionIntegrationOptions: apigateway.StepFunctionsExecutionIntegrationOptions = {\n authorizer: false,\n cacheKeyParameters: ['cacheKeyParameters'],\n cacheNamespace: 'cacheNamespace',\n connectionType: apigateway.ConnectionType.INTERNET,\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n credentialsPassthrough: false,\n credentialsRole: role,\n headers: false,\n integrationResponses: [{\n statusCode: 'statusCode',\n\n // the properties below are optional\n contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,\n responseParameters: {\n responseParametersKey: 'responseParameters',\n },\n responseTemplates: {\n responseTemplatesKey: 'responseTemplates',\n },\n selectionPattern: 'selectionPattern',\n }],\n passthroughBehavior: apigateway.PassthroughBehavior.WHEN_NO_MATCH,\n path: false,\n querystring: false,\n requestContext: {\n accountId: false,\n apiId: false,\n apiKey: false,\n authorizerPrincipalId: false,\n caller: false,\n cognitoAuthenticationProvider: false,\n cognitoAuthenticationType: false,\n cognitoIdentityId: false,\n cognitoIdentityPoolId: false,\n httpMethod: false,\n requestId: false,\n resourceId: false,\n resourcePath: false,\n sourceIp: false,\n stage: false,\n user: false,\n userAgent: false,\n userArn: false,\n },\n requestParameters: {\n requestParametersKey: 'requestParameters',\n },\n requestTemplates: {\n requestTemplatesKey: 'requestTemplates',\n },\n timeout: cdk.Duration.minutes(30),\n vpcLink: vpcLink,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.StepFunctionsExecutionIntegrationOptions", "interfaces": [ "@aws-cdk/aws-apigateway.IntegrationOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 14 }, "name": "StepFunctionsExecutionIntegrationOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "The execution input will include a new key `authorizer`:\n\n{\n \"body\": {},\n \"authorizer\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "If the whole authorizer object, including custom context values should be in the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 85 }, "name": "authorizer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "The execution input will include a new key `headers`:\n\n{\n \"body\": {},\n \"headers\": {\n \"header1\": \"value\",\n \"header2\": \"value\"\n }\n}", "stability": "stable", "summary": "Check if header is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 71 }, "name": "headers", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "The execution input will include a new key `path`:\n\n{\n \"body\": {},\n \"path\": {\n \"resourceName\": \"resourceValue\"\n }\n}", "stability": "stable", "summary": "Check if path is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 57 }, "name": "path", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "The execution input will include a new key `queryString`:\n\n{\n \"body\": {},\n \"querystring\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "Check if querystring is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 43 }, "name": "querystring", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- all parameters within request context will be set as false", "remarks": "The execution input will include a new key `requestContext`:\n\n{\n \"body\": {},\n \"requestContext\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc." }, "immutable": true, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 29 }, "name": "requestContext", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RequestContext" } } ], "symbolId": "lib/integrations/stepfunctions:StepFunctionsExecutionIntegrationOptions" }, "@aws-cdk/aws-apigateway.StepFunctionsIntegration": { "assembly": "@aws-cdk/aws-apigateway", "docs": { "stability": "stable", "summary": "Options to integrate with various StepFunction API.", "example": " const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),\n });\n\n const api = new apigateway.RestApi(this, 'Api', {\n restApiName: 'MyApi',\n });\n api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.StepFunctionsIntegration", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 91 }, "methods": [ { "docs": { "example": " const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),\n });\n\n const api = new apigateway.RestApi(this, 'Api', {\n restApiName: 'MyApi',\n });\n api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));", "stability": "stable", "summary": "Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method." }, "locationInModule": { "filename": "lib/integrations/stepfunctions.ts", "line": 107 }, "name": "startExecution", "parameters": [ { "name": "stateMachine", "type": { "fqn": "@aws-cdk/aws-stepfunctions.IStateMachine" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.StepFunctionsExecutionIntegrationOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.AwsIntegration" } }, "static": true } ], "name": "StepFunctionsIntegration", "symbolId": "lib/integrations/stepfunctions:StepFunctionsIntegration" }, "@aws-cdk/aws-apigateway.StepFunctionsRestApi": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.RestApi", "docs": { "stability": "stable", "summary": "Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.", "example": "const stateMachineDefinition = new stepfunctions.Pass(this, 'PassState');\n\nconst stateMachine: stepfunctions.IStateMachine = new stepfunctions.StateMachine(this, 'StateMachine', {\n definition: stateMachineDefinition,\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n});\n\nnew apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {\n deploy: true,\n stateMachine: stateMachine,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.StepFunctionsRestApi", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 105 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.StepFunctionsRestApiProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 104 }, "name": "StepFunctionsRestApi", "symbolId": "lib/stepfunctions-api:StepFunctionsRestApi" }, "@aws-cdk/aws-apigateway.StepFunctionsRestApiProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for StepFunctionsRestApi.", "example": "const stateMachineDefinition = new stepfunctions.Pass(this, 'PassState');\n\nconst stateMachine: stepfunctions.IStateMachine = new stepfunctions.StateMachine(this, 'StateMachine', {\n definition: stateMachineDefinition,\n stateMachineType: stepfunctions.StateMachineType.EXPRESS,\n});\n\nnew apigateway.StepFunctionsRestApi(this, 'StepFunctionsRestApi', {\n deploy: true,\n stateMachine: stateMachine,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.StepFunctionsRestApiProps", "interfaces": [ "@aws-cdk/aws-apigateway.RestApiProps" ], "kind": "interface", "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 12 }, "name": "StepFunctionsRestApiProps", "properties": [ { "abstract": true, "docs": { "remarks": "This stateMachine will be used as a the default integration for all methods in\nthis API, unless specified otherwise in `addMethod`.", "stability": "stable", "summary": "The default State Machine that handles all requests from this API." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 19 }, "name": "stateMachine", "type": { "fqn": "@aws-cdk/aws-stepfunctions.IStateMachine" } }, { "abstract": true, "docs": { "default": "false", "remarks": "The execution input will include a new key `authorizer`:\n\n{\n \"body\": {},\n \"authorizer\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "If the whole authorizer object, including custom context values should be in the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 90 }, "name": "authorizer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "The execution input will include a new key `headers`:\n\n{\n \"body\": {},\n \"headers\": {\n \"header1\": \"value\",\n \"header2\": \"value\"\n }\n}", "stability": "stable", "summary": "Check if header is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 76 }, "name": "headers", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "The execution input will include a new key `path`:\n\n{\n \"body\": {},\n \"path\": {\n \"resourceName\": \"resourceValue\"\n }\n}", "stability": "stable", "summary": "Check if path is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 62 }, "name": "path", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "The execution input will include a new key `queryString`:\n\n{\n \"body\": {},\n \"querystring\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "Check if querystring is to be included inside the execution input." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 48 }, "name": "querystring", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- all parameters within request context will be set as false", "remarks": "The execution input will include a new key `requestContext`:\n\n{\n \"body\": {},\n \"requestContext\": {\n \"key\": \"value\"\n }\n}", "stability": "stable", "summary": "Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 34 }, "name": "requestContext", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.RequestContext" } }, { "abstract": true, "docs": { "default": "- a new role is created", "stability": "stable", "summary": "An IAM role that API Gateway will assume to start the execution of the state machine." }, "immutable": true, "locationInModule": { "filename": "lib/stepfunctions-api.ts", "line": 98 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ], "symbolId": "lib/stepfunctions-api:StepFunctionsRestApiProps" }, "@aws-cdk/aws-apigateway.ThrottleSettings": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Container for defining throttling parameters to API stages or methods.", "example": "declare const integration: apigateway.LambdaIntegration;\n\nconst api = new apigateway.RestApi(this, 'hello-api');\n\nconst v1 = api.root.addResource('v1');\nconst echo = v1.addResource('echo');\nconst echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });\n\nconst plan = api.addUsagePlan('UsagePlan', {\n name: 'Easy',\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n});\n\nconst key = api.addApiKey('ApiKey');\nplan.addApiKey(key);" }, "fqn": "@aws-cdk/aws-apigateway.ThrottleSettings", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 15 }, "name": "ThrottleSettings", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "The maximum API request rate limit over a time ranging from one to a few seconds." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 26 }, "name": "burstLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "The API request steady-state rate limit (average requests per second over an extended period of time)." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 20 }, "name": "rateLimit", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/usage-plan:ThrottleSettings" }, "@aws-cdk/aws-apigateway.ThrottlingPerMethod": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Represents per-method throttling for a resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as apigateway from '@aws-cdk/aws-apigateway';\n\ndeclare const method: apigateway.Method;\nconst throttlingPerMethod: apigateway.ThrottlingPerMethod = {\n method: method,\n throttle: {\n burstLimit: 123,\n rateLimit: 123,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-apigateway.ThrottlingPerMethod", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 64 }, "name": "ThrottlingPerMethod", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "[disable-awslint:ref-via-interface] The method for which you specify the throttling settings." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 70 }, "name": "method", "type": { "fqn": "@aws-cdk/aws-apigateway.Method" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Specifies the overall request rate (average requests per second) and burst capacity." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 76 }, "name": "throttle", "type": { "fqn": "@aws-cdk/aws-apigateway.ThrottleSettings" } } ], "symbolId": "lib/usage-plan:ThrottlingPerMethod" }, "@aws-cdk/aws-apigateway.TokenAuthorizer": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/aws-apigateway.Authorizer", "docs": { "custom": { "resource": "AWS::ApiGateway::Authorizer", "exampleMetadata": "infused" }, "remarks": "Based on the token, authorization is performed by a lambda function.", "stability": "stable", "summary": "Token based lambda authorizer that recognizes the caller's identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.TokenAuthorizer(this, 'booksAuthorizer', {\n handler: authFn\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});" }, "fqn": "@aws-cdk/aws-apigateway.TokenAuthorizer", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 166 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-apigateway.TokenAuthorizerProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IAuthorizer" ], "kind": "class", "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 160 }, "methods": [ { "docs": { "remarks": "Throws an error, during token resolution, if no RestApi is attached to this authorizer.", "stability": "stable", "summary": "Returns a token that resolves to the Rest Api Id at the time of synthesis." }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 120 }, "name": "lazyRestApiId", "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Sets up the permissions necessary for the API Gateway service to invoke the Lambda function." }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 98 }, "name": "setupPermissions", "protected": true } ], "name": "TokenAuthorizer", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 164 }, "name": "authorizerArn", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The id of the authorizer." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 162 }, "name": "authorizerId", "overrides": "@aws-cdk/aws-apigateway.Authorizer", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The Lambda function handler that this authorizer uses." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 63 }, "name": "handler", "protected": true, "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "docs": { "stability": "stable", "summary": "The IAM role that the API Gateway service assumes while invoking the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 68 }, "name": "role", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 70 }, "name": "restApiId", "optional": true, "protected": true, "type": { "primitive": "string" } } ], "symbolId": "lib/authorizers/lambda:TokenAuthorizer" }, "@aws-cdk/aws-apigateway.TokenAuthorizerProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for TokenAuthorizer.", "example": "declare const authFn: lambda.Function;\ndeclare const books: apigateway.Resource;\n\nconst auth = new apigateway.TokenAuthorizer(this, 'booksAuthorizer', {\n handler: authFn\n});\n\nbooks.addMethod('GET', new apigateway.HttpIntegration('http://amazon.com'), {\n authorizer: auth\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.TokenAuthorizerProps", "interfaces": [ "@aws-cdk/aws-apigateway.LambdaAuthorizerProps" ], "kind": "interface", "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 135 }, "name": "TokenAuthorizerProps", "properties": [ { "abstract": true, "docs": { "default": "`IdentitySource.header('Authorization')`", "remarks": "This is typically passed as part of the header, in which case\nthis should be `method.request.header.Authorizer` where Authorizer is the header containing the bearer token.", "see": "https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource", "stability": "stable", "summary": "The request header mapping expression for the bearer token." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 150 }, "name": "identitySource", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no regex filter will be applied.", "remarks": "When matched the authorizer lambda is invoked,\notherwise a 401 Unauthorized is returned to the client.", "stability": "stable", "summary": "An optional regex to be matched against the authorization token." }, "immutable": true, "locationInModule": { "filename": "lib/authorizers/lambda.ts", "line": 142 }, "name": "validationRegex", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/authorizers/lambda:TokenAuthorizerProps" }, "@aws-cdk/aws-apigateway.UsagePlan": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "example": "declare const integration: apigateway.LambdaIntegration;\n\nconst api = new apigateway.RestApi(this, 'hello-api');\n\nconst v1 = api.root.addResource('v1');\nconst echo = v1.addResource('echo');\nconst echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });\n\nconst plan = api.addUsagePlan('UsagePlan', {\n name: 'Easy',\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n});\n\nconst key = api.addApiKey('ApiKey');\nplan.addApiKey(key);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.UsagePlan", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 242 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.UsagePlanProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IUsagePlan" ], "kind": "class", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 215 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an externally defined usage plan using its ARN." }, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 224 }, "name": "fromUsagePlanId", "parameters": [ { "docs": { "summary": "the construct that will \"own\" the imported usage plan." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "the id of the imported usage plan in the construct tree." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the id of an existing usage plan." }, "name": "usagePlanId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IUsagePlan" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds an ApiKey." }, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 192 }, "name": "addApiKey", "overrides": "@aws-cdk/aws-apigateway.IUsagePlan", "parameters": [ { "docs": { "summary": "the api key to associate with this usage plan." }, "name": "apiKey", "type": { "fqn": "@aws-cdk/aws-apigateway.IApiKey" } }, { "docs": { "summary": "options that control the behaviour of this method." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.AddApiKeyOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Adds an apiStage." }, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 268 }, "name": "addApiStage", "parameters": [ { "name": "apiStage", "type": { "fqn": "@aws-cdk/aws-apigateway.UsagePlanPerApiStage" } } ] } ], "name": "UsagePlan", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Id of the usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 238 }, "name": "usagePlanId", "overrides": "@aws-cdk/aws-apigateway.IUsagePlan", "type": { "primitive": "string" } } ], "symbolId": "lib/usage-plan:UsagePlan" }, "@aws-cdk/aws-apigateway.UsagePlanPerApiStage": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Represents the API stages that a usage plan applies to.", "example": "declare const plan: apigateway.UsagePlan;\ndeclare const api: apigateway.RestApi;\ndeclare const echoMethod: apigateway.Method;\n\nplan.addApiStage({\n stage: api.deploymentStage,\n throttle: [\n {\n method: echoMethod,\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n }\n ]\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.UsagePlanPerApiStage", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 89 }, "name": "UsagePlanPerApiStage", "properties": [ { "abstract": true, "docs": { "default": "none", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 94 }, "name": "api", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IRestApi" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "[disable-awslint:ref-via-interface]." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 101 }, "name": "stage", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.Stage" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 106 }, "name": "throttle", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.ThrottlingPerMethod" }, "kind": "array" } } } ], "symbolId": "lib/usage-plan:UsagePlanPerApiStage" }, "@aws-cdk/aws-apigateway.UsagePlanProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "example": "declare const integration: apigateway.LambdaIntegration;\n\nconst api = new apigateway.RestApi(this, 'hello-api');\n\nconst v1 = api.root.addResource('v1');\nconst echo = v1.addResource('echo');\nconst echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });\n\nconst plan = api.addUsagePlan('UsagePlan', {\n name: 'Easy',\n throttle: {\n rateLimit: 10,\n burstLimit: 2\n }\n});\n\nconst key = api.addApiKey('ApiKey');\nplan.addApiKey(key);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.UsagePlanProps", "kind": "interface", "locationInModule": { "filename": "lib/usage-plan.ts", "line": 109 }, "name": "UsagePlanProps", "properties": [ { "abstract": true, "docs": { "default": "none", "deprecated": "use `addApiKey()`", "stability": "deprecated", "summary": "ApiKey to be associated with the usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 145 }, "name": "apiKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.IApiKey" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "API Stages to be associated with the usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 114 }, "name": "apiStages", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-apigateway.UsagePlanPerApiStage" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Represents usage plan purpose." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 120 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Name for this usage plan." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 138 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Number of requests clients can make in a given time period." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 126 }, "name": "quota", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.QuotaSettings" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Overall throttle settings for the API." }, "immutable": true, "locationInModule": { "filename": "lib/usage-plan.ts", "line": 132 }, "name": "throttle", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.ThrottleSettings" } } ], "symbolId": "lib/usage-plan:UsagePlanProps" }, "@aws-cdk/aws-apigateway.VpcLink": { "assembly": "@aws-cdk/aws-apigateway", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).", "example": "import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.VpcLink", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 66 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-apigateway.VpcLinkProps" } } ] }, "interfaces": [ "@aws-cdk/aws-apigateway.IVpcLink" ], "kind": "class", "locationInModule": { "filename": "lib/vpc-link.ts", "line": 46 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import a VPC Link by its Id." }, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 50 }, "name": "fromVpcLinkId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "vpcLinkId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-apigateway.IVpcLink" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 85 }, "name": "addTargets", "parameters": [ { "name": "targets", "type": { "fqn": "@aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer" }, "variadic": true } ], "variadic": true }, { "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": "stable", "summary": "Validate the current construct." }, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 97 }, "name": "validate", "overrides": "@aws-cdk/core.Construct", "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "VpcLink", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Physical ID of the VpcLink resource." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 62 }, "name": "vpcLinkId", "overrides": "@aws-cdk/aws-apigateway.IVpcLink", "type": { "primitive": "string" } } ], "symbolId": "lib/vpc-link:VpcLink" }, "@aws-cdk/aws-apigateway.VpcLinkProps": { "assembly": "@aws-cdk/aws-apigateway", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a VpcLink.", "example": "import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';\n\nconst vpc = new ec2.Vpc(this, 'VPC');\nconst nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {\n vpc,\n});\nconst link = new apigateway.VpcLink(this, 'link', {\n targets: [nlb],\n});\n\nconst integration = new apigateway.Integration({\n type: apigateway.IntegrationType.HTTP_PROXY,\n options: {\n connectionType: apigateway.ConnectionType.VPC_LINK,\n vpcLink: link,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-apigateway.VpcLinkProps", "kind": "interface", "locationInModule": { "filename": "lib/vpc-link.ts", "line": 20 }, "name": "VpcLinkProps", "properties": [ { "abstract": true, "docs": { "default": "no description", "stability": "stable", "summary": "The description of the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 31 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no targets. Use `addTargets` to add targets", "remarks": "The network load balancers must be owned by the same AWS account of the API owner.", "stability": "stable", "summary": "The network load balancers of the VPC targeted by the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 39 }, "name": "targets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- automatically generated name", "stability": "stable", "summary": "The name used to label and identify the VPC link." }, "immutable": true, "locationInModule": { "filename": "lib/vpc-link.ts", "line": 25 }, "name": "vpcLinkName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/vpc-link:VpcLinkProps" } }, "version": "1.204.0", "fingerprint": "**********" }