class CfnApi (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.CfnApi`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApi`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnApi`
Python	`aws_cdk.aws_apigatewayv2.CfnApi`
TypeScript	`aws-cdk-lib` » `aws_apigatewayv2` » `CfnApi`

Implements IConstruct, IDependable, IInspectable, IApiRef, ITaggable

The AWS::ApiGatewayV2::Api resource creates an API.

WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

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 cfnApi = new apigatewayv2.CfnApi(this, 'MyCfnApi', /* all optional props */ {
  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',
});

Initializer

new CfnApi(scope: Construct, id: string, props?: CfnApiProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnApiProps — Resource properties.

Construct Props

Name	Type	Description
apiKeySelectionExpression?	`string`	An API key selection expression.
basePath?	`string`	Specifies how to interpret the base path of the API during import.
body?	`any`	The OpenAPI definition.
bodyS3Location?	`IResolvable` `\|` `BodyS3LocationProperty`	The S3 location of an OpenAPI definition.
corsConfiguration?	`IResolvable` `\|` `CorsProperty`	A CORS configuration.
credentialsArn?	`string`	This property is part of quick create.
description?	`string`	The description of the API.
disableExecuteApiEndpoint?	`boolean \|` `IResolvable`	Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
disableSchemaValidation?	`boolean \|` `IResolvable`	Avoid validating models when creating a deployment.
failOnWarnings?	`boolean \|` `IResolvable`	Specifies whether to rollback the API creation when a warning is encountered.
ipAddressType?	`string`	The IP address types that can invoke the API.
name?	`string`	The name of the API.
protocolType?	`string`	The API protocol.
routeKey?	`string`	This property is part of quick create.
routeSelectionExpression?	`string`	The route selection expression for the API.
tags?	`{ [string]: string }`	The collection of tags.
target?	`string`	This property is part of quick create.
version?	`string`	A version identifier for the API.

apiKeySelectionExpression?

Type: string (optional)

An API key selection expression.

Supported only for WebSocket APIs. See API Key Selection Expressions .

basePath?

Type: string (optional)

Specifies how to interpret the base path of the API during import.

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.

body?

Type: any (optional)

The OpenAPI definition.

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.

bodyS3Location?

Type: IResolvable | BodyS3LocationProperty (optional)

The S3 location of an OpenAPI definition.

corsConfiguration?

Type: IResolvable | CorsProperty (optional)

A CORS configuration.

Supported only for HTTP APIs. See Configuring CORS for more information.

credentialsArn?

Type: string (optional)

This property is part of quick create.

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.

description?

Type: string (optional)

The description of the API.

disableExecuteApiEndpoint?

Type: boolean | IResolvable (optional)

Specifies whether clients can invoke your API by using the default execute-api endpoint.

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.

disableSchemaValidation?

Type: boolean | IResolvable (optional)

Avoid validating models when creating a deployment.

Supported only for WebSocket APIs.

failOnWarnings?

Type: boolean | IResolvable (optional)

Specifies whether to rollback the API creation when a warning is encountered.

By default, API creation continues if a warning is encountered.

ipAddressType?

Type: string (optional)

The IP address types that can invoke the API.

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.

name?

Type: string (optional)

The name of the API.

Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

protocolType?

Type: string (optional)

The API protocol.

Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

routeKey?

Type: string (optional)

This property is part of quick create.

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.

routeSelectionExpression?

Type: string (optional)

The route selection expression for the API.

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?

Type: { [string]: string } (optional)

The collection of tags.

Each tag element is associated with a given resource.

target?

Type: string (optional)

This property is part of quick create.

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.

version?

Type: string (optional)

A version identifier for the API.

Properties

Name	Type	Description
apiRef	`ApiReference`	A reference to a Api resource.
attrApiEndpoint	`string`	The default endpoint for an API.
attrApiId	`string`	The API identifier.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
apiKeySelectionExpression?	`string`	An API key selection expression.
basePath?	`string`	Specifies how to interpret the base path of the API during import.
body?	`any`	The OpenAPI definition.
bodyS3Location?	`IResolvable` `\|` `BodyS3LocationProperty`	The S3 location of an OpenAPI definition.
corsConfiguration?	`IResolvable` `\|` `CorsProperty`	A CORS configuration.
credentialsArn?	`string`	This property is part of quick create.
description?	`string`	The description of the API.
disableExecuteApiEndpoint?	`boolean \|` `IResolvable`	Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
disableSchemaValidation?	`boolean \|` `IResolvable`	Avoid validating models when creating a deployment.
failOnWarnings?	`boolean \|` `IResolvable`	Specifies whether to rollback the API creation when a warning is encountered.
ipAddressType?	`string`	The IP address types that can invoke the API.
name?	`string`	The name of the API.
protocolType?	`string`	The API protocol.
routeKey?	`string`	This property is part of quick create.
routeSelectionExpression?	`string`	The route selection expression for the API.
tagsRaw?	`{ [string]: string }`	The collection of tags.
target?	`string`	This property is part of quick create.
version?	`string`	A version identifier for the API.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

apiRef

Type: ApiReference

A reference to a Api resource.

attrApiEndpoint

Type: string

The default endpoint for an API.

For example: https://abcdef.execute-api.us-west-2.amazonaws.com .

attrApiId

Type: string

The API identifier.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

apiKeySelectionExpression?

Type: string (optional)

An API key selection expression.

basePath?

Type: string (optional)

Specifies how to interpret the base path of the API during import.

body?

Type: any (optional)

The OpenAPI definition.

bodyS3Location?

Type: IResolvable | BodyS3LocationProperty (optional)

The S3 location of an OpenAPI definition.

corsConfiguration?

Type: IResolvable | CorsProperty (optional)

A CORS configuration.

credentialsArn?

Type: string (optional)

This property is part of quick create.

description?

Type: string (optional)

The description of the API.

disableExecuteApiEndpoint?

Type: boolean | IResolvable (optional)

Specifies whether clients can invoke your API by using the default execute-api endpoint.

disableSchemaValidation?

Type: boolean | IResolvable (optional)

Avoid validating models when creating a deployment.

failOnWarnings?

Type: boolean | IResolvable (optional)

Specifies whether to rollback the API creation when a warning is encountered.

ipAddressType?

Type: string (optional)

The IP address types that can invoke the API.

name?

Type: string (optional)

The name of the API.

protocolType?

Type: string (optional)

The API protocol.

routeKey?

Type: string (optional)

This property is part of quick create.

routeSelectionExpression?

Type: string (optional)

The route selection expression for the API.

tagsRaw?

Type: { [string]: string } (optional)

The collection of tags.

target?

Type: string (optional)

This property is part of quick create.

version?

Type: string (optional)

A version identifier for the API.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)
static fromApiId(scope, id, apiId)	Creates a new IApiRef from a apiId.

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

(Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }

static fromApiId(scope, id, apiId)

public static fromApiId(scope: Construct, id: string, apiId: string): IApiRef

Parameters

scope Construct
id string
apiId string

Returns

IApiRef

Creates a new IApiRef from a apiId.