interface CfnApiV2Props ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnApiV2Props
Java	software.amazon.awscdk.services.apigateway.CfnApiV2Props
Python	aws_cdk.aws_apigateway.CfnApiV2Props
TypeScript (source)	@aws-cdk/aws-apigateway » CfnApiV2Props

⚠️ Deprecated: moved to package aws-apigatewayv2

Properties for defining a AWS::ApiGatewayV2::Api.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';

declare const body: any;
declare const tags: any;
const cfnApiV2Props: apigateway.CfnApiV2Props = {
  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',
  disableSchemaValidation: false,
  failOnWarnings: false,
  name: 'name',
  protocolType: 'protocolType',
  routeKey: 'routeKey',
  routeSelectionExpression: 'routeSelectionExpression',
  tags: tags,
  target: 'target',
  version: 'version',
};

Properties

Name	Type	Description
apiKeySelectionExpression?⚠️	string	AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.
basePath?⚠️	string	AWS::ApiGatewayV2::Api.BasePath.
body?⚠️	any	AWS::ApiGatewayV2::Api.Body.
bodyS3Location?⚠️	IResolvable | BodyS3LocationProperty	AWS::ApiGatewayV2::Api.BodyS3Location.
corsConfiguration?⚠️	IResolvable | CorsProperty	AWS::ApiGatewayV2::Api.CorsConfiguration.
credentialsArn?⚠️	string	AWS::ApiGatewayV2::Api.CredentialsArn.
description?⚠️	string	AWS::ApiGatewayV2::Api.Description.
disableSchemaValidation?⚠️	boolean | IResolvable	AWS::ApiGatewayV2::Api.DisableSchemaValidation.
failOnWarnings?⚠️	boolean | IResolvable	AWS::ApiGatewayV2::Api.FailOnWarnings.
name?⚠️	string	AWS::ApiGatewayV2::Api.Name.
protocolType?⚠️	string	AWS::ApiGatewayV2::Api.ProtocolType.
routeKey?⚠️	string	AWS::ApiGatewayV2::Api.RouteKey.
routeSelectionExpression?⚠️	string	AWS::ApiGatewayV2::Api.RouteSelectionExpression.
tags?⚠️	any	AWS::ApiGatewayV2::Api.Tags.
target?⚠️	string	AWS::ApiGatewayV2::Api.Target.
version?⚠️	string	AWS::ApiGatewayV2::Api.Version.

---

apiKeySelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.ApiKeySelectionExpression.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

---

basePath?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.BasePath.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

---

body?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Api.Body.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

---

bodyS3Location?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: IResolvable | BodyS3LocationProperty (optional)

AWS::ApiGatewayV2::Api.BodyS3Location.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

---

corsConfiguration?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: IResolvable | CorsProperty (optional)

AWS::ApiGatewayV2::Api.CorsConfiguration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

---

credentialsArn?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.CredentialsArn.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

---

description?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.Description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

---

disableSchemaValidation?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: boolean | IResolvable (optional)

AWS::ApiGatewayV2::Api.DisableSchemaValidation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

---

failOnWarnings?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: boolean | IResolvable (optional)

AWS::ApiGatewayV2::Api.FailOnWarnings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

---

name?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.Name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

---

protocolType?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.ProtocolType.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

---

routeKey?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.RouteKey.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

---

routeSelectionExpression?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.RouteSelectionExpression.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

---

tags?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: any (optional)

AWS::ApiGatewayV2::Api.Tags.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags

---

target?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.Target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

---

version?⚠️

⚠️ Deprecated: moved to package aws-apigatewayv2

Type: string (optional)

AWS::ApiGatewayV2::Api.Version.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version