apigatewayv2Route.md

apigatewayv2Route Submodule

Constructs

Apigatewayv2Route

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route aws_apigatewayv2_route}.

Initializers

import { apigatewayv2Route } from '@cdktf/aws-cdk'

new apigatewayv2Route.Apigatewayv2Route(scope: Construct, id: string, config: Apigatewayv2RouteConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	Apigatewayv2RouteConfig	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: Apigatewayv2RouteConfig

---

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".
putRequestParameter	No description.
resetApiKeyRequired	No description.
resetAuthorizationScopes	No description.
resetAuthorizationType	No description.
resetAuthorizerId	No description.
resetId	No description.
resetModelSelectionExpression	No description.
resetOperationName	No description.
resetRequestModels	No description.
resetRequestParameter	No description.
resetRouteResponseSelectionExpression	No description.
resetTarget	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".

---

putRequestParameter

public putRequestParameter(value: IResolvable | Apigatewayv2RouteRequestParameter[]): void

value^Required

• Type: cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]

---

resetApiKeyRequired

public resetApiKeyRequired(): void

resetAuthorizationScopes

public resetAuthorizationScopes(): void

resetAuthorizationType

public resetAuthorizationType(): void

resetAuthorizerId

public resetAuthorizerId(): void

resetId

public resetId(): void

resetModelSelectionExpression

public resetModelSelectionExpression(): void

resetOperationName

public resetOperationName(): void

resetRequestModels

public resetRequestModels(): void

resetRequestParameter

public resetRequestParameter(): void

resetRouteResponseSelectionExpression

public resetRouteResponseSelectionExpression(): void

resetTarget

public resetTarget(): 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 Apigatewayv2Route resource upon running "cdktf plan ".

---

isConstruct

import { apigatewayv2Route } from '@cdktf/aws-cdk'

apigatewayv2Route.Apigatewayv2Route.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { apigatewayv2Route } from '@cdktf/aws-cdk'

apigatewayv2Route.Apigatewayv2Route.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { apigatewayv2Route } from '@cdktf/aws-cdk'

apigatewayv2Route.Apigatewayv2Route.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { apigatewayv2Route } from '@cdktf/aws-cdk'

apigatewayv2Route.Apigatewayv2Route.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Apigatewayv2Route 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 Apigatewayv2Route to import.

---

importFromId^Required

• Type: string

The id of the existing Apigatewayv2Route that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#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 Apigatewayv2Route 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.
requestParameter	Apigatewayv2RouteRequestParameterList	No description.
apiIdInput	string	No description.
apiKeyRequiredInput	boolean | cdktf.IResolvable	No description.
authorizationScopesInput	string[]	No description.
authorizationTypeInput	string	No description.
authorizerIdInput	string	No description.
idInput	string	No description.
modelSelectionExpressionInput	string	No description.
operationNameInput	string	No description.
requestModelsInput	{[ key: string ]: string}	No description.
requestParameterInput	cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]	No description.
routeKeyInput	string	No description.
routeResponseSelectionExpressionInput	string	No description.
targetInput	string	No description.
apiId	string	No description.
apiKeyRequired	boolean | cdktf.IResolvable	No description.
authorizationScopes	string[]	No description.
authorizationType	string	No description.
authorizerId	string	No description.
id	string	No description.
modelSelectionExpression	string	No description.
operationName	string	No description.
requestModels	{[ key: string ]: string}	No description.
routeKey	string	No description.
routeResponseSelectionExpression	string	No description.
target	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[]

---

requestParameter^Required

public readonly requestParameter: Apigatewayv2RouteRequestParameterList;

• Type: Apigatewayv2RouteRequestParameterList

---

apiIdInput^Optional

public readonly apiIdInput: string;

• Type: string

---

apiKeyRequiredInput^Optional

public readonly apiKeyRequiredInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

authorizationScopesInput^Optional

public readonly authorizationScopesInput: string[];

• Type: string[]

---

authorizationTypeInput^Optional

public readonly authorizationTypeInput: string;

• Type: string

---

authorizerIdInput^Optional

public readonly authorizerIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

modelSelectionExpressionInput^Optional

public readonly modelSelectionExpressionInput: string;

• Type: string

---

operationNameInput^Optional

public readonly operationNameInput: string;

• Type: string

---

requestModelsInput^Optional

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

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

---

requestParameterInput^Optional

public readonly requestParameterInput: IResolvable | Apigatewayv2RouteRequestParameter[];

• Type: cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]

---

routeKeyInput^Optional

public readonly routeKeyInput: string;

• Type: string

---

routeResponseSelectionExpressionInput^Optional

public readonly routeResponseSelectionExpressionInput: string;

• Type: string

---

targetInput^Optional

public readonly targetInput: string;

• Type: string

---

apiId^Required

public readonly apiId: string;

• Type: string

---

apiKeyRequired^Required

public readonly apiKeyRequired: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

authorizationScopes^Required

public readonly authorizationScopes: string[];

• Type: string[]

---

authorizationType^Required

public readonly authorizationType: string;

• Type: string

---

authorizerId^Required

public readonly authorizerId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

modelSelectionExpression^Required

public readonly modelSelectionExpression: string;

• Type: string

---

operationName^Required

