Integration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.Integration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Integration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

Creating an API

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Integration()

Constructors
Constructor and Description
`Integration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integration`	`addIntegrationResponsesEntry(String key, IntegrationResponse value)` Add a single IntegrationResponses entry
`Integration`	`addRequestParametersEntry(String key, String value)` Add a single RequestParameters entry
`Integration`	`addRequestTemplatesEntry(String key, String value)` Add a single RequestTemplates entry
`Integration`	`clearIntegrationResponsesEntries()` Removes all the entries added into IntegrationResponses.
`Integration`	`clearRequestParametersEntries()` Removes all the entries added into RequestParameters.
`Integration`	`clearRequestTemplatesEntries()` Removes all the entries added into RequestTemplates.
`Integration`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCacheKeyParameters()` A list of request parameters whose values API Gateway caches.
`String`	`getCacheNamespace()` Specifies a group of related cached parameters.
`String`	`getConnectionId()` The (`id`) of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
`String`	`getConnectionType()` The type of the network connection to the integration endpoint.
`String`	`getContentHandling()` Specifies how to handle request payload content type conversions.
`String`	`getCredentials()` Specifies the credentials required for the integration, if any.
`String`	`getHttpMethod()` Specifies the integration's HTTP method type.
`Map<String,IntegrationResponse>`	`getIntegrationResponses()` Specifies the integration's responses.
`String`	`getPassthroughBehavior()`
`Map<String,String>`	`getRequestParameters()` A key-value map specifying request parameters that are passed from the method request to the back end.
`Map<String,String>`	`getRequestTemplates()` Represents 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.
`Integer`	`getTimeoutInMillis()` Custom timeout between 50 and 29,000 milliseconds.
`TlsConfig`	`getTlsConfig()` Specifies the TLS configuration for an integration.
`String`	`getType()` Specifies an API method integration type.
`String`	`getUri()` Specifies Uniform Resource Identifier (URI) of the integration endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCacheKeyParameters(Collection<String> cacheKeyParameters)` A list of request parameters whose values API Gateway caches.
`void`	`setCacheNamespace(String cacheNamespace)` Specifies a group of related cached parameters.
`void`	`setConnectionId(String connectionId)` The (`id`) of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
`void`	`setConnectionType(ConnectionType connectionType)` The type of the network connection to the integration endpoint.
`void`	`setConnectionType(String connectionType)` The type of the network connection to the integration endpoint.
`void`	`setContentHandling(ContentHandlingStrategy contentHandling)` Specifies how to handle request payload content type conversions.
`void`	`setContentHandling(String contentHandling)` Specifies how to handle request payload content type conversions.
`void`	`setCredentials(String credentials)` Specifies the credentials required for the integration, if any.
`void`	`setHttpMethod(String httpMethod)` Specifies the integration's HTTP method type.
`void`	`setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)` Specifies the integration's responses.
`void`	`setPassthroughBehavior(String passthroughBehavior)`
`void`	`setRequestParameters(Map<String,String> requestParameters)` A key-value map specifying request parameters that are passed from the method request to the back end.
`void`	`setRequestTemplates(Map<String,String> requestTemplates)` Represents 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.
`void`	`setTimeoutInMillis(Integer timeoutInMillis)` Custom timeout between 50 and 29,000 milliseconds.
`void`	`setTlsConfig(TlsConfig tlsConfig)` Specifies the TLS configuration for an integration.
`void`	`setType(IntegrationType type)` Specifies an API method integration type.
`void`	`setType(String type)` Specifies an API method integration type.
`void`	`setUri(String uri)` Specifies Uniform Resource Identifier (URI) of the integration endpoint.
`String`	`toString()` Returns a string representation of this object.
`Integration`	`withCacheKeyParameters(Collection<String> cacheKeyParameters)` A list of request parameters whose values API Gateway caches.
`Integration`	`withCacheKeyParameters(String... cacheKeyParameters)` A list of request parameters whose values API Gateway caches.
`Integration`	`withCacheNamespace(String cacheNamespace)` Specifies a group of related cached parameters.
`Integration`	`withConnectionId(String connectionId)` The (`id`) of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
`Integration`	`withConnectionType(ConnectionType connectionType)` The type of the network connection to the integration endpoint.
`Integration`	`withConnectionType(String connectionType)` The type of the network connection to the integration endpoint.
`Integration`	`withContentHandling(ContentHandlingStrategy contentHandling)` Specifies how to handle request payload content type conversions.
`Integration`	`withContentHandling(String contentHandling)` Specifies how to handle request payload content type conversions.
`Integration`	`withCredentials(String credentials)` Specifies the credentials required for the integration, if any.
`Integration`	`withHttpMethod(String httpMethod)` Specifies the integration's HTTP method type.
`Integration`	`withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)` Specifies the integration's responses.
`Integration`	`withPassthroughBehavior(String passthroughBehavior)`
`Integration`	`withRequestParameters(Map<String,String> requestParameters)` A key-value map specifying request parameters that are passed from the method request to the back end.
`Integration`	`withRequestTemplates(Map<String,String> requestTemplates)` Represents 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.
`Integration`	`withTimeoutInMillis(Integer timeoutInMillis)` Custom timeout between 50 and 29,000 milliseconds.
`Integration`	`withTlsConfig(TlsConfig tlsConfig)` Specifies the TLS configuration for an integration.
`Integration`	`withType(IntegrationType type)` Specifies an API method integration type.
`Integration`	`withType(String type)` Specifies an API method integration type.
`Integration`	`withUri(String uri)` Specifies Uniform Resource Identifier (URI) of the integration endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Integration
```
public Integration()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    Specifies an API method integration type. The valid value is one of the following:
    - AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    - AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    - HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    - HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    - MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Parameters:
    type - Specifies an API method integration type. The valid value is one of the following:
    
    AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    
    HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    
    MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    See Also:
    
    IntegrationType
  - getType
```
public String getType()
```
    Specifies an API method integration type. The valid value is one of the following:
    - AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    - AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    - HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    - HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    - MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Returns:
    Specifies an API method integration type. The valid value is one of the following:
    
    AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    
    HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    
    MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    See Also:
    
    IntegrationType
  - withType
```
public Integration withType(String type)
```
    Specifies an API method integration type. The valid value is one of the following:
    - AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    - AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    - HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    - HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    - MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Parameters:
    type - Specifies an API method integration type. The valid value is one of the following:
    
    AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    
    HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    
    MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntegrationType
  - setType
```
public void setType(IntegrationType type)
```
    Specifies an API method integration type. The valid value is one of the following:
    - AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    - AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    - HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    - HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    - MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Parameters:
    type - Specifies an API method integration type. The valid value is one of the following:
    
    AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    
    HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    
    MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    See Also:
    
    IntegrationType
  - withType
```
public Integration withType(IntegrationType type)
```
    Specifies an API method integration type. The valid value is one of the following:
    - AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    - AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    - HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    - HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    - MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Parameters:
    type - Specifies an API method integration type. The valid value is one of the following:
    
    AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
    
    AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
    
    HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
    
    HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
    
    MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
    
    For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntegrationType
  - setHttpMethod
```
public void setHttpMethod(String httpMethod)
```
    Specifies the integration's HTTP method type.
    
    Parameters:
    
    httpMethod - Specifies the integration's HTTP method type.
  - getHttpMethod
```
public String getHttpMethod()
```
    Specifies the integration's HTTP method type.
    
    Returns:
    
    Specifies the integration's HTTP method type.
  - withHttpMethod
```
public Integration withHttpMethod(String httpMethod)
```
    Specifies the integration's HTTP method type.
    
    Parameters:
    
    httpMethod - Specifies the integration's HTTP method type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUri
```
public void setUri(String uri)
```
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    - For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    - For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    Parameters:
    uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    
    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    
    For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
  - getUri
```
public String getUri()
```
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    - For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    - For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    Returns:
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    
    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    
    For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
  - withUri
```
public Integration withUri(String uri)
```
    Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    - For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    - For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    Parameters:
    uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.
    
    For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
    
    For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionType
```
public void setConnectionType(String connectionType)
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Parameters:
    
    connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    See Also:
    
    ConnectionType
  - getConnectionType
