`apiGatewayIntegration` Submodule

Constructs

ApiGatewayIntegration

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

Initializers

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

new apiGatewayIntegration.ApiGatewayIntegration(scope: Construct, id: string, config: ApiGatewayIntegrationConfig)

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

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".
`putTlsConfig`	No description.
`resetCacheKeyParameters`	No description.
`resetCacheNamespace`	No description.
`resetConnectionId`	No description.
`resetConnectionType`	No description.
`resetContentHandling`	No description.
`resetCredentials`	No description.
`resetId`	No description.
`resetIntegrationHttpMethod`	No description.
`resetPassthroughBehavior`	No description.
`resetRequestParameters`	No description.
`resetRequestTemplates`	No description.
`resetTimeoutMilliseconds`	No description.
`resetTlsConfig`	No description.
`resetUri`	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".

`putTlsConfig`

public putTlsConfig(value: ApiGatewayIntegrationTlsConfig): void

`value`^Required

Type: ApiGatewayIntegrationTlsConfig

`resetCacheKeyParameters`

public resetCacheKeyParameters(): void

`resetCacheNamespace`

public resetCacheNamespace(): void

`resetConnectionId`

public resetConnectionId(): void

`resetConnectionType`

public resetConnectionType(): void

`resetContentHandling`

public resetContentHandling(): void

`resetCredentials`

public resetCredentials(): void

`resetId`

public resetId(): void

`resetIntegrationHttpMethod`

public resetIntegrationHttpMethod(): void

`resetPassthroughBehavior`

public resetPassthroughBehavior(): void

`resetRequestParameters`

public resetRequestParameters(): void

`resetRequestTemplates`

public resetRequestTemplates(): void

`resetTimeoutMilliseconds`

public resetTimeoutMilliseconds(): void

`resetTlsConfig`

public resetTlsConfig(): void

`resetUri`

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

`isConstruct`

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

apiGatewayIntegration.ApiGatewayIntegration.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

apiGatewayIntegration.ApiGatewayIntegration.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

apiGatewayIntegration.ApiGatewayIntegration.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

apiGatewayIntegration.ApiGatewayIntegration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing ApiGatewayIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#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 ApiGatewayIntegration 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.
`tlsConfig`	`ApiGatewayIntegrationTlsConfigOutputReference`	No description.
`cacheKeyParametersInput`	`string[]`	No description.
`cacheNamespaceInput`	`string`	No description.
`connectionIdInput`	`string`	No description.
`connectionTypeInput`	`string`	No description.
`contentHandlingInput`	`string`	No description.
`credentialsInput`	`string`	No description.
`httpMethodInput`	`string`	No description.
`idInput`	`string`	No description.
`integrationHttpMethodInput`	`string`	No description.
`passthroughBehaviorInput`	`string`	No description.
`requestParametersInput`	`{[ key: string ]: string}`	No description.
`requestTemplatesInput`	`{[ key: string ]: string}`	No description.
`resourceIdInput`	`string`	No description.
`restApiIdInput`	`string`	No description.
`timeoutMillisecondsInput`	`number`	No description.
`tlsConfigInput`	`ApiGatewayIntegrationTlsConfig`	No description.
`typeInput`	`string`	No description.
`uriInput`	`string`	No description.
`cacheKeyParameters`	`string[]`	No description.
`cacheNamespace`	`string`	No description.
`connectionId`	`string`	No description.
`connectionType`	`string`	No description.
`contentHandling`	`string`	No description.
`credentials`	`string`	No description.
`httpMethod`	`string`	No description.
`id`	`string`	No description.
`integrationHttpMethod`	`string`	No description.
`passthroughBehavior`	`string`	No description.
`requestParameters`	`{[ key: string ]: string}`	No description.
`requestTemplates`	`{[ key: string ]: string}`	No description.
`resourceId`	`string`	No description.
`restApiId`	`string`	No description.
`timeoutMilliseconds`	`number`	No description.
`type`	`string`	No description.
`uri`	`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[]

`tlsConfig`^Required

public readonly tlsConfig: ApiGatewayIntegrationTlsConfigOutputReference;

Type: ApiGatewayIntegrationTlsConfigOutputReference

`cacheKeyParametersInput`^Optional

public readonly cacheKeyParametersInput: string[];

Type: string[]

`cacheNamespaceInput`^Optional

public readonly cacheNamespaceInput: string;

Type: string

`connectionIdInput`^Optional

public readonly connectionIdInput: string;

Type: string

`connectionTypeInput`^Optional

public readonly connectionTypeInput: string;

Type: string

`contentHandlingInput`^Optional

public readonly contentHandlingInput: string;

Type: string

`credentialsInput`^Optional

public readonly credentialsInput: string;

Type: string

`httpMethodInput`^Optional

public readonly httpMethodInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`integrationHttpMethodInput`^Optional

public readonly integrationHttpMethodInput: string;

Type: string

`passthroughBehaviorInput`^Optional

public readonly passthroughBehaviorInput: string;

Type: string

`requestParametersInput`^Optional

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

Type: {[ key: string ]: string}

`requestTemplatesInput`^Optional

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

Type: {[ key: string ]: string}

`resourceIdInput`^Optional

public readonly resourceIdInput: string;

Type: string

`restApiIdInput`^Optional

public readonly restApiIdInput: string;

Type: string

`timeoutMillisecondsInput`^Optional

public readonly timeoutMillisecondsInput: number;

Type: number

`tlsConfigInput`^Optional

public readonly tlsConfigInput: ApiGatewayIntegrationTlsConfig;

Type: ApiGatewayIntegrationTlsConfig

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`uriInput`^Optional

public readonly uriInput: string;

Type: string

`cacheKeyParameters`^Required

public readonly cacheKeyParameters: string[];

Type: string[]

`cacheNamespace`^Required

public readonly cacheNamespace: string;

Type: string

`connectionId`^Required

public readonly connectionId: string;

Type: string

`connectionType`^Required

public readonly connectionType: string;

Type: string

`contentHandling`^Required

public readonly contentHandling: string;

Type: string

`credentials`^Required

public readonly credentials: string;

Type: string

`httpMethod`^Required

public readonly httpMethod: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`integrationHttpMethod`^Required

public readonly integrationHttpMethod: string;

Type: string

`passthroughBehavior`^Required

public readonly passthroughBehavior: string;

Type: string

`requestParameters`^Required

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

Type: {[ key: string ]: string}

`requestTemplates`^Required

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

Type: {[ key: string ]: string}

`resourceId`^Required

public readonly resourceId: string;

Type: string

`restApiId`^Required

public readonly restApiId: string;

Type: string

`timeoutMilliseconds`^Required

public readonly timeoutMilliseconds: number;

Type: number

`type`^Required

public readonly type: string;

Type: string

`uri`^Required

public readonly uri: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ApiGatewayIntegrationConfig

Initializer

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

const apiGatewayIntegrationConfig: apiGatewayIntegration.ApiGatewayIntegrationConfig = { ... }

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.
`httpMethod`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.
`resourceId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.
`restApiId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.
`type`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.
`cacheKeyParameters`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.
`cacheNamespace`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.
`connectionId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.
`connectionType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.
`contentHandling`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.
`credentials`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#id ApiGatewayIntegration#id}.
`integrationHttpMethod`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.
`passthroughBehavior`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.
`requestParameters`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.
`requestTemplates`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.
`timeoutMilliseconds`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.
`tlsConfig`	`ApiGatewayIntegrationTlsConfig`	tls_config block.
`uri`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

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

`httpMethod`^Required

public readonly httpMethod: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.

`resourceId`^Required

public readonly resourceId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.

`restApiId`^Required

public readonly restApiId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.

`type`^Required

public readonly type: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.

`cacheKeyParameters`^Optional

public readonly cacheKeyParameters: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.

`cacheNamespace`^Optional

public readonly cacheNamespace: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.

`connectionId`^Optional

public readonly connectionId: string;

Type: string

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

`connectionType`^Optional

public readonly connectionType: string;

Type: string

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

`contentHandling`^Optional

public readonly contentHandling: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.

`credentials`^Optional

public readonly credentials: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.

`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/api_gateway_integration#id ApiGatewayIntegration#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.

