Class 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 Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = new Aws.ApiGatewayV2.IntegrationResponse("example", new Aws.ApiGatewayV2.IntegrationResponseArgs
{
ApiId = aws_apigatewayv2_api.Example.Id,
IntegrationId = aws_apigatewayv2_integration.Example.Id,
IntegrationResponseKey = "/200/",
});
}
}
Inherited Members
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public class IntegrationResponse : CustomResource
Constructors
View SourceIntegrationResponse(String, IntegrationResponseArgs, CustomResourceOptions)
Create a IntegrationResponse resource with the given unique name, arguments, and options.
Declaration
public IntegrationResponse(string name, IntegrationResponseArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| IntegrationResponseArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceApiId
The API identifier.
Declaration
public Output<string> ApiId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ContentHandlingStrategy
How to handle response payload content type conversions. Valid values: CONVERT_TO_BINARY, CONVERT_TO_TEXT.
Declaration
public Output<string> ContentHandlingStrategy { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
IntegrationId
The identifier of the aws.apigatewayv2.Integration.
Declaration
public Output<string> IntegrationId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
IntegrationResponseKey
The integration response key.
Declaration
public Output<string> IntegrationResponseKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ResponseTemplates
A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
Declaration
public Output<ImmutableDictionary<string, string>> ResponseTemplates { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
TemplateSelectionExpression
The template selection expression for the integration response.
Declaration
public Output<string> TemplateSelectionExpression { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, IntegrationResponseState, CustomResourceOptions)
Get an existing IntegrationResponse resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static IntegrationResponse Get(string name, Input<string> id, IntegrationResponseState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| IntegrationResponseState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| IntegrationResponse |