```
public String getConnectionType()
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Returns:
    
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    See Also:
    
    ConnectionType
  - withConnectionType
```
public Integration withConnectionType(String connectionType)
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Parameters:
    
    connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionType
  - setConnectionType
```
public void setConnectionType(ConnectionType connectionType)
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Parameters:
    
    connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    See Also:
    
    ConnectionType
  - withConnectionType
```
public Integration withConnectionType(ConnectionType connectionType)
```
    The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Parameters:
    
    connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionType
  - setConnectionId
```
public void setConnectionId(String connectionId)
```
    The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    
    Parameters:
    
    connectionId - The (id ) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
  - getConnectionId
```
public String getConnectionId()
```
    The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    
    Returns:
    
    The (id ) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
  - withConnectionId
```
public Integration withConnectionId(String connectionId)
```
    The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    
    Parameters:
    
    connectionId - The (id ) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCredentials
```
public void setCredentials(String credentials)
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    
    Parameters:
    
    credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
  - getCredentials
```
public String getCredentials()
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    
    Returns:
    
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
  - withCredentials
```
public Integration withCredentials(String credentials)
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    
    Parameters:
    
    credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    
    Returns:
    
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
  - setRequestParameters
```
public void setRequestParameters(Map<String,String> requestParameters)
```
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    
    Parameters:
    
    requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring, path, or header and name must be a valid and unique method request parameter name.
  - withRequestParameters