`integrationHttpMethod`^Optional

public readonly integrationHttpMethod: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.

`passthroughBehavior`^Optional

public readonly passthroughBehavior: string;

Type: string

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

`requestParameters`^Optional

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/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.

`requestTemplates`^Optional

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/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.

`timeoutMilliseconds`^Optional

public readonly timeoutMilliseconds: number;

Type: number

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

`tlsConfig`^Optional

public readonly tlsConfig: ApiGatewayIntegrationTlsConfig;

Type: ApiGatewayIntegrationTlsConfig

tls_config block.

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

`uri`^Optional

public readonly uri: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

ApiGatewayIntegrationTlsConfig

Initializer

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

const apiGatewayIntegrationTlsConfig: apiGatewayIntegration.ApiGatewayIntegrationTlsConfig = { ... }

Properties

Name	Type	Description
`insecureSkipVerification`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#insecure_skip_verification ApiGatewayIntegration#insecure_skip_verification}.

`insecureSkipVerification`^Optional

public readonly insecureSkipVerification: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_integration#insecure_skip_verification ApiGatewayIntegration#insecure_skip_verification}.

Classes

ApiGatewayIntegrationTlsConfigOutputReference

Initializers

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

new apiGatewayIntegration.ApiGatewayIntegrationTlsConfigOutputReference(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.
`resetInsecureSkipVerification`	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.

`resetInsecureSkipVerification`

public resetInsecureSkipVerification(): 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.
`insecureSkipVerificationInput`	`boolean \| cdktf.IResolvable`	No description.
`insecureSkipVerification`	`boolean \| cdktf.IResolvable`	No description.
`internalValue`	`ApiGatewayIntegrationTlsConfig`	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

`insecureSkipVerificationInput`^Optional

public readonly insecureSkipVerificationInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`insecureSkipVerification`^Required

public readonly insecureSkipVerification: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`internalValue`^Optional

public readonly internalValue: ApiGatewayIntegrationTlsConfig;

Type: ApiGatewayIntegrationTlsConfig

Files

apiGatewayIntegration.md

Latest commit

History

apiGatewayIntegration.md

File metadata and controls

apiGatewayIntegration Submodule

Constructs