public readonly operationName: string;

• Type: string

---

requestModels^Required

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

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

---

routeKey^Required

public readonly routeKey: string;

• Type: string

---

routeResponseSelectionExpression^Required

public readonly routeResponseSelectionExpression: string;

• Type: string

---

target^Required

public readonly target: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

Apigatewayv2RouteConfig

Initializer

import { apigatewayv2Route } from '@cdktf/aws-cdk'

const apigatewayv2RouteConfig: apigatewayv2Route.Apigatewayv2RouteConfig = { ... }

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.
apiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#api_id Apigatewayv2Route#api_id}.
routeKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#route_key Apigatewayv2Route#route_key}.
apiKeyRequired	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#api_key_required Apigatewayv2Route#api_key_required}.
authorizationScopes	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorization_scopes Apigatewayv2Route#authorization_scopes}.
authorizationType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorization_type Apigatewayv2Route#authorization_type}.
authorizerId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorizer_id Apigatewayv2Route#authorizer_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#id Apigatewayv2Route#id}.
modelSelectionExpression	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#model_selection_expression Apigatewayv2Route#model_selection_expression}.
operationName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#operation_name Apigatewayv2Route#operation_name}.
requestModels	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#request_models Apigatewayv2Route#request_models}.
requestParameter	cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]	request_parameter block.
routeResponseSelectionExpression	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#route_response_selection_expression Apigatewayv2Route#route_response_selection_expression}.
target	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#target Apigatewayv2Route#target}.

---

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[]

---

apiId^Required

public readonly apiId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#api_id Apigatewayv2Route#api_id}.

---

routeKey^Required

public readonly routeKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#route_key Apigatewayv2Route#route_key}.

---

apiKeyRequired^Optional

public readonly apiKeyRequired: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#api_key_required Apigatewayv2Route#api_key_required}.

---

authorizationScopes^Optional

public readonly authorizationScopes: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorization_scopes Apigatewayv2Route#authorization_scopes}.

---

authorizationType^Optional

public readonly authorizationType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorization_type Apigatewayv2Route#authorization_type}.

---

authorizerId^Optional

public readonly authorizerId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#authorizer_id Apigatewayv2Route#authorizer_id}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#id Apigatewayv2Route#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.

---

modelSelectionExpression^Optional

public readonly modelSelectionExpression: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#model_selection_expression Apigatewayv2Route#model_selection_expression}.

---

operationName^Optional

public readonly operationName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#operation_name Apigatewayv2Route#operation_name}.

---

requestModels^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#request_models Apigatewayv2Route#request_models}.

---

requestParameter^Optional

public readonly requestParameter: IResolvable | Apigatewayv2RouteRequestParameter[];

• Type: cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]

request_parameter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#request_parameter Apigatewayv2Route#request_parameter}

---

routeResponseSelectionExpression^Optional

public readonly routeResponseSelectionExpression: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#route_response_selection_expression Apigatewayv2Route#route_response_selection_expression}.

---

target^Optional

public readonly target: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#target Apigatewayv2Route#target}.

---

Apigatewayv2RouteRequestParameter

Initializer

import { apigatewayv2Route } from '@cdktf/aws-cdk'

const apigatewayv2RouteRequestParameter: apigatewayv2Route.Apigatewayv2RouteRequestParameter = { ... }

Properties

Name	Type	Description
requestParameterKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#request_parameter_key Apigatewayv2Route#request_parameter_key}.
required	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#required Apigatewayv2Route#required}.

---

requestParameterKey^Required

public readonly requestParameterKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#request_parameter_key Apigatewayv2Route#request_parameter_key}.

---

required^Required

public readonly required: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_route#required Apigatewayv2Route#required}.

---

Classes

Apigatewayv2RouteRequestParameterList

Initializers

import { apigatewayv2Route } from '@cdktf/aws-cdk'

new apigatewayv2Route.Apigatewayv2RouteRequestParameterList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): 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.

get

public get(index: number): Apigatewayv2RouteRequestParameterOutputReference

index^Required

• Type: number

the index of the item to return.

---

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.
internalValue	cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]	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

---

internalValue^Optional

public readonly internalValue: IResolvable | Apigatewayv2RouteRequestParameter[];

• Type: cdktf.IResolvable | Apigatewayv2RouteRequestParameter[]

---

Apigatewayv2RouteRequestParameterOutputReference

Initializers

import { apigatewayv2Route } from '@cdktf/aws-cdk'

new apigatewayv2Route.Apigatewayv2RouteRequestParameterOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

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.

---

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.

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.
requestParameterKeyInput	string	No description.
requiredInput	boolean | cdktf.IResolvable	No description.
requestParameterKey	string	No description.
required	boolean | cdktf.IResolvable	No description.
internalValue	cdktf.IResolvable | Apigatewayv2RouteRequestParameter	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

---

requestParameterKeyInput^Optional

public readonly requestParameterKeyInput: string;

• Type: string

---

requiredInput^Optional

public readonly requiredInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

requestParameterKey^Required

public readonly requestParameterKey: string;

• Type: string

---

required^Required

public readonly required: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: IResolvable | Apigatewayv2RouteRequestParameter;

• Type: cdktf.IResolvable | Apigatewayv2RouteRequestParameter

---