@aws-cdk/aws-apigateway/package.json

The CDK Construct Library for AWS::ApiGateway

{
  "name": "@aws-cdk/aws-apigateway",
  "version": "1.204.0",
  "description": "The CDK Construct Library for AWS::ApiGateway",
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
  "jsii": {
    "outdir": "dist",
    "targets": {
      "java": {
        "package": "software.amazon.awscdk.services.apigateway",
        "maven": {
          "groupId": "software.amazon.awscdk",
          "artifactId": "apigateway"
        }
      },
      "dotnet": {
        "namespace": "Amazon.CDK.AWS.APIGateway",
        "packageId": "Amazon.CDK.AWS.APIGateway",
        "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"
      },
      "python": {
        "distName": "aws-cdk.aws-apigateway",
        "module": "aws_cdk.aws_apigateway",
        "classifiers": [
          "Framework :: AWS CDK",
          "Framework :: AWS CDK :: 1"
        ]
      }
    },
    "projectReferences": true,
    "metadata": {
      "jsii": {
        "rosetta": {
          "strict": true
        }
      }
    }
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/aws/aws-cdk.git",
    "directory": "packages/@aws-cdk/aws-apigateway"
  },
  "scripts": {
    "build": "cdk-build",
    "watch": "cdk-watch",
    "lint": "cdk-lint",
    "test": "cdk-test",
    "integ": "integ-runner",
    "pkglint": "pkglint -f",
    "package": "cdk-package",
    "awslint": "cdk-awslint",
    "cfn2ts": "cfn2ts",
    "build+test+package": "yarn build+test && yarn package",
    "build+test": "yarn build && yarn test",
    "compat": "cdk-compat",
    "gen": "cfn2ts",
    "rosetta:extract": "yarn --silent jsii-rosetta extract",
    "build+extract": "yarn build && yarn rosetta:extract",
    "build+test+extract": "yarn build+test && yarn rosetta:extract"
  },
  "cdk-build": {
    "cloudformation": "AWS::ApiGateway",
    "env": {
      "AWSLINT_BASE_CONSTRUCT": true
    }
  },
  "keywords": [
    "aws",
    "cdk",
    "constructs",
    "apigateway"
  ],
  "author": {
    "name": "Amazon Web Services",
    "url": "https://aws.amazon.com",
    "organization": true
  },
  "license": "Apache-2.0",
  "devDependencies": {
    "@aws-cdk/assertions": "1.204.0",
    "@aws-cdk/cdk-build-tools": "1.204.0",
    "@aws-cdk/integ-runner": "1.204.0",
    "@aws-cdk/cfn2ts": "1.204.0",
    "@aws-cdk/pkglint": "1.204.0",
    "@types/jest": "^27.5.2"
  },
  "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"
  },
  "homepage": "https://github.com/aws/aws-cdk",
  "peerDependencies": {
    "@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"
  },
  "engines": {
    "node": ">= 14.15.0"
  },
  "nyc": {
    "exclude": [
      "coverage/**",
      "test/**",
      "lib/*.generated.js",
      "lib/apigatewayv2.js"
    ]
  },
  "awslint": {
    "exclude": [
      "from-method:@aws-cdk/aws-apigateway.Resource",
      "duration-prop-type:@aws-cdk/aws-apigateway.QuotaSettings.period",
      "duration-prop-type:@aws-cdk/aws-apigateway.ResponseType.INTEGRATION_TIMEOUT",
      "ref-via-interface:@aws-cdk/aws-apigateway.ApiKeyProps.resources",
      "props-physical-name:@aws-cdk/aws-apigateway.DeploymentProps",
      "props-physical-name:@aws-cdk/aws-apigateway.MethodProps",
      "props-physical-name:@aws-cdk/aws-apigateway.ProxyResourceProps",
      "props-physical-name:@aws-cdk/aws-apigateway.ResourceProps",
      "props-physical-name:@aws-cdk/aws-apigateway.UsagePlanProps",
      "props-physical-name-type:@aws-cdk/aws-apigateway.StageProps.stageName",
      "props-physical-name:@aws-cdk/aws-apigateway.BasePathMappingProps",
      "props-physical-name:@aws-cdk/aws-apigateway.LambdaRestApiProps",
      "props-physical-name:@aws-cdk/aws-apigateway.GatewayResponseProps",
      "construct-interface-extends-iconstruct:@aws-cdk/aws-apigateway.IModel",
      "resource-interface-extends-resource:@aws-cdk/aws-apigateway.IModel",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.definitions",
      "docs-public-apis:@aws-cdk/aws-apigateway.Period.MONTH",
      "docs-public-apis:@aws-cdk/aws-apigateway.Period.WEEK",
      "docs-public-apis:@aws-cdk/aws-apigateway.Period.DAY",
      "docs-public-apis:@aws-cdk/aws-apigateway.PassthroughBehavior",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodLoggingLevel.INFO",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodLoggingLevel.ERROR",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodLoggingLevel.OFF",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodLoggingLevel",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaVersion.DRAFT7",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaVersion",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.STRING",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.INTEGER",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.NUMBER",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.ARRAY",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.OBJECT",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.BOOLEAN",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType.NULL",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchemaType",
      "docs-public-apis:@aws-cdk/aws-apigateway.IntegrationType",
      "docs-public-apis:@aws-cdk/aws-apigateway.EndpointType",
      "docs-public-apis:@aws-cdk/aws-apigateway.ContentHandling",
      "docs-public-apis:@aws-cdk/aws-apigateway.ConnectionType",
      "docs-public-apis:@aws-cdk/aws-apigateway.AuthorizationType",
      "docs-public-apis:@aws-cdk/aws-apigateway.ApiKeySourceType",
      "docs-public-apis:@aws-cdk/aws-apigateway.UsagePlanProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.UsagePlanPerApiStage.throttle",
      "docs-public-apis:@aws-cdk/aws-apigateway.UsagePlanPerApiStage.api",
      "docs-public-apis:@aws-cdk/aws-apigateway.StageProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.StageOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.RestApiProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.ResourceProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.ResourceOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.RequestValidatorProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.RequestValidatorOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.ProxyResourceProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.ProxyResourceOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.ModelProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.ModelOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodResponse",
      "docs-public-apis:@aws-cdk/aws-apigateway.Cors",
      "docs-public-apis:@aws-cdk/aws-apigateway.Deployment.api",
      "docs-public-apis:@aws-cdk/aws-apigateway.Deployment.deploymentId",
      "docs-public-apis:@aws-cdk/aws-apigateway.DomainName",
      "docs-public-apis:@aws-cdk/aws-apigateway.Method",
      "docs-public-apis:@aws-cdk/aws-apigateway.Method.httpMethod",
      "docs-public-apis:@aws-cdk/aws-apigateway.Method.methodId",
      "docs-public-apis:@aws-cdk/aws-apigateway.Method.resource",
      "docs-public-apis:@aws-cdk/aws-apigateway.Model",
      "docs-public-apis:@aws-cdk/aws-apigateway.Model.fromModelName",
      "docs-public-apis:@aws-cdk/aws-apigateway.RequestValidator",
      "docs-public-apis:@aws-cdk/aws-apigateway.RequestValidator.fromRequestValidatorId",
      "docs-public-apis:@aws-cdk/aws-apigateway.Resource",
      "docs-public-apis:@aws-cdk/aws-apigateway.ResourceBase",
      "docs-public-apis:@aws-cdk/aws-apigateway.RestApi.arnForExecuteApi",
      "docs-public-apis:@aws-cdk/aws-apigateway.Stage",
      "docs-public-apis:@aws-cdk/aws-apigateway.Stage.restApi",
      "docs-public-apis:@aws-cdk/aws-apigateway.Stage.stageName",
      "docs-public-apis:@aws-cdk/aws-apigateway.UsagePlan",
      "docs-public-apis:@aws-cdk/aws-apigateway.UsagePlan.usagePlanId",
      "docs-public-apis:@aws-cdk/aws-apigateway.VpcLink.addTargets",
      "docs-public-apis:@aws-cdk/aws-apigateway.AwsIntegrationProps",
      "props-default-doc:@aws-cdk/aws-apigateway.AwsIntegrationProps.action",
      "props-default-doc:@aws-cdk/aws-apigateway.AwsIntegrationProps.actionParameters",
      "props-default-doc:@aws-cdk/aws-apigateway.AwsIntegrationProps.options",
      "props-default-doc:@aws-cdk/aws-apigateway.AwsIntegrationProps.path",
      "props-default-doc:@aws-cdk/aws-apigateway.AwsIntegrationProps.subdomain",
      "docs-public-apis:@aws-cdk/aws-apigateway.BasePathMappingOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.BasePathMappingProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.CorsOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.DeploymentProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.DomainNameAttributes",
      "docs-public-apis:@aws-cdk/aws-apigateway.DomainNameOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.DomainNameProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.HttpIntegrationProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.IDomainName",
      "docs-public-apis:@aws-cdk/aws-apigateway.IModel",
      "docs-public-apis:@aws-cdk/aws-apigateway.IRequestValidator",
      "docs-public-apis:@aws-cdk/aws-apigateway.IResource",
      "docs-public-apis:@aws-cdk/aws-apigateway.IRestApi",
      "docs-public-apis:@aws-cdk/aws-apigateway.IntegrationOptions",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.cacheKeyParameters",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.cacheNamespace",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.integrationResponses",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.passthroughBehavior",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.requestParameters",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.requestTemplates",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationOptions.vpcLink",
      "docs-public-apis:@aws-cdk/aws-apigateway.IntegrationProps",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationProps.integrationHttpMethod",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationProps.options",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationProps.uri",
      "docs-public-apis:@aws-cdk/aws-apigateway.IntegrationResponse",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationResponse.responseParameters",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationResponse.responseTemplates",
      "props-default-doc:@aws-cdk/aws-apigateway.IntegrationResponse.selectionPattern",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.additionalItems",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.additionalItems",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.additionalProperties",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.additionalProperties",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.allOf",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.allOf",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.anyOf",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.anyOf",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.contains",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.contains",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodProps",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.definitions",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.dependencies",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.dependencies",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.description",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.description",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.enum",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.enum",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.exclusiveMaximum",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.exclusiveMaximum",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.exclusiveMinimum",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.exclusiveMinimum",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.format",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.format",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.id",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.id",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.items",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.items",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.maximum",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.maximum",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.maxItems",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.maxItems",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.maxLength",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.maxLength",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.maxProperties",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.maxProperties",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.minimum",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.minimum",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.minItems",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.minItems",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.minLength",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.minLength",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.minProperties",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.minProperties",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.multipleOf",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.multipleOf",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.not",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.not",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.oneOf",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.oneOf",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.pattern",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.pattern",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.patternProperties",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.patternProperties",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.properties",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.properties",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.propertyNames",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.propertyNames",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.ref",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.ref",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.required",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.required",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.schema",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.schema",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.title",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.title",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.type",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.type",
      "docs-public-apis:@aws-cdk/aws-apigateway.JsonSchema.uniqueItems",
      "props-default-doc:@aws-cdk/aws-apigateway.JsonSchema.uniqueItems",
      "docs-public-apis:@aws-cdk/aws-apigateway.LambdaIntegrationOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.LambdaRestApiProps",
      "docs-public-apis:@aws-cdk/aws-apigateway.LambdaRestApiProps.options",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodDeploymentOptions",
      "docs-public-apis:@aws-cdk/aws-apigateway.MethodOptions",
      "props-default-doc:@aws-cdk/aws-apigateway.MethodOptions.authorizer",
      "props-default-doc:@aws-cdk/aws-apigateway.MethodOptions.operationName",
      "props-default-doc:@aws-cdk/aws-apigateway.MethodOptions.requestModels",
      "props-default-doc:@aws-cdk/aws-apigateway.MethodOptions.requestValidator",
      "docs-public-apis:@aws-cdk/aws-apigateway.ResourceBase.url",
      "attribute-tag:@aws-cdk/aws-apigateway.LambdaAuthorizer.authorizerArn",
      "attribute-tag:@aws-cdk/aws-apigateway.RequestAuthorizer.authorizerArn",
      "attribute-tag:@aws-cdk/aws-apigateway.TokenAuthorizer.authorizerArn",
      "attribute-tag:@aws-cdk/aws-apigateway.RestApi.restApiName",
      "attribute-tag:@aws-cdk/aws-apigateway.SpecRestApi.restApiName",
      "attribute-tag:@aws-cdk/aws-apigateway.LambdaRestApi.restApiName",
      "from-method:@aws-cdk/aws-apigateway.Stage",
      "resource-attribute:@aws-cdk/aws-apigateway.ApiKey.apiKeyId",
      "resource-attribute:@aws-cdk/aws-apigateway.GatewayResponse.gatewayResponseId",
      "resource-attribute:@aws-cdk/aws-apigateway.RateLimitedApiKey.apiKeyId"
    ]
  },
  "stability": "stable",
  "awscdkio": {
    "announce": false
  },
  "maturity": "end-of-support",
  "publishConfig": {
    "tag": "latest"
  },
  "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"
}