CfnApiProps Struct
Properties for defining a CfnApi.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const body: any;
const cfnApiProps: apigatewayv2.CfnApiProps = {
apiKeySelectionExpression: 'apiKeySelectionExpression',
basePath: 'basePath',
body: body,
bodyS3Location: {
bucket: 'bucket',
etag: 'etag',
key: 'key',
version: 'version',
},
corsConfiguration: {
allowCredentials: false,
allowHeaders: ['allowHeaders'],
allowMethods: ['allowMethods'],
allowOrigins: ['allowOrigins'],
exposeHeaders: ['exposeHeaders'],
maxAge: 123,
},
credentialsArn: 'credentialsArn',
description: 'description',
disableExecuteApiEndpoint: false,
disableSchemaValidation: false,
failOnWarnings: false,
ipAddressType: 'ipAddressType',
name: 'name',
protocolType: 'protocolType',
routeKey: 'routeKey',
routeSelectionExpression: 'routeSelectionExpression',
tags: {
tagsKey: 'tags',
},
target: 'target',
version: 'version',
};
Properties
apiKeySelectionExpressionstringapi_key_selection_expressionstrapiKeySelectionExpressionStringApiKeySelectionExpressionstringApiKeySelectionExpression*string#Supported only for WebSocket APIs. See API Key Selection Expressions .
notes
Valid values are ignore , prepend , and split . The default value is ignore . To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.
notes
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
bodyS3LocationIResolvable | CfnApi.BodyS3LocationPropertybody_s3_locationtyping.Union[IResolvable, BodyS3LocationProperty]bodyS3LocationIResolvableBodyS3LocationIResolvableBodyS3Locationinterface{}#notes
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location . If you specify a Body or BodyS3Location , don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route . API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
corsConfigurationIResolvable | CfnApi.CorsPropertycors_configurationtyping.Union[IResolvable, CorsProperty]corsConfigurationIResolvableCorsConfigurationIResolvableCorsConfigurationinterface{}#Supported only for HTTP APIs. See Configuring CORS for more information.
credentialsArnstringcredentials_arnstrcredentialsArnStringCredentialsArnstringCredentialsArn*string#notes
It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, specify null . Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
disableExecuteApiEndpointboolean | IResolvabledisable_execute_api_endpointtyping.Union[bool, IResolvable]disableExecuteApiEndpointBooleanDisableExecuteApiEndpointboolDisableExecuteApiEndpointinterface{}#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.
disableSchemaValidationboolean | IResolvabledisable_schema_validationtyping.Union[bool, IResolvable]disableSchemaValidationBooleanDisableSchemaValidationboolDisableSchemaValidationinterface{}#Supported only for WebSocket APIs.
failOnWarningsboolean | IResolvablefail_on_warningstyping.Union[bool, IResolvable]failOnWarningsBooleanFailOnWarningsboolFailOnWarningsinterface{}#By default, API creation continues if a warning is encountered.
notes
Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API.
Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.
Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
notes
If you don't specify a routeKey , a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
routeSelectionExpressionstringroute_selection_expressionstrrouteSelectionExpressionStringRouteSelectionExpressionstringRouteSelectionExpression*string#For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path} . If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Each tag element is associated with a given resource.
targetstring | IFunctionReftargettyping.Union[str, IFunctionRef]targetStringTargetstringTargetinterface{}#notes
Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.