Class IntegrationArgs

Inheritance
System.Object
InputArgs
ResourceArgs
IntegrationArgs
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ApiGateway
Assembly: Pulumi.Aws.dll
Syntax
public sealed class IntegrationArgs : ResourceArgs

Constructors

View Source

IntegrationArgs()

Declaration
public IntegrationArgs()

Properties

View Source

CacheKeyParameters

A list of cache key parameters for the integration.

Declaration
public InputList<string> CacheKeyParameters { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

CacheNamespace

The integration's cache namespace.

Declaration
public Input<string> CacheNamespace { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ConnectionId

The id of the VpcLink used for the integration. Required if connection_type is VPC_LINK

Declaration
public Input<string> ConnectionId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ConnectionType

The integration input's connectionType. Valid values are INTERNET (default for connections through the public routable internet), and VPC_LINK (for private connections between API Gateway and a network load balancer in a VPC).

Declaration
public Input<string> ConnectionType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ContentHandling

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Declaration
public Input<string> ContentHandling { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Credentials

The credentials required for the integration. For AWS integrations, 2 options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's ARN. To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*.

Declaration
public Input<string> Credentials { get; set; }
Property Value
Type Description
Input<System.String>
View Source

HttpMethod

The HTTP method (GET, POST, PUT, DELETE, HEAD, OPTION, ANY) when calling the associated resource.

Declaration
public Input<string> HttpMethod { get; set; }
Property Value
Type Description
Input<System.String>
View Source

IntegrationHttpMethod

The integration HTTP method (GET, POST, PUT, DELETE, HEAD, OPTIONs, ANY, PATCH) specifying how API Gateway will interact with the back end. Required if type is AWS, AWS_PROXY, HTTP or HTTP_PROXY. Not all methods are compatible with all AWS integrations. e.g. Lambda function can only be invoked via POST.

Declaration
public Input<string> IntegrationHttpMethod { get; set; }
Property Value
Type Description
Input<System.String>
View Source

PassthroughBehavior

The integration passthrough behavior (WHEN_NO_MATCH, WHEN_NO_TEMPLATES, NEVER). Required if request_templates is used.

Declaration
public Input<string> PassthroughBehavior { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RequestParameters

A map of request query string parameters and headers that should be passed to the backend responder. For example: request_parameters = { &quot;integration.request.header.X-Some-Other-Header&quot; = &quot;method.request.header.X-Some-Header&quot; }

Declaration
public InputMap<string> RequestParameters { get; set; }
Property Value
Type Description
InputMap<System.String>
View Source

RequestTemplates

A map of the integration's request templates.

Declaration
public InputMap<string> RequestTemplates { get; set; }
Property Value
Type Description
InputMap<System.String>
View Source

ResourceId

The API resource ID.

Declaration
public Input<string> ResourceId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

RestApi

The ID of the associated REST API.

Declaration
public Input<string> RestApi { get; set; }
Property Value
Type Description
Input<System.String>
View Source

TimeoutMilliseconds

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds.

Declaration
public Input<int> TimeoutMilliseconds { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

Type

The integration input's type. Valid values are HTTP (for HTTP backends), MOCK (not calling any real backend), AWS (for AWS services), AWS_PROXY (for Lambda proxy integration) and HTTP_PROXY (for HTTP proxy integration). An HTTP or HTTP_PROXY integration with a connection_type of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

Declaration
public Input<string> Type { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Uri

The input's URI. Required if type is AWS, AWS_PROXY, HTTP or HTTP_PROXY. For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. region, subdomain and service are used to determine the right endpoint. e.g. arn:aws:apigateway:eu-west-1:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-1:012345678901:function:my-func/invocations

Declaration
public Input<string> Uri { get; set; }
Property Value
Type Description
Input<System.String>