IntegrationResponse class

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

Example Usage

Basic

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

const example = new aws.apigatewayv2.IntegrationResponse("example", {
    apiId: exampleAwsApigatewayv2Api.id,
    integrationId: exampleAwsApigatewayv2Integration.id,
    integrationResponseKey: "/200/",
});
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.IntegrationResponse("example",
    api_id=example_aws_apigatewayv2_api["id"],
    integration_id=example_aws_apigatewayv2_integration["id"],
    integration_response_key="/200/")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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(exampleAwsApigatewayv2Api.Id),
			IntegrationId:          pulumi.Any(exampleAwsApigatewayv2Integration.Id),
			IntegrationResponseKey: pulumi.String("/200/"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_apigatewayv2_integrationresponse" "example" {
  api_id                   = exampleAwsApigatewayv2Api.id
  integration_id           = exampleAwsApigatewayv2Integration.id
  integration_response_key = "/200/"
}
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.ArrayList;
import java.util.Arrays;
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(exampleAwsApigatewayv2Api.id())
            .integrationId(exampleAwsApigatewayv2Integration.id())
            .integrationResponseKey("/200/")
            .build());

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

Import

Using pulumi import, import aws.apigatewayv2.IntegrationResponse using the API identifier, integration identifier and integration response identifier. For example:

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

Constructors

IntegrationResponse(String name, {IntegrationResponseArgs? args, CustomResourceOptions? options})
Creates a new IntegrationResponse. name The Pulumi resource name. args Arguments used to configure this IntegrationResponse. The set of arguments for IntegrationResponse. options Resource options controlling this resource's behavior.
IntegrationResponse.reference(String urn)
Creates a typed reference to an existing IntegrationResponse resource.

Properties

apiId ↔ Output<String>
API identifier.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
contentHandlingStrategy ↔ Output<String?>
How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
integrationId ↔ Output<String>
Identifier of the aws.apigatewayv2.Integration.
latefinal
integrationResponseKey ↔ Output<String>
Integration response key.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
responseTemplates ↔ Output<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.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
templateSelectionExpression ↔ Output<String?>
Template selection expression for the integration response.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {IntegrationResponseState? state, CustomResourceOptions? options}) → IntegrationResponse
Gets an existing IntegrationResponse resource's state with the given name and id.