```
public Integration withRequestParameters(Map<String,String> requestParameters)
```
    A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    
    Parameters:
    
    requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRequestParametersEntry
```
public Integration addRequestParametersEntry(String key,
                                             String value)
```
    Add a single RequestParameters entry
    
    See Also:
    
    withRequestParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearRequestParametersEntries
```
public Integration clearRequestParametersEntries()
```
    Removes all the entries added into RequestParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestTemplates
```
public Map<String,String> getRequestTemplates()
```
    Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
    
    Returns:
    
    Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
  - setRequestTemplates
```
public void setRequestTemplates(Map<String,String> requestTemplates)
```
    Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
    
    Parameters:
    
    requestTemplates - Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
  - withRequestTemplates
```
public Integration withRequestTemplates(Map<String,String> requestTemplates)
```
    Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
    
    Parameters:
    
    requestTemplates - Represents 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. The content type value is the key in this map, and the template (as a String) is the value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRequestTemplatesEntry
```
public Integration addRequestTemplatesEntry(String key,
                                            String value)
```
    Add a single RequestTemplates entry
    
    See Also:
    
    withRequestTemplates(java.util.Map<java.lang.String, java.lang.String>)
  - clearRequestTemplatesEntries
```
public Integration clearRequestTemplatesEntries()
```
    Removes all the entries added into RequestTemplates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassthroughBehavior
