Package com.pulumi.aws.apigateway

Class IntegrationArgs

  • public final class IntegrationArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  IntegrationArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static IntegrationArgs.Builder builder()  
      static IntegrationArgs.Builder builder​(IntegrationArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> cacheKeyParameters()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheNamespace()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> connectionId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> connectionType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentHandling()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> credentials()  
      com.pulumi.core.Output<java.lang.String> httpMethod()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> integrationHttpMethod()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> integrationTarget()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> passthroughBehavior()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestParameters()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestTemplates()  
      com.pulumi.core.Output<java.lang.String> resourceId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> responseTransferMode()  
      com.pulumi.core.Output<java.lang.String> restApi()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> timeoutMilliseconds()  
      java.util.Optional<com.pulumi.core.Output<IntegrationTlsConfigArgs>> tlsConfig()  
      com.pulumi.core.Output<java.lang.String> type()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> uri()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • cacheKeyParameters

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> cacheKeyParameters()
        Returns:
        List of cache key parameters for the integration.

      • cacheNamespace

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheNamespace()
        Returns:
        Integration's cache namespace.

      • connectionId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> connectionId()
        Returns:
        ID of the VpcLink used for the integration. **Required** if `connectionType` is `VPC_LINK`

      • connectionType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> connectionType()
        Returns:
        Integration input's [connectionType](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#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).

      • contentHandling

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentHandling()
        Returns:
        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.

      • credentials

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> credentials()
        Returns:
        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/\*`.

      • httpMethod

        public com.pulumi.core.Output<java.lang.String> httpMethod()
        Returns:
        HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`) when calling the associated resource.

      • integrationHttpMethod

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> integrationHttpMethod()
        Returns:
        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](https://github.com/awslabs/aws-apigateway-importer/issues/9#issuecomment-129651005) via `POST`.

      • integrationTarget

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> integrationTarget()
        Returns:
        ALB or NLB ARN to send the request to. Used for private integrations with VPC Link V2. When using VPC Link V2, this parameter specifies the load balancer ARN, while `uri` is used to set the Host header.

      • passthroughBehavior

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> passthroughBehavior()
        Returns:
        Integration passthrough behavior (`WHEN_NO_MATCH`, `WHEN_NO_TEMPLATES`, `NEVER`). **Required** if `requestTemplates` is used.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • requestParameters

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestParameters()
        Returns:
        Map of request query string parameters and headers that should be passed to the backend responder. For example: `requestParameters = { "integration.request.header.X-Some-Other-Header" = "method.request.header.X-Some-Header" }`

      • requestTemplates

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> requestTemplates()
        Returns:
        Map of the integration's request templates.

      • resourceId

        public com.pulumi.core.Output<java.lang.String> resourceId()
        Returns:
        API resource ID.

      • responseTransferMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> responseTransferMode()
        Returns:
        Response transfer mode of the integration. Valid values are `BUFFERED` and `STREAM`. Default to `BUFFERED`. Once set, setting the value to `BUFFERED` requires explicitly specifying `BUFFERED`, rather than removing this argument.

      • restApi

        public com.pulumi.core.Output<java.lang.String> restApi()
        Returns:
        ID of the associated REST API.

      • timeoutMilliseconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> timeoutMilliseconds()
        Returns:
        Custom timeout in milliseconds. The minimum value is 50. The maximum value is 300,000 when `responseTransferMode` is `BUFFERED`, and 900,000 when `responseTransferMode` is `STREAM`. The default value is 29,000 milliseconds. You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase time beyond 29,000 milliseconds for `BUFFERED` mode.

      • tlsConfig

        public java.util.Optional<com.pulumi.core.Output<IntegrationTlsConfigArgs>> tlsConfig()
        Returns:
        TLS configuration. See below.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Integration input's [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/). 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 `connectionType` 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.

      • uri

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> uri()
        Returns:
        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:123456789012:function:my-func/invocations`. For private integrations, the URI parameter is not used for routing requests to your endpoint, but is used for setting the Host header and for certificate validation.