AWS Classic v5.33.0, Mar 24 23

aws.apigatewayv2.IntegrationResponse

Manages an Amazon API Gateway Version 2 integration response. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ApiGatewayV2.IntegrationResponse("example", new()
    {
        ApiId = aws_apigatewayv2_api.Example.Id,
        IntegrationId = aws_apigatewayv2_integration.Example.Id,
        IntegrationResponseKey = "/200/",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.NewIntegrationResponse(ctx, "example", &apigatewayv2.IntegrationResponseArgs{
			ApiId:                  pulumi.Any(aws_apigatewayv2_api.Example.Id),
			IntegrationId:          pulumi.Any(aws_apigatewayv2_integration.Example.Id),
			IntegrationResponseKey: pulumi.String("/200/"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.IntegrationResponse;
import com.pulumi.aws.apigatewayv2.IntegrationResponseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IntegrationResponse("example", IntegrationResponseArgs.builder()        
            .apiId(aws_apigatewayv2_api.example().id())
            .integrationId(aws_apigatewayv2_integration.example().id())
            .integrationResponseKey("/200/")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.IntegrationResponse("example",
    api_id=aws_apigatewayv2_api["example"]["id"],
    integration_id=aws_apigatewayv2_integration["example"]["id"],
    integration_response_key="/200/")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apigatewayv2.IntegrationResponse("example", {
    apiId: aws_apigatewayv2_api.example.id,
    integrationId: aws_apigatewayv2_integration.example.id,
    integrationResponseKey: "/200/",
});

resources:
  example:
    type: aws:apigatewayv2:IntegrationResponse
    properties:
      apiId: ${aws_apigatewayv2_api.example.id}
      integrationId: ${aws_apigatewayv2_integration.example.id}
      integrationResponseKey: /200/

Create IntegrationResponse Resource

new IntegrationResponse(name: string, args: IntegrationResponseArgs, opts?: CustomResourceOptions);

@overload
def IntegrationResponse(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_id: Optional[str] = None,
                        content_handling_strategy: Optional[str] = None,
                        integration_id: Optional[str] = None,
                        integration_response_key: Optional[str] = None,
                        response_templates: Optional[Mapping[str, str]] = None,
                        template_selection_expression: Optional[str] = None)
@overload
def IntegrationResponse(resource_name: str,
                        args: IntegrationResponseArgs,
                        opts: Optional[ResourceOptions] = None)

func NewIntegrationResponse(ctx *Context, name string, args IntegrationResponseArgs, opts ...ResourceOption) (*IntegrationResponse, error)

public IntegrationResponse(string name, IntegrationResponseArgs args, CustomResourceOptions? opts = null)

public IntegrationResponse(String name, IntegrationResponseArgs args)
public IntegrationResponse(String name, IntegrationResponseArgs args, CustomResourceOptions options)

type: aws:apigatewayv2:IntegrationResponse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IntegrationResponseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args IntegrationResponseArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IntegrationResponseArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IntegrationResponseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IntegrationResponseArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

IntegrationResponse Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The IntegrationResponse resource accepts the following input properties:

ApiId string: API identifier.
IntegrationId string: Identifier of the aws.apigatewayv2.Integration.
IntegrationResponseKey string: Integration response key.
ContentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
ResponseTemplates Dictionary<string, string>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
TemplateSelectionExpression string: The template selection expression for the integration response.

ApiId string: API identifier.
IntegrationId string: Identifier of the aws.apigatewayv2.Integration.
IntegrationResponseKey string: Integration response key.
ContentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
ResponseTemplates map[string]string: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
TemplateSelectionExpression string: The template selection expression for the integration response.

apiId String: API identifier.
integrationId String: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey String: Integration response key.
contentHandlingStrategy String: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
responseTemplates Map<String,String>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression String: The template selection expression for the integration response.

apiId string: API identifier.
integrationId string: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey string: Integration response key.
contentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
responseTemplates {[key: string]: string}: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression string: The template selection expression for the integration response.

api_id str: API identifier.
integration_id str: Identifier of the aws.apigatewayv2.Integration.
integration_response_key str: Integration response key.
content_handling_strategy str: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
response_templates Mapping[str, str]: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
template_selection_expression str: The template selection expression for the integration response.

apiId String: API identifier.
integrationId String: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey String: Integration response key.
contentHandlingStrategy String: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
responseTemplates Map<String>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression String: The template selection expression for the integration response.

Outputs

All input properties are implicitly available as output properties. Additionally, the IntegrationResponse resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing IntegrationResponse Resource

Get an existing IntegrationResponse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IntegrationResponseState, opts?: CustomResourceOptions): IntegrationResponse

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        content_handling_strategy: Optional[str] = None,
        integration_id: Optional[str] = None,
        integration_response_key: Optional[str] = None,
        response_templates: Optional[Mapping[str, str]] = None,
        template_selection_expression: Optional[str] = None) -> IntegrationResponse

func GetIntegrationResponse(ctx *Context, name string, id IDInput, state *IntegrationResponseState, opts ...ResourceOption) (*IntegrationResponse, error)

public static IntegrationResponse Get(string name, Input<string> id, IntegrationResponseState? state, CustomResourceOptions? opts = null)

public static IntegrationResponse get(String name, Output<String> id, IntegrationResponseState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiId string: API identifier.
ContentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
IntegrationId string: Identifier of the aws.apigatewayv2.Integration.
IntegrationResponseKey string: Integration response key.
ResponseTemplates Dictionary<string, string>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
TemplateSelectionExpression string: The template selection expression for the integration response.

ApiId string: API identifier.
ContentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
IntegrationId string: Identifier of the aws.apigatewayv2.Integration.
IntegrationResponseKey string: Integration response key.
ResponseTemplates map[string]string: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
TemplateSelectionExpression string: The template selection expression for the integration response.

apiId String: API identifier.
contentHandlingStrategy String: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
integrationId String: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey String: Integration response key.
responseTemplates Map<String,String>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression String: The template selection expression for the integration response.

apiId string: API identifier.
contentHandlingStrategy string: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
integrationId string: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey string: Integration response key.
responseTemplates {[key: string]: string}: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression string: The template selection expression for the integration response.

api_id str: API identifier.
content_handling_strategy str: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
integration_id str: Identifier of the aws.apigatewayv2.Integration.
integration_response_key str: Integration response key.
response_templates Mapping[str, str]: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
template_selection_expression str: The template selection expression for the integration response.

apiId String: API identifier.
contentHandlingStrategy String: How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
integrationId String: Identifier of the aws.apigatewayv2.Integration.
integrationResponseKey String: Integration response key.
responseTemplates Map<String>: Map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
templateSelectionExpression String: The template selection expression for the integration response.

Import

aws_apigatewayv2_integration_response can be imported by using the API identifier, integration identifier and integration response identifier, e.g.,

 $ pulumi import aws:apigatewayv2/integrationResponse:IntegrationResponse example aabbccddee/1122334/998877

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.