Skip to content

Latest commit

 

History

History
2242 lines (1395 loc) · 107 KB

apigatewayv2Integration.md

File metadata and controls

2242 lines (1395 loc) · 107 KB

aws_apigatewayv2_integration

Refer to the Terraform Registory for docs: aws_apigatewayv2_integration.

apigatewayv2Integration Submodule

Constructs

Apigatewayv2Integration

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

Initializers

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

new apigatewayv2Integration.Apigatewayv2Integration(scope: Construct, id: string, config: Apigatewayv2IntegrationConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config Apigatewayv2IntegrationConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putResponseParameters No description.
putTlsConfig No description.
resetConnectionId No description.
resetConnectionType No description.
resetContentHandlingStrategy No description.
resetCredentialsArn No description.
resetDescription No description.
resetId No description.
resetIntegrationMethod No description.
resetIntegrationSubtype No description.
resetIntegrationUri No description.
resetPassthroughBehavior No description.
resetPayloadFormatVersion No description.
resetRequestParameters No description.
resetRequestTemplates No description.
resetResponseParameters No description.
resetTemplateSelectionExpression No description.
resetTimeoutMilliseconds No description.
resetTlsConfig No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

putResponseParameters
public putResponseParameters(value: IResolvable | Apigatewayv2IntegrationResponseParameters[]): void
valueRequired

putTlsConfig
public putTlsConfig(value: Apigatewayv2IntegrationTlsConfig): void
valueRequired

resetConnectionId
public resetConnectionId(): void
resetConnectionType
public resetConnectionType(): void
resetContentHandlingStrategy
public resetContentHandlingStrategy(): void
resetCredentialsArn
public resetCredentialsArn(): void
resetDescription
public resetDescription(): void
resetId
public resetId(): void
resetIntegrationMethod
public resetIntegrationMethod(): void
resetIntegrationSubtype
public resetIntegrationSubtype(): void
resetIntegrationUri
public resetIntegrationUri(): void
resetPassthroughBehavior
public resetPassthroughBehavior(): void
resetPayloadFormatVersion
public resetPayloadFormatVersion(): void
resetRequestParameters
public resetRequestParameters(): void
resetRequestTemplates
public resetRequestTemplates(): void
resetResponseParameters
public resetResponseParameters(): void
resetTemplateSelectionExpression
public resetTemplateSelectionExpression(): void
resetTimeoutMilliseconds
public resetTimeoutMilliseconds(): void
resetTlsConfig
public resetTlsConfig(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.

isConstruct
import { apigatewayv2Integration } from '@cdktf/aws-cdk'

apigatewayv2Integration.Apigatewayv2Integration.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { apigatewayv2Integration } from '@cdktf/aws-cdk'

apigatewayv2Integration.Apigatewayv2Integration.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { apigatewayv2Integration } from '@cdktf/aws-cdk'

apigatewayv2Integration.Apigatewayv2Integration.isTerraformResource(x: any)
xRequired
  • Type: any

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.
integrationResponseSelectionExpression string No description.
responseParameters Apigatewayv2IntegrationResponseParametersList No description.
tlsConfig Apigatewayv2IntegrationTlsConfigOutputReference No description.
apiIdInput string No description.
connectionIdInput string No description.
connectionTypeInput string No description.
contentHandlingStrategyInput string No description.
credentialsArnInput string No description.
descriptionInput string No description.
idInput string No description.
integrationMethodInput string No description.
integrationSubtypeInput string No description.
integrationTypeInput string No description.
integrationUriInput string No description.
passthroughBehaviorInput string No description.
payloadFormatVersionInput string No description.
requestParametersInput {[ key: string ]: string} No description.
requestTemplatesInput {[ key: string ]: string} No description.
responseParametersInput cdktf.IResolvable | Apigatewayv2IntegrationResponseParameters[] No description.
templateSelectionExpressionInput string No description.
timeoutMillisecondsInput number No description.
tlsConfigInput Apigatewayv2IntegrationTlsConfig No description.
apiId string No description.
connectionId string No description.
connectionType string No description.
contentHandlingStrategy string No description.
credentialsArn string No description.
description string No description.
id string No description.
integrationMethod string No description.
integrationSubtype string No description.
integrationType string No description.
integrationUri string No description.
passthroughBehavior string No description.
payloadFormatVersion string No description.
requestParameters {[ key: string ]: string} No description.
requestTemplates {[ key: string ]: string} No description.
templateSelectionExpression string No description.
timeoutMilliseconds number No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

integrationResponseSelectionExpressionRequired
public readonly integrationResponseSelectionExpression: string;
  • Type: string

responseParametersRequired
public readonly responseParameters: Apigatewayv2IntegrationResponseParametersList;

tlsConfigRequired
public readonly tlsConfig: Apigatewayv2IntegrationTlsConfigOutputReference;

apiIdInputOptional
public readonly apiIdInput: string;
  • Type: string

connectionIdInputOptional
public readonly connectionIdInput: string;
  • Type: string

connectionTypeInputOptional
public readonly connectionTypeInput: string;
  • Type: string

contentHandlingStrategyInputOptional
public readonly contentHandlingStrategyInput: string;
  • Type: string

credentialsArnInputOptional
public readonly credentialsArnInput: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

integrationMethodInputOptional
public readonly integrationMethodInput: string;
  • Type: string

integrationSubtypeInputOptional
public readonly integrationSubtypeInput: string;
  • Type: string

integrationTypeInputOptional
public readonly integrationTypeInput: string;
  • Type: string

integrationUriInputOptional
public readonly integrationUriInput: string;
  • Type: string

passthroughBehaviorInputOptional
public readonly passthroughBehaviorInput: string;
  • Type: string

payloadFormatVersionInputOptional
public readonly payloadFormatVersionInput: string;
  • Type: string

requestParametersInputOptional
public readonly requestParametersInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

requestTemplatesInputOptional
public readonly requestTemplatesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

responseParametersInputOptional
public readonly responseParametersInput: IResolvable | Apigatewayv2IntegrationResponseParameters[];

templateSelectionExpressionInputOptional
public readonly templateSelectionExpressionInput: string;
  • Type: string

timeoutMillisecondsInputOptional
public readonly timeoutMillisecondsInput: number;
  • Type: number

tlsConfigInputOptional
public readonly tlsConfigInput: Apigatewayv2IntegrationTlsConfig;

apiIdRequired
public readonly apiId: string;
  • Type: string

connectionIdRequired
public readonly connectionId: string;
  • Type: string

connectionTypeRequired
public readonly connectionType: string;
  • Type: string

contentHandlingStrategyRequired
public readonly contentHandlingStrategy: string;
  • Type: string

credentialsArnRequired
public readonly credentialsArn: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

integrationMethodRequired
public readonly integrationMethod: string;
  • Type: string

integrationSubtypeRequired
public readonly integrationSubtype: string;
  • Type: string

integrationTypeRequired
public readonly integrationType: string;
  • Type: string

integrationUriRequired
public readonly integrationUri: string;
  • Type: string

passthroughBehaviorRequired
public readonly passthroughBehavior: string;
  • Type: string

payloadFormatVersionRequired
public readonly payloadFormatVersion: string;
  • Type: string

requestParametersRequired
public readonly requestParameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

requestTemplatesRequired
public readonly requestTemplates: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

templateSelectionExpressionRequired
public readonly templateSelectionExpression: string;
  • Type: string

timeoutMillisecondsRequired
public readonly timeoutMilliseconds: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

Apigatewayv2IntegrationConfig

Initializer

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

const apigatewayv2IntegrationConfig: apigatewayv2Integration.Apigatewayv2IntegrationConfig = { ... }

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_integration#api_id Apigatewayv2Integration#api_id}.
integrationType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_type Apigatewayv2Integration#integration_type}.
connectionId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#connection_id Apigatewayv2Integration#connection_id}.
connectionType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#connection_type Apigatewayv2Integration#connection_type}.
contentHandlingStrategy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#content_handling_strategy Apigatewayv2Integration#content_handling_strategy}.
credentialsArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#credentials_arn Apigatewayv2Integration#credentials_arn}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#description Apigatewayv2Integration#description}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#id Apigatewayv2Integration#id}.
integrationMethod string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_method Apigatewayv2Integration#integration_method}.
integrationSubtype string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_subtype Apigatewayv2Integration#integration_subtype}.
integrationUri string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_uri Apigatewayv2Integration#integration_uri}.
passthroughBehavior string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#passthrough_behavior Apigatewayv2Integration#passthrough_behavior}.
payloadFormatVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#payload_format_version Apigatewayv2Integration#payload_format_version}.
requestParameters {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#request_parameters Apigatewayv2Integration#request_parameters}.
requestTemplates {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#request_templates Apigatewayv2Integration#request_templates}.
responseParameters cdktf.IResolvable | Apigatewayv2IntegrationResponseParameters[] response_parameters block.
templateSelectionExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#template_selection_expression Apigatewayv2Integration#template_selection_expression}.
timeoutMilliseconds number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#timeout_milliseconds Apigatewayv2Integration#timeout_milliseconds}.
tlsConfig Apigatewayv2IntegrationTlsConfig tls_config block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

apiIdRequired
public readonly apiId: string;
  • Type: string

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


integrationTypeRequired
public readonly integrationType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_type Apigatewayv2Integration#integration_type}.


connectionIdOptional
public readonly connectionId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#connection_id Apigatewayv2Integration#connection_id}.


connectionTypeOptional
public readonly connectionType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#connection_type Apigatewayv2Integration#connection_type}.


contentHandlingStrategyOptional
public readonly contentHandlingStrategy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#content_handling_strategy Apigatewayv2Integration#content_handling_strategy}.


credentialsArnOptional
public readonly credentialsArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#credentials_arn Apigatewayv2Integration#credentials_arn}.


descriptionOptional
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#description Apigatewayv2Integration#description}.


idOptional
public readonly id: string;
  • Type: string

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


integrationMethodOptional
public readonly integrationMethod: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_method Apigatewayv2Integration#integration_method}.


integrationSubtypeOptional
public readonly integrationSubtype: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_subtype Apigatewayv2Integration#integration_subtype}.


integrationUriOptional
public readonly integrationUri: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#integration_uri Apigatewayv2Integration#integration_uri}.


passthroughBehaviorOptional
public readonly passthroughBehavior: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#passthrough_behavior Apigatewayv2Integration#passthrough_behavior}.


payloadFormatVersionOptional
public readonly payloadFormatVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#payload_format_version Apigatewayv2Integration#payload_format_version}.


requestParametersOptional
public readonly requestParameters: {[ 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_integration#request_parameters Apigatewayv2Integration#request_parameters}.


requestTemplatesOptional
public readonly requestTemplates: {[ 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_integration#request_templates Apigatewayv2Integration#request_templates}.


responseParametersOptional
public readonly responseParameters: IResolvable | Apigatewayv2IntegrationResponseParameters[];

response_parameters block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#response_parameters Apigatewayv2Integration#response_parameters}


templateSelectionExpressionOptional
public readonly templateSelectionExpression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#template_selection_expression Apigatewayv2Integration#template_selection_expression}.


timeoutMillisecondsOptional
public readonly timeoutMilliseconds: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#timeout_milliseconds Apigatewayv2Integration#timeout_milliseconds}.


tlsConfigOptional
public readonly tlsConfig: Apigatewayv2IntegrationTlsConfig;

tls_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#tls_config Apigatewayv2Integration#tls_config}


Apigatewayv2IntegrationResponseParameters

Initializer

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

const apigatewayv2IntegrationResponseParameters: apigatewayv2Integration.Apigatewayv2IntegrationResponseParameters = { ... }

Properties

Name Type Description
mappings {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#mappings Apigatewayv2Integration#mappings}.
statusCode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#status_code Apigatewayv2Integration#status_code}.

mappingsRequired
public readonly mappings: {[ 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_integration#mappings Apigatewayv2Integration#mappings}.


statusCodeRequired
public readonly statusCode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#status_code Apigatewayv2Integration#status_code}.


Apigatewayv2IntegrationTlsConfig

Initializer

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

const apigatewayv2IntegrationTlsConfig: apigatewayv2Integration.Apigatewayv2IntegrationTlsConfig = { ... }

Properties

Name Type Description
serverNameToVerify string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#server_name_to_verify Apigatewayv2Integration#server_name_to_verify}.

serverNameToVerifyOptional
public readonly serverNameToVerify: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/apigatewayv2_integration#server_name_to_verify Apigatewayv2Integration#server_name_to_verify}.


Classes

Apigatewayv2IntegrationResponseParametersList

Initializers

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

new apigatewayv2Integration.Apigatewayv2IntegrationResponseParametersList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): Apigatewayv2IntegrationResponseParametersOutputReference
indexRequired
  • 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 | Apigatewayv2IntegrationResponseParameters[] No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | Apigatewayv2IntegrationResponseParameters[];

Apigatewayv2IntegrationResponseParametersOutputReference

Initializers

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

new apigatewayv2Integration.Apigatewayv2IntegrationResponseParametersOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
mappingsInput {[ key: string ]: string} No description.
statusCodeInput string No description.
mappings {[ key: string ]: string} No description.
statusCode string No description.
internalValue cdktf.IResolvable | Apigatewayv2IntegrationResponseParameters No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

mappingsInputOptional
public readonly mappingsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

statusCodeInputOptional
public readonly statusCodeInput: string;
  • Type: string

mappingsRequired
public readonly mappings: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

statusCodeRequired
public readonly statusCode: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | Apigatewayv2IntegrationResponseParameters;

Apigatewayv2IntegrationTlsConfigOutputReference

Initializers

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

new apigatewayv2Integration.Apigatewayv2IntegrationTlsConfigOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetServerNameToVerify No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetServerNameToVerify
public resetServerNameToVerify(): 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.
serverNameToVerifyInput string No description.
serverNameToVerify string No description.
internalValue Apigatewayv2IntegrationTlsConfig No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

serverNameToVerifyInputOptional
public readonly serverNameToVerifyInput: string;
  • Type: string

serverNameToVerifyRequired
public readonly serverNameToVerify: string;
  • Type: string

internalValueOptional
public readonly internalValue: Apigatewayv2IntegrationTlsConfig;