@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
108 lines (107 loc) • 7.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The ``AWS::ApiGatewayV2::IntegrationResponse`` resource updates an integration response for an WebSocket API. For more information, see [Set up WebSocket API Integration Responses in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html) in the *API Gateway Developer Guide*.
*/
export declare class IntegrationResponse extends pulumi.CustomResource {
/**
* Get an existing IntegrationResponse resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): IntegrationResponse;
/**
* Returns true if the given object is an instance of IntegrationResponse. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IntegrationResponse;
/**
* The API identifier.
*/
readonly apiId: pulumi.Output<string>;
/**
* Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:
* ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
* ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.
* If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
*/
readonly contentHandlingStrategy: pulumi.Output<string | undefined>;
/**
* The integration ID.
*/
readonly integrationId: pulumi.Output<string>;
/**
* The integration response ID.
*/
readonly integrationResponseId: pulumi.Output<string>;
/**
* The integration response key.
*/
readonly integrationResponseKey: pulumi.Output<string>;
/**
* A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
*/
readonly responseParameters: pulumi.Output<any | undefined>;
/**
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
*/
readonly responseTemplates: pulumi.Output<any | undefined>;
/**
* The template selection expression for the integration response. Supported only for WebSocket APIs.
*/
readonly templateSelectionExpression: pulumi.Output<string | undefined>;
/**
* Create a IntegrationResponse resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IntegrationResponseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a IntegrationResponse resource.
*/
export interface IntegrationResponseArgs {
/**
* The API identifier.
*/
apiId: pulumi.Input<string>;
/**
* Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:
* ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
* ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.
* If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
*/
contentHandlingStrategy?: pulumi.Input<string>;
/**
* The integration ID.
*/
integrationId: pulumi.Input<string>;
/**
* The integration response key.
*/
integrationResponseKey: pulumi.Input<string>;
/**
* A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
*/
responseParameters?: any;
/**
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGatewayV2::IntegrationResponse` for more information about the expected schema for this property.
*/
responseTemplates?: any;
/**
* The template selection expression for the integration response. Supported only for WebSocket APIs.
*/
templateSelectionExpression?: pulumi.Input<string>;
}