apigatewayv2_integration.md

permalink
/apigatewayv2_integration/

apigatewayv2_integration

apigatewayv2_integration represents the aws_apigatewayv2_integration Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withApiId()
• fn withConnectionId()
• fn withConnectionType()
• fn withContentHandlingStrategy()
• fn withCredentialsArn()
• fn withDescription()
• fn withIntegrationMethod()
• fn withIntegrationSubtype()
• fn withIntegrationType()
• fn withIntegrationUri()
• fn withPassthroughBehavior()
• fn withPayloadFormatVersion()
• fn withRequestParameters()
• fn withRequestTemplates()
• fn withResponseParameters()
• fn withResponseParametersMixin()
• fn withTemplateSelectionExpression()
• fn withTimeoutMilliseconds()
• fn withTlsConfig()
• fn withTlsConfigMixin()
• obj response_parameters
  • fn new()
• obj tls_config
  • fn new()

Fields

fn new

new()

aws.apigatewayv2_integration.new injects a new aws_apigatewayv2_integration Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.apigatewayv2_integration.new('some_id')

You can get the reference to the id field of the created aws.apigatewayv2_integration using the reference:

$._ref.aws_apigatewayv2_integration.some_id.get('id')

This is the same as directly entering "${ aws_apigatewayv2_integration.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• api_id (string): Set the api_id field on the resulting resource block.
• connection_id (string): Set the connection_id field on the resulting resource block. When null, the connection_id field will be omitted from the resulting object.
• connection_type (string): Set the connection_type field on the resulting resource block. When null, the connection_type field will be omitted from the resulting object.
• content_handling_strategy (string): Set the content_handling_strategy field on the resulting resource block. When null, the content_handling_strategy field will be omitted from the resulting object.
• credentials_arn (string): Set the credentials_arn field on the resulting resource block. When null, the credentials_arn field will be omitted from the resulting object.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• integration_method (string): Set the integration_method field on the resulting resource block. When null, the integration_method field will be omitted from the resulting object.
• integration_subtype (string): Set the integration_subtype field on the resulting resource block. When null, the integration_subtype field will be omitted from the resulting object.
• integration_type (string): Set the integration_type field on the resulting resource block.
• integration_uri (string): Set the integration_uri field on the resulting resource block. When null, the integration_uri field will be omitted from the resulting object.
• passthrough_behavior (string): Set the passthrough_behavior field on the resulting resource block. When null, the passthrough_behavior field will be omitted from the resulting object.
• payload_format_version (string): Set the payload_format_version field on the resulting resource block. When null, the payload_format_version field will be omitted from the resulting object.
• request_parameters (obj): Set the request_parameters field on the resulting resource block. When null, the request_parameters field will be omitted from the resulting object.
• request_templates (obj): Set the request_templates field on the resulting resource block. When null, the request_templates field will be omitted from the resulting object.
• template_selection_expression (string): Set the template_selection_expression field on the resulting resource block. When null, the template_selection_expression field will be omitted from the resulting object.
• timeout_milliseconds (number): Set the timeout_milliseconds field on the resulting resource block. When null, the timeout_milliseconds field will be omitted from the resulting object.
• response_parameters (list[obj]): Set the response_parameters field on the resulting resource block. When null, the response_parameters sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.apigatewayv2_integration.response_parameters.new constructor.
• tls_config (list[obj]): Set the tls_config field on the resulting resource block. When null, the tls_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.apigatewayv2_integration.tls_config.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.apigatewayv2_integration.newAttrs constructs a new object with attributes and blocks configured for the apigatewayv2_integration Terraform resource.

Unlike aws.apigatewayv2_integration.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• api_id (string): Set the api_id field on the resulting object.
• connection_id (string): Set the connection_id field on the resulting object. When null, the connection_id field will be omitted from the resulting object.
• connection_type (string): Set the connection_type field on the resulting object. When null, the connection_type field will be omitted from the resulting object.
• content_handling_strategy (string): Set the content_handling_strategy field on the resulting object. When null, the content_handling_strategy field will be omitted from the resulting object.
• credentials_arn (string): Set the credentials_arn field on the resulting object. When null, the credentials_arn field will be omitted from the resulting object.
• description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
• integration_method (string): Set the integration_method field on the resulting object. When null, the integration_method field will be omitted from the resulting object.
• integration_subtype (string): Set the integration_subtype field on the resulting object. When null, the integration_subtype field will be omitted from the resulting object.
• integration_type (string): Set the integration_type field on the resulting object.
• integration_uri (string): Set the integration_uri field on the resulting object. When null, the integration_uri field will be omitted from the resulting object.
• passthrough_behavior (string): Set the passthrough_behavior field on the resulting object. When null, the passthrough_behavior field will be omitted from the resulting object.
• payload_format_version (string): Set the payload_format_version field on the resulting object. When null, the payload_format_version field will be omitted from the resulting object.
• request_parameters (obj): Set the request_parameters field on the resulting object. When null, the request_parameters field will be omitted from the resulting object.
• request_templates (obj): Set the request_templates field on the resulting object. When null, the request_templates field will be omitted from the resulting object.
• template_selection_expression (string): Set the template_selection_expression field on the resulting object. When null, the template_selection_expression field will be omitted from the resulting object.
• timeout_milliseconds (number): Set the timeout_milliseconds field on the resulting object. When null, the timeout_milliseconds field will be omitted from the resulting object.
• response_parameters (list[obj]): Set the response_parameters field on the resulting object. When null, the response_parameters sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.apigatewayv2_integration.response_parameters.new constructor.
• tls_config (list[obj]): Set the tls_config field on the resulting object. When null, the tls_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.apigatewayv2_integration.tls_config.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new apigatewayv2_integration resource into the root Terraform configuration.