```
public void setPassthroughBehavior(String passthroughBehavior)
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Parameters:
    passthroughBehavior -
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  - getPassthroughBehavior
```
public String getPassthroughBehavior()
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Returns:
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  - withPassthroughBehavior
```
public Integration withPassthroughBehavior(String passthroughBehavior)
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Parameters:
    passthroughBehavior -
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
    
    WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentHandling
```
public void setContentHandling(String contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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 passthroughBehavior is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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 passthroughBehavior is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - getContentHandling
```
public String getContentHandling()
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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 passthroughBehavior is configured to support payload pass-through.
    Returns:
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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 passthroughBehavior is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - withContentHandling
```
public Integration withContentHandling(String contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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 passthroughBehavior is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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 passthroughBehavior is configured to support payload pass-through.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentHandlingStrategy
  - setContentHandling
```
public void setContentHandling(ContentHandlingStrategy contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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 passthroughBehavior is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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 passthroughBehavior is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - withContentHandling
```
public Integration withContentHandling(ContentHandlingStrategy contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    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 passthroughBehavior is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    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 passthroughBehavior is configured to support payload pass-through.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentHandlingStrategy
  - setTimeoutInMillis
```
public void setTimeoutInMillis(Integer timeoutInMillis)
```
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    
    Parameters:
    
    timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
  - getTimeoutInMillis
```
public Integer getTimeoutInMillis()
```
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    
    Returns:
    
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
  - withTimeoutInMillis
```
public Integration withTimeoutInMillis(Integer timeoutInMillis)
```
    Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    
    Parameters:
    
    timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCacheNamespace
```
public void setCacheNamespace(String cacheNamespace)
```
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    
    Parameters:
    
    cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
  - getCacheNamespace
```
public String getCacheNamespace()
```
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    
    Returns:
    
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
  - withCacheNamespace
```
public Integration withCacheNamespace(String cacheNamespace)
```
    Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    
    Parameters:
    
    cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCacheKeyParameters
```
public List<String> getCacheKeyParameters()
```
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    Returns:
    
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
  - setCacheKeyParameters
```
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
```
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    Parameters:
    
    cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
  - withCacheKeyParameters
```
public Integration withCacheKeyParameters(String... cacheKeyParameters)
```
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    NOTE: This method appends the values to the existing list (if any). Use setCacheKeyParameters(java.util.Collection) or withCacheKeyParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCacheKeyParameters
```
public Integration withCacheKeyParameters(Collection<String> cacheKeyParameters)
```
    A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    Parameters:
    
    cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIntegrationResponses
```
public Map<String,IntegrationResponse> getIntegrationResponses()
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Returns:
    Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
  - setIntegrationResponses
```
public void setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Parameters:
    integrationResponses - Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
  - withIntegrationResponses
```
public Integration withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Parameters:
    integrationResponses - Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addIntegrationResponsesEntry
```
public Integration addIntegrationResponsesEntry(String key,
                                                IntegrationResponse value)
```
    Add a single IntegrationResponses entry
    
    See Also:
    
    withIntegrationResponses(java.util.Map<java.lang.String, com.amazonaws.services.apigateway.model.IntegrationResponse>)
  - clearIntegrationResponsesEntries
```
public Integration clearIntegrationResponsesEntries()
```
    Removes all the entries added into IntegrationResponses.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTlsConfig
```
public void setTlsConfig(TlsConfig tlsConfig)
```
    Specifies the TLS configuration for an integration.
    
    Parameters:
    
    tlsConfig - Specifies the TLS configuration for an integration.
  - getTlsConfig
```
public TlsConfig getTlsConfig()
```
    Specifies the TLS configuration for an integration.
    
    Returns:
    
    Specifies the TLS configuration for an integration.
  - withTlsConfig
```
public Integration withTlsConfig(TlsConfig tlsConfig)
```
    Specifies the TLS configuration for an integration.
    
    Parameters:
    
    tlsConfig - Specifies the TLS configuration for an integration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Integration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Integration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Integration

Method Detail

setType

getType

withType

setType

withType

setHttpMethod

getHttpMethod

withHttpMethod

setUri

getUri

withUri

setConnectionType

getConnectionType

withConnectionType

setConnectionType

withConnectionType

setConnectionId

getConnectionId

withConnectionId

setCredentials

getCredentials

withCredentials

getRequestParameters

setRequestParameters

withRequestParameters

addRequestParametersEntry

clearRequestParametersEntries

getRequestTemplates

setRequestTemplates

withRequestTemplates

addRequestTemplatesEntry

clearRequestTemplatesEntries

setPassthroughBehavior

getPassthroughBehavior

withPassthroughBehavior

setContentHandling

getContentHandling

withContentHandling

setContentHandling

withContentHandling

setTimeoutInMillis

getTimeoutInMillis

withTimeoutInMillis

setCacheNamespace

getCacheNamespace

withCacheNamespace

getCacheKeyParameters

setCacheKeyParameters

withCacheKeyParameters

withCacheKeyParameters

getIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

setIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

withIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

addIntegrationResponsesEntry