`apiGatewayIntegration` Submodule

Constructs

ApiGatewayIntegration

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

Initializers

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegration(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  http_method: str,
  resource_id: str,
  rest_api_id: str,
  type: str,
  cache_key_parameters: typing.List[str] = None,
  cache_namespace: str = None,
  connection_id: str = None,
  connection_type: str = None,
  content_handling: str = None,
  credentials: str = None,
  id: str = None,
  integration_http_method: str = None,
  integration_target: str = None,
  passthrough_behavior: str = None,
  region: str = None,
  request_parameters: typing.Mapping[str] = None,
  request_templates: typing.Mapping[str] = None,
  response_transfer_mode: str = None,
  timeout_milliseconds: typing.Union[int, float] = None,
  tls_config: ApiGatewayIntegrationTlsConfig = None,
  uri: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.
`resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.
`cache_key_parameters`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.
`cache_namespace`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.
`connection_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.
`connection_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.
`content_handling`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.
`credentials`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#id}.
`integration_http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.
`integration_target`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#integration_target ApiGatewayIntegration#integration_target}.
`passthrough_behavior`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`request_parameters`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.
`request_templates`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.
`response_transfer_mode`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#response_transfer_mode ApiGatewayIntegration#response_transfer_mode}.
`timeout_milliseconds`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.
`tls_config`	`ApiGatewayIntegrationTlsConfig`	tls_config block.
`uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`http_method`^Required

Type: str

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

`resource_id`^Required

Type: str

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

`rest_api_id`^Required

Type: str

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

`type`^Required

Type: str

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

`cache_key_parameters`^Optional

Type: typing.List[str]

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

`cache_namespace`^Optional

Type: str

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

`connection_id`^Optional

Type: str

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

`connection_type`^Optional

Type: str

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

`content_handling`^Optional

Type: str

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

`credentials`^Optional

Type: str

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

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/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.

`integration_http_method`^Optional

Type: str

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

`integration_target`^Optional

Type: str

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

`passthrough_behavior`^Optional

Type: str

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

`region`^Optional

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`request_parameters`^Optional

Type: typing.Mapping[str]

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

`request_templates`^Optional

Type: typing.Mapping[str]

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

`response_transfer_mode`^Optional

Type: str

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

`timeout_milliseconds`^Optional

Type: typing.Union[int, float]

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

`tls_config`^Optional

Type: ApiGatewayIntegrationTlsConfig

tls_config block.

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

`uri`^Optional

Type: str

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_tls_config`	No description.
`reset_cache_key_parameters`	No description.
`reset_cache_namespace`	No description.
`reset_connection_id`	No description.
`reset_connection_type`	No description.
`reset_content_handling`	No description.
`reset_credentials`	No description.
`reset_id`	No description.
`reset_integration_http_method`	No description.
`reset_integration_target`	No description.
`reset_passthrough_behavior`	No description.
`reset_region`	No description.
`reset_request_parameters`	No description.
`reset_request_templates`	No description.
`reset_response_transfer_mode`	No description.
`reset_timeout_milliseconds`	No description.
`reset_tls_config`	No description.
`reset_uri`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`put_tls_config`

def put_tls_config(
  insecure_skip_verification: bool | IResolvable = None
) -> None

`insecure_skip_verification`^Optional

Type: bool | cdktf.IResolvable

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

`reset_cache_key_parameters`

def reset_cache_key_parameters() -> None

`reset_cache_namespace`

def reset_cache_namespace() -> None

`reset_connection_id`

def reset_connection_id() -> None

`reset_connection_type`

def reset_connection_type() -> None

`reset_content_handling`

def reset_content_handling() -> None

`reset_credentials`

def reset_credentials() -> None

`reset_id`

def reset_id() -> None

`reset_integration_http_method`

def reset_integration_http_method() -> None

`reset_integration_target`

def reset_integration_target() -> None

`reset_passthrough_behavior`

def reset_passthrough_behavior() -> None

`reset_region`

def reset_region() -> None

`reset_request_parameters`

def reset_request_parameters() -> None

`reset_request_templates`

def reset_request_templates() -> None

`reset_response_transfer_mode`

def reset_response_transfer_mode() -> None

`reset_timeout_milliseconds`

def reset_timeout_milliseconds() -> None

`reset_tls_config`

def reset_tls_config() -> None

`reset_uri`

def reset_uri() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a ApiGatewayIntegration resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegration.is_construct(
  x: typing.Any
)

Checks if x is a construct.

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

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

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegration.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegration.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegration.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing ApiGatewayIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/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.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`tls_config`	`ApiGatewayIntegrationTlsConfigOutputReference`	No description.
`cache_key_parameters_input`	`typing.List[str]`	No description.
`cache_namespace_input`	`str`	No description.
`connection_id_input`	`str`	No description.
`connection_type_input`	`str`	No description.
`content_handling_input`	`str`	No description.
`credentials_input`	`str`	No description.
`http_method_input`	`str`	No description.
`id_input`	`str`	No description.
`integration_http_method_input`	`str`	No description.
`integration_target_input`	`str`	No description.
`passthrough_behavior_input`	`str`	No description.
`region_input`	`str`	No description.
`request_parameters_input`	`typing.Mapping[str]`	No description.
`request_templates_input`	`typing.Mapping[str]`	No description.
`resource_id_input`	`str`	No description.
`response_transfer_mode_input`	`str`	No description.
`rest_api_id_input`	`str`	No description.
`timeout_milliseconds_input`	`typing.Union[int, float]`	No description.
`tls_config_input`	`ApiGatewayIntegrationTlsConfig`	No description.
`type_input`	`str`	No description.
`uri_input`	`str`	No description.
`cache_key_parameters`	`typing.List[str]`	No description.
`cache_namespace`	`str`	No description.
`connection_id`	`str`	No description.
`connection_type`	`str`	No description.
`content_handling`	`str`	No description.
`credentials`	`str`	No description.
`http_method`	`str`	No description.
`id`	`str`	No description.
`integration_http_method`	`str`	No description.
`integration_target`	`str`	No description.
`passthrough_behavior`	`str`	No description.
`region`	`str`	No description.
`request_parameters`	`typing.Mapping[str]`	No description.
`request_templates`	`typing.Mapping[str]`	No description.
`resource_id`	`str`	No description.
`response_transfer_mode`	`str`	No description.
`rest_api_id`	`str`	No description.
`timeout_milliseconds`	`typing.Union[int, float]`	No description.
`type`	`str`	No description.
`uri`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`tls_config`^Required

tls_config: ApiGatewayIntegrationTlsConfigOutputReference

Type: ApiGatewayIntegrationTlsConfigOutputReference

`cache_key_parameters_input`^Optional

cache_key_parameters_input: typing.List[str]

Type: typing.List[str]

`cache_namespace_input`^Optional

cache_namespace_input: str

Type: str

`connection_id_input`^Optional

connection_id_input: str

Type: str

`connection_type_input`^Optional

connection_type_input: str

Type: str

`content_handling_input`^Optional

content_handling_input: str

Type: str

`credentials_input`^Optional

credentials_input: str

Type: str

`http_method_input`^Optional

http_method_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`integration_http_method_input`^Optional

integration_http_method_input: str

Type: str

`integration_target_input`^Optional

integration_target_input: str

Type: str

`passthrough_behavior_input`^Optional

passthrough_behavior_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`request_parameters_input`^Optional

request_parameters_input: typing.Mapping[str]

Type: typing.Mapping[str]

`request_templates_input`^Optional

request_templates_input: typing.Mapping[str]

Type: typing.Mapping[str]

`resource_id_input`^Optional

resource_id_input: str

Type: str

`response_transfer_mode_input`^Optional

response_transfer_mode_input: str

Type: str

`rest_api_id_input`^Optional

rest_api_id_input: str

Type: str

`timeout_milliseconds_input`^Optional

timeout_milliseconds_input: typing.Union[int, float]

Type: typing.Union[int, float]

`tls_config_input`^Optional

tls_config_input: ApiGatewayIntegrationTlsConfig

Type: ApiGatewayIntegrationTlsConfig

`type_input`^Optional

type_input: str

Type: str

`uri_input`^Optional

uri_input: str

Type: str

`cache_key_parameters`^Required

cache_key_parameters: typing.List[str]

Type: typing.List[str]

`cache_namespace`^Required

cache_namespace: str

Type: str

`connection_id`^Required

connection_id: str

Type: str

`connection_type`^Required

connection_type: str

Type: str

`content_handling`^Required

content_handling: str

Type: str

`credentials`^Required

credentials: str

Type: str

`http_method`^Required

http_method: str

Type: str

`id`^Required

id: str

Type: str

`integration_http_method`^Required

integration_http_method: str

Type: str

`integration_target`^Required

integration_target: str

Type: str

`passthrough_behavior`^Required

passthrough_behavior: str

Type: str

`region`^Required

region: str

Type: str

`request_parameters`^Required

request_parameters: typing.Mapping[str]

Type: typing.Mapping[str]

`request_templates`^Required

request_templates: typing.Mapping[str]

Type: typing.Mapping[str]

`resource_id`^Required

resource_id: str

Type: str

`response_transfer_mode`^Required

response_transfer_mode: str

Type: str

`rest_api_id`^Required

rest_api_id: str

Type: str

`timeout_milliseconds`^Required

timeout_milliseconds: typing.Union[int, float]

Type: typing.Union[int, float]

`type`^Required

type: str

Type: str

`uri`^Required

uri: str

Type: str

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

ApiGatewayIntegrationConfig

Initializer

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegrationConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  http_method: str,
  resource_id: str,
  rest_api_id: str,
  type: str,
  cache_key_parameters: typing.List[str] = None,
  cache_namespace: str = None,
  connection_id: str = None,
  connection_type: str = None,
  content_handling: str = None,
  credentials: str = None,
  id: str = None,
  integration_http_method: str = None,
  integration_target: str = None,
  passthrough_behavior: str = None,
  region: str = None,
  request_parameters: typing.Mapping[str] = None,
  request_templates: typing.Mapping[str] = None,
  response_transfer_mode: str = None,
  timeout_milliseconds: typing.Union[int, float] = None,
  tls_config: ApiGatewayIntegrationTlsConfig = None,
  uri: str = None
)

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#http_method ApiGatewayIntegration#http_method}.
`resource_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#resource_id ApiGatewayIntegration#resource_id}.
`rest_api_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#rest_api_id ApiGatewayIntegration#rest_api_id}.
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#type ApiGatewayIntegration#type}.
`cache_key_parameters`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#cache_key_parameters ApiGatewayIntegration#cache_key_parameters}.
`cache_namespace`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#cache_namespace ApiGatewayIntegration#cache_namespace}.
`connection_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#connection_id ApiGatewayIntegration#connection_id}.
`connection_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#connection_type ApiGatewayIntegration#connection_type}.
`content_handling`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#content_handling ApiGatewayIntegration#content_handling}.
`credentials`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#credentials ApiGatewayIntegration#credentials}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#id ApiGatewayIntegration#id}.
`integration_http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#integration_http_method ApiGatewayIntegration#integration_http_method}.
`integration_target`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#integration_target ApiGatewayIntegration#integration_target}.
`passthrough_behavior`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#passthrough_behavior ApiGatewayIntegration#passthrough_behavior}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`request_parameters`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#request_parameters ApiGatewayIntegration#request_parameters}.
`request_templates`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#request_templates ApiGatewayIntegration#request_templates}.
`response_transfer_mode`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#response_transfer_mode ApiGatewayIntegration#response_transfer_mode}.
`timeout_milliseconds`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#timeout_milliseconds ApiGatewayIntegration#timeout_milliseconds}.
`tls_config`	`ApiGatewayIntegrationTlsConfig`	tls_config block.
`uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/api_gateway_integration#uri ApiGatewayIntegration#uri}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`http_method`^Required