fn withApiId

withApiId()

aws.string.withApiId constructs a mixin object that can be merged into the string Terraform resource block to set or update the api_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the api_id field.

fn withConnectionId

withConnectionId()

aws.string.withConnectionId constructs a mixin object that can be merged into the string Terraform resource block to set or update the connection_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the connection_id field.

fn withConnectionType

withConnectionType()

aws.string.withConnectionType constructs a mixin object that can be merged into the string Terraform resource block to set or update the connection_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the connection_type field.

fn withContentHandlingStrategy

withContentHandlingStrategy()

aws.string.withContentHandlingStrategy constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_handling_strategy field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_handling_strategy field.

fn withCredentialsArn

withCredentialsArn()

aws.string.withCredentialsArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the credentials_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the credentials_arn field.

fn withDescription

withDescription()

aws.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the description field.

fn withIntegrationMethod

withIntegrationMethod()

aws.string.withIntegrationMethod constructs a mixin object that can be merged into the string Terraform resource block to set or update the integration_method field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the integration_method field.

fn withIntegrationSubtype

withIntegrationSubtype()

aws.string.withIntegrationSubtype constructs a mixin object that can be merged into the string Terraform resource block to set or update the integration_subtype field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the integration_subtype field.

fn withIntegrationType

withIntegrationType()

aws.string.withIntegrationType constructs a mixin object that can be merged into the string Terraform resource block to set or update the integration_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the integration_type field.

fn withIntegrationUri

withIntegrationUri()

aws.string.withIntegrationUri constructs a mixin object that can be merged into the string Terraform resource block to set or update the integration_uri field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the integration_uri field.

fn withPassthroughBehavior

withPassthroughBehavior()

aws.string.withPassthroughBehavior constructs a mixin object that can be merged into the string Terraform resource block to set or update the passthrough_behavior field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the passthrough_behavior field.

fn withPayloadFormatVersion

withPayloadFormatVersion()

aws.string.withPayloadFormatVersion constructs a mixin object that can be merged into the string Terraform resource block to set or update the payload_format_version field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the payload_format_version field.

fn withRequestParameters

withRequestParameters()

aws.obj.withRequestParameters constructs a mixin object that can be merged into the obj Terraform resource block to set or update the request_parameters field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the request_parameters field.

fn withRequestTemplates

withRequestTemplates()

aws.obj.withRequestTemplates constructs a mixin object that can be merged into the obj Terraform resource block to set or update the request_templates field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the request_templates field.

fn withResponseParameters

withResponseParameters()

aws.list[obj].withResponseParameters constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the response_parameters field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withResponseParametersMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the response_parameters field.

fn withResponseParametersMixin

withResponseParametersMixin()

aws.list[obj].withResponseParametersMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the response_parameters field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withResponseParameters function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the response_parameters field.

fn withTemplateSelectionExpression

withTemplateSelectionExpression()

aws.string.withTemplateSelectionExpression constructs a mixin object that can be merged into the string Terraform resource block to set or update the template_selection_expression field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the template_selection_expression field.

fn withTimeoutMilliseconds

withTimeoutMilliseconds()

aws.number.withTimeoutMilliseconds constructs a mixin object that can be merged into the number Terraform resource block to set or update the timeout_milliseconds field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the timeout_milliseconds field.

fn withTlsConfig

withTlsConfig()

aws.list[obj].withTlsConfig constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the tls_config field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withTlsConfigMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the tls_config field.

fn withTlsConfigMixin

withTlsConfigMixin()

aws.list[obj].withTlsConfigMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the tls_config field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withTlsConfig function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the tls_config field.

obj response_parameters

fn response_parameters.new

new()

aws.apigatewayv2_integration.response_parameters.new constructs a new object with attributes and blocks configured for the response_parameters Terraform sub block.

Args:

• mappings (obj): Set the mappings field on the resulting object.
• status_code (string): Set the status_code field on the resulting object.

Returns:

• An attribute object that represents the response_parameters sub block.

obj tls_config

fn tls_config.new

new()

aws.apigatewayv2_integration.tls_config.new constructs a new object with attributes and blocks configured for the tls_config Terraform sub block.

Args:

• server_name_to_verify (string): Set the server_name_to_verify field on the resulting object. When null, the server_name_to_verify field will be omitted from the resulting object.

Returns:

• An attribute object that represents the tls_config sub block.