apigatewayv2Api.typescript.md

apigatewayv2Api Submodule

Constructs

Apigatewayv2Api

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api aws_apigatewayv2_api}.

Initializers

import { apigatewayv2Api } from '@cdktf/provider-aws'

new apigatewayv2Api.Apigatewayv2Api(scope: Construct, id: string, config: Apigatewayv2ApiConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	Apigatewayv2ApiConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: Apigatewayv2ApiConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putCorsConfiguration	No description.
resetApiKeySelectionExpression	No description.
resetBody	No description.
resetCorsConfiguration	No description.
resetCredentialsArn	No description.
resetDescription	No description.
resetDisableExecuteApiEndpoint	No description.
resetFailOnWarnings	No description.
resetId	No description.
resetRouteKey	No description.
resetRouteSelectionExpression	No description.
resetTags	No description.
resetTagsAll	No description.
resetTarget	No description.
resetVersion	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putCorsConfiguration

public putCorsConfiguration(value: Apigatewayv2ApiCorsConfiguration): void

value^Required

• Type: Apigatewayv2ApiCorsConfiguration

---

resetApiKeySelectionExpression

public resetApiKeySelectionExpression(): void

resetBody

public resetBody(): void

resetCorsConfiguration

public resetCorsConfiguration(): void

resetCredentialsArn

public resetCredentialsArn(): void

resetDescription

public resetDescription(): void

resetDisableExecuteApiEndpoint

public resetDisableExecuteApiEndpoint(): void

resetFailOnWarnings

public resetFailOnWarnings(): void

resetId

public resetId(): void

resetRouteKey

public resetRouteKey(): void

resetRouteSelectionExpression

public resetRouteSelectionExpression(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetTarget

public resetTarget(): void

resetVersion

public resetVersion(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a Apigatewayv2Api resource upon running "cdktf plan ".

---

isConstruct

import { apigatewayv2Api } from '@cdktf/provider-aws'

apigatewayv2Api.Apigatewayv2Api.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { apigatewayv2Api } from '@cdktf/provider-aws'

apigatewayv2Api.Apigatewayv2Api.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { apigatewayv2Api } from '@cdktf/provider-aws'

apigatewayv2Api.Apigatewayv2Api.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { apigatewayv2Api } from '@cdktf/provider-aws'

apigatewayv2Api.Apigatewayv2Api.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Apigatewayv2Api resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the Apigatewayv2Api to import.

---

importFromId^Required

• Type: string

The id of the existing Apigatewayv2Api that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the Apigatewayv2Api to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
apiEndpoint	string	No description.
arn	string	No description.
corsConfiguration	Apigatewayv2ApiCorsConfigurationOutputReference	No description.
executionArn	string	No description.
apiKeySelectionExpressionInput	string	No description.
bodyInput	string	No description.
corsConfigurationInput	Apigatewayv2ApiCorsConfiguration	No description.
credentialsArnInput	string	No description.
descriptionInput	string	No description.
disableExecuteApiEndpointInput	boolean | cdktf.IResolvable	No description.
failOnWarningsInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
nameInput	string	No description.
protocolTypeInput	string	No description.
routeKeyInput	string	No description.
routeSelectionExpressionInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
targetInput	string	No description.
versionInput	string	No description.
apiKeySelectionExpression	string	No description.
body	string	No description.
credentialsArn	string	No description.
description	string	No description.
disableExecuteApiEndpoint	boolean | cdktf.IResolvable	No description.
failOnWarnings	boolean | cdktf.IResolvable	No description.
id	string	No description.
name	string	No description.
protocolType	string	No description.
routeKey	string	No description.
routeSelectionExpression	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
target	string	No description.
version	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

apiEndpoint^Required

public readonly apiEndpoint: string;

• Type: string

---

arn^Required

public readonly arn: string;

• Type: string

---

corsConfiguration^Required

public readonly corsConfiguration: Apigatewayv2ApiCorsConfigurationOutputReference;

• Type: Apigatewayv2ApiCorsConfigurationOutputReference

---

executionArn^Required

public readonly executionArn: string;

• Type: string

---

apiKeySelectionExpressionInput^Optional

public readonly apiKeySelectionExpressionInput: string;

• Type: string

---

bodyInput^Optional

public readonly bodyInput: string;

• Type: string

---

corsConfigurationInput^Optional

public readonly corsConfigurationInput: Apigatewayv2ApiCorsConfiguration;

• Type: Apigatewayv2ApiCorsConfiguration

---

credentialsArnInput^Optional

public readonly credentialsArnInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

disableExecuteApiEndpointInput^Optional

public readonly disableExecuteApiEndpointInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

failOnWarningsInput^Optional

public readonly failOnWarningsInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

protocolTypeInput^Optional

public readonly protocolTypeInput: string;

• Type: string

---

routeKeyInput^Optional

public readonly routeKeyInput: string;

• Type: string

---

routeSelectionExpressionInput^Optional

public readonly routeSelectionExpressionInput: string;

• Type: string

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

targetInput^Optional

public readonly targetInput: string;

• Type: string

---

versionInput^Optional

public readonly versionInput: string;

• Type: string

---

apiKeySelectionExpression^Required

public readonly apiKeySelectionExpression: string;

• Type: string

---

body^Required

public readonly body: string;

• Type: string

---

credentialsArn^Required

public readonly credentialsArn: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

disableExecuteApiEndpoint^Required

public readonly disableExecuteApiEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

failOnWarnings^Required

public readonly failOnWarnings: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

protocolType^Required

public readonly protocolType: string;

• Type: string

---

routeKey^Required

public readonly routeKey: string;

• Type: string

---

routeSelectionExpression^Required

public readonly routeSelectionExpression: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

target^Required

public readonly target: string;

• Type: string

---

version^Required

public readonly version: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

Apigatewayv2ApiConfig

Initializer

import { apigatewayv2Api } from '@cdktf/provider-aws'

const apigatewayv2ApiConfig: apigatewayv2Api.Apigatewayv2ApiConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.
protocolType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.
apiKeySelectionExpression	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.
body	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.
corsConfiguration	Apigatewayv2ApiCorsConfiguration	cors_configuration block.
credentialsArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.
description	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.
disableExecuteApiEndpoint	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.
failOnWarnings	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.
routeKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.
routeSelectionExpression	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.
target	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.
version	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#name Apigatewayv2Api#name}.

---

protocolType^Required

public readonly protocolType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#protocol_type Apigatewayv2Api#protocol_type}.

---

apiKeySelectionExpression^Optional

public readonly apiKeySelectionExpression: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#api_key_selection_expression Apigatewayv2Api#api_key_selection_expression}.

---

body^Optional

public readonly body: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#body Apigatewayv2Api#body}.

---

corsConfiguration^Optional

public readonly corsConfiguration: Apigatewayv2ApiCorsConfiguration;

• Type: Apigatewayv2ApiCorsConfiguration

cors_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#cors_configuration Apigatewayv2Api#cors_configuration}

---

credentialsArn^Optional

public readonly credentialsArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#credentials_arn Apigatewayv2Api#credentials_arn}.

---

description^Optional

public readonly description: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#description Apigatewayv2Api#description}.

---

disableExecuteApiEndpoint^Optional

public readonly disableExecuteApiEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#disable_execute_api_endpoint Apigatewayv2Api#disable_execute_api_endpoint}.

---

failOnWarnings^Optional

public readonly failOnWarnings: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#fail_on_warnings Apigatewayv2Api#fail_on_warnings}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#id Apigatewayv2Api#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

routeKey^Optional

public readonly routeKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#route_key Apigatewayv2Api#route_key}.

---

routeSelectionExpression^Optional

public readonly routeSelectionExpression: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#route_selection_expression Apigatewayv2Api#route_selection_expression}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#tags Apigatewayv2Api#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#tags_all Apigatewayv2Api#tags_all}.

---

target^Optional

public readonly target: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#target Apigatewayv2Api#target}.

---

version^Optional

public readonly version: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#version Apigatewayv2Api#version}.

---

Apigatewayv2ApiCorsConfiguration

Initializer

import { apigatewayv2Api } from '@cdktf/provider-aws'

const apigatewayv2ApiCorsConfiguration: apigatewayv2Api.Apigatewayv2ApiCorsConfiguration = { ... }

Properties

Name	Type	Description
allowCredentials	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.
allowHeaders	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.
allowMethods	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.
allowOrigins	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.
exposeHeaders	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.
maxAge	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

---

allowCredentials^Optional

public readonly allowCredentials: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_credentials Apigatewayv2Api#allow_credentials}.

---

allowHeaders^Optional

public readonly allowHeaders: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_headers Apigatewayv2Api#allow_headers}.

---

allowMethods^Optional

public readonly allowMethods: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_methods Apigatewayv2Api#allow_methods}.

---

allowOrigins^Optional

public readonly allowOrigins: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#allow_origins Apigatewayv2Api#allow_origins}.

---

exposeHeaders^Optional

public readonly exposeHeaders: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#expose_headers Apigatewayv2Api#expose_headers}.

---

maxAge^Optional

public readonly maxAge: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/apigatewayv2_api#max_age Apigatewayv2Api#max_age}.

---

Classes

Apigatewayv2ApiCorsConfigurationOutputReference

Initializers

import { apigatewayv2Api } from '@cdktf/provider-aws'

new apigatewayv2Api.Apigatewayv2ApiCorsConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetAllowCredentials	No description.
resetAllowHeaders	No description.
resetAllowMethods	No description.
resetAllowOrigins	No description.
resetExposeHeaders	No description.
resetMaxAge	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowCredentials

public resetAllowCredentials(): void

resetAllowHeaders

public resetAllowHeaders(): void

resetAllowMethods

public resetAllowMethods(): void

resetAllowOrigins

public resetAllowOrigins(): void

resetExposeHeaders

public resetExposeHeaders(): void

resetMaxAge

public resetMaxAge(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
allowCredentialsInput	boolean | cdktf.IResolvable	No description.
allowHeadersInput	string[]	No description.
allowMethodsInput	string[]	No description.
allowOriginsInput	string[]	No description.
exposeHeadersInput	string[]	No description.
maxAgeInput	number	No description.
allowCredentials	boolean | cdktf.IResolvable	No description.
allowHeaders	string[]	No description.
allowMethods	string[]	No description.
allowOrigins	string[]	No description.
exposeHeaders	string[]	No description.
maxAge	number	No description.
internalValue	Apigatewayv2ApiCorsConfiguration	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

allowCredentialsInput^Optional

public readonly allowCredentialsInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

allowHeadersInput^Optional

public readonly allowHeadersInput: string[];

• Type: string[]

---

allowMethodsInput^Optional

public readonly allowMethodsInput: string[];

• Type: string[]

---

allowOriginsInput^Optional

public readonly allowOriginsInput: string[];

• Type: string[]

---

exposeHeadersInput^Optional

public readonly exposeHeadersInput: string[];

• Type: string[]

---

maxAgeInput^Optional

public readonly maxAgeInput: number;

• Type: number

---

allowCredentials^Required

public readonly allowCredentials: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

allowHeaders^Required

public readonly allowHeaders: string[];

• Type: string[]

---

allowMethods^Required

public readonly allowMethods: string[];

• Type: string[]

---

allowOrigins^Required

public readonly allowOrigins: string[];

• Type: string[]

---

exposeHeaders^Required

public readonly exposeHeaders: string[];

• Type: string[]

---

maxAge^Required

public readonly maxAge: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: Apigatewayv2ApiCorsConfiguration;

• Type: Apigatewayv2ApiCorsConfiguration

---