http_method: str

Type: str

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

`resource_id`^Required

resource_id: str

Type: str

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

`rest_api_id`^Required

rest_api_id: str

Type: str

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

`type`^Required

type: str

Type: str

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

`cache_key_parameters`^Optional

cache_key_parameters: typing.List[str]

Type: typing.List[str]

`cache_namespace`^Optional

cache_namespace: str

Type: str

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

`connection_id`^Optional

connection_id: str

Type: str

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

`connection_type`^Optional

connection_type: str

Type: str

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

`content_handling`^Optional

content_handling: str

Type: str

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

`credentials`^Optional

credentials: str

Type: str

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

`id`^Optional

id: str

Type: str

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

`integration_http_method`^Optional

integration_http_method: str

Type: str

`integration_target`^Optional

integration_target: str

Type: str

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

`passthrough_behavior`^Optional

passthrough_behavior: str

Type: str

`region`^Optional

region: str

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`request_parameters`^Optional

request_parameters: typing.Mapping[str]

Type: typing.Mapping[str]

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

`request_templates`^Optional

request_templates: typing.Mapping[str]

Type: typing.Mapping[str]

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

`response_transfer_mode`^Optional

response_transfer_mode: str

Type: str

`timeout_milliseconds`^Optional

timeout_milliseconds: typing.Union[int, float]

Type: typing.Union[int, float]

`tls_config`^Optional

tls_config: ApiGatewayIntegrationTlsConfig

Type: ApiGatewayIntegrationTlsConfig

tls_config block.

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

`uri`^Optional

uri: str

Type: str

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

ApiGatewayIntegrationTlsConfig

Initializer

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegrationTlsConfig(
  insecure_skip_verification: bool | IResolvable = None
)

Properties

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

`insecure_skip_verification`^Optional

insecure_skip_verification: bool | IResolvable

Type: bool | cdktf.IResolvable

Classes

ApiGatewayIntegrationTlsConfigOutputReference

Initializers

from cdktf_cdktf_provider_aws import api_gateway_integration

apiGatewayIntegration.ApiGatewayIntegrationTlsConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_insecure_skip_verification`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_insecure_skip_verification`

def reset_insecure_skip_verification() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`insecure_skip_verification_input`	`bool \| cdktf.IResolvable`	No description.
`insecure_skip_verification`	`bool \| cdktf.IResolvable`	No description.
`internal_value`	`ApiGatewayIntegrationTlsConfig`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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

fqn: str

Type: str

`insecure_skip_verification_input`^Optional

insecure_skip_verification_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`insecure_skip_verification`^Required

insecure_skip_verification: bool | IResolvable

Type: bool | cdktf.IResolvable

`internal_value`^Optional

internal_value: ApiGatewayIntegrationTlsConfig

Type: ApiGatewayIntegrationTlsConfig

FilesExpand file tree

apiGatewayIntegration.python.md

Latest commit

History

apiGatewayIntegration.python.md

File metadata and controls

apiGatewayIntegration Submodule

Constructs