@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetIntegrationResult() |
Modifier and Type | Method and Description |
---|---|
GetIntegrationResult |
addRequestParametersEntry(String key,
String value)
Add a single RequestParameters entry
|
GetIntegrationResult |
addRequestTemplatesEntry(String key,
String value)
Add a single RequestTemplates entry
|
GetIntegrationResult |
addResponseParametersEntry(String key,
Map<String,String> value)
Add a single ResponseParameters entry
|
GetIntegrationResult |
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.
|
GetIntegrationResult |
clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates.
|
GetIntegrationResult |
clearResponseParametersEntries()
Removes all the entries added into ResponseParameters.
|
GetIntegrationResult |
clone() |
boolean |
equals(Object obj) |
Boolean |
getApiGatewayManaged()
Specifies whether an integration is managed by API Gateway.
|
String |
getConnectionId()
The ID of the VPC link for a private integration.
|
String |
getConnectionType()
The type of the network connection to the integration endpoint.
|
String |
getContentHandlingStrategy()
Supported only for WebSocket APIs.
|
String |
getCredentialsArn()
Specifies the credentials required for the integration, if any.
|
String |
getDescription()
Represents the description of an integration.
|
String |
getIntegrationId()
Represents the identifier of an integration.
|
String |
getIntegrationMethod()
Specifies the integration's HTTP method type.
|
String |
getIntegrationResponseSelectionExpression()
The integration response selection expression for the integration.
|
String |
getIntegrationSubtype()
Supported only for HTTP API AWS_PROXY integrations.
|
String |
getIntegrationType()
The integration type of an integration.
|
String |
getIntegrationUri()
For a Lambda integration, specify the URI of a Lambda function.
|
String |
getPassthroughBehavior()
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates property on the Integration resource.
|
String |
getPayloadFormatVersion()
Specifies the format of the payload sent to an integration.
|
Map<String,String> |
getRequestParameters()
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend.
|
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.
|
Map<String,Map<String,String>> |
getResponseParameters()
Supported only for HTTP APIs.
|
String |
getTemplateSelectionExpression()
The template selection expression for the integration.
|
Integer |
getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
HTTP APIs.
|
TlsConfig |
getTlsConfig()
The TLS configuration for a private integration.
|
int |
hashCode() |
Boolean |
isApiGatewayManaged()
Specifies whether an integration is managed by API Gateway.
|
void |
setApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an integration is managed by API Gateway.
|
void |
setConnectionId(String connectionId)
The ID of the VPC link for a private integration.
|
void |
setConnectionType(String connectionType)
The type of the network connection to the integration endpoint.
|
void |
setContentHandlingStrategy(String contentHandlingStrategy)
Supported only for WebSocket APIs.
|
void |
setCredentialsArn(String credentialsArn)
Specifies the credentials required for the integration, if any.
|
void |
setDescription(String description)
Represents the description of an integration.
|
void |
setIntegrationId(String integrationId)
Represents the identifier of an integration.
|
void |
setIntegrationMethod(String integrationMethod)
Specifies the integration's HTTP method type.
|
void |
setIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression)
The integration response selection expression for the integration.
|
void |
setIntegrationSubtype(String integrationSubtype)
Supported only for HTTP API AWS_PROXY integrations.
|
void |
setIntegrationType(String integrationType)
The integration type of an integration.
|
void |
setIntegrationUri(String integrationUri)
For a Lambda integration, specify the URI of a Lambda function.
|
void |
setPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates property on the Integration resource.
|
void |
setPayloadFormatVersion(String payloadFormatVersion)
Specifies the format of the payload sent to an integration.
|
void |
setRequestParameters(Map<String,String> requestParameters)
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend.
|
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 |
setResponseParameters(Map<String,Map<String,String>> responseParameters)
Supported only for HTTP APIs.
|
void |
setTemplateSelectionExpression(String templateSelectionExpression)
The template selection expression for the integration.
|
void |
setTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
HTTP APIs.
|
void |
setTlsConfig(TlsConfig tlsConfig)
The TLS configuration for a private integration.
|
String |
toString()
Returns a string representation of this object.
|
GetIntegrationResult |
withApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an integration is managed by API Gateway.
|
GetIntegrationResult |
withConnectionId(String connectionId)
The ID of the VPC link for a private integration.
|
GetIntegrationResult |
withConnectionType(ConnectionType connectionType)
The type of the network connection to the integration endpoint.
|
GetIntegrationResult |
withConnectionType(String connectionType)
The type of the network connection to the integration endpoint.
|
GetIntegrationResult |
withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy)
Supported only for WebSocket APIs.
|
GetIntegrationResult |
withContentHandlingStrategy(String contentHandlingStrategy)
Supported only for WebSocket APIs.
|
GetIntegrationResult |
withCredentialsArn(String credentialsArn)
Specifies the credentials required for the integration, if any.
|
GetIntegrationResult |
withDescription(String description)
Represents the description of an integration.
|
GetIntegrationResult |
withIntegrationId(String integrationId)
Represents the identifier of an integration.
|
GetIntegrationResult |
withIntegrationMethod(String integrationMethod)
Specifies the integration's HTTP method type.
|
GetIntegrationResult |
withIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression)
The integration response selection expression for the integration.
|
GetIntegrationResult |
withIntegrationSubtype(String integrationSubtype)
Supported only for HTTP API AWS_PROXY integrations.
|
GetIntegrationResult |
withIntegrationType(IntegrationType integrationType)
The integration type of an integration.
|
GetIntegrationResult |
withIntegrationType(String integrationType)
The integration type of an integration.
|
GetIntegrationResult |
withIntegrationUri(String integrationUri)
For a Lambda integration, specify the URI of a Lambda function.
|
GetIntegrationResult |
withPassthroughBehavior(PassthroughBehavior passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates property on the Integration resource.
|
GetIntegrationResult |
withPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates property on the Integration resource.
|
GetIntegrationResult |
withPayloadFormatVersion(String payloadFormatVersion)
Specifies the format of the payload sent to an integration.
|
GetIntegrationResult |
withRequestParameters(Map<String,String> requestParameters)
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend.
|
GetIntegrationResult |
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.
|
GetIntegrationResult |
withResponseParameters(Map<String,Map<String,String>> responseParameters)
Supported only for HTTP APIs.
|
GetIntegrationResult |
withTemplateSelectionExpression(String templateSelectionExpression)
The template selection expression for the integration.
|
GetIntegrationResult |
withTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
HTTP APIs.
|
GetIntegrationResult |
withTlsConfig(TlsConfig tlsConfig)
The TLS configuration for a private integration.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you created an API using using quick
create, the resulting integration is managed by API Gateway. You can update a managed integration, but you
can't delete it.public Boolean getApiGatewayManaged()
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
public GetIntegrationResult withApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you created an API using using quick
create, the resulting integration is managed by API Gateway. You can update a managed integration, but you
can't delete it.public Boolean isApiGatewayManaged()
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
public void setConnectionId(String connectionId)
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
connectionId
- The ID of the VPC link for a private integration. Supported only for HTTP APIs.public String getConnectionId()
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
public GetIntegrationResult withConnectionId(String connectionId)
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
connectionId
- The ID of the VPC link for a private integration. Supported only for HTTP APIs.public void setConnectionType(String connectionType)
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
connectionType
- The type of the network connection to the integration endpoint. Specify INTERNET for connections through
the public routable internet or VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.ConnectionType
public String getConnectionType()
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
ConnectionType
public GetIntegrationResult withConnectionType(String connectionType)
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
connectionType
- The type of the network connection to the integration endpoint. Specify INTERNET for connections through
the public routable internet or VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.ConnectionType
public GetIntegrationResult withConnectionType(ConnectionType connectionType)
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
connectionType
- The type of the network connection to the integration endpoint. Specify INTERNET for connections through
the public routable internet or VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.ConnectionType
public void setContentHandlingStrategy(String contentHandlingStrategy)
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
ContentHandlingStrategy
public String getContentHandlingStrategy()
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
ContentHandlingStrategy
public GetIntegrationResult withContentHandlingStrategy(String contentHandlingStrategy)
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
ContentHandlingStrategy
public GetIntegrationResult withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy)
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
ContentHandlingStrategy
public void setCredentialsArn(String credentialsArn)
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.
credentialsArn
- 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.public String getCredentialsArn()
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.
public GetIntegrationResult withCredentialsArn(String credentialsArn)
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.
credentialsArn
- 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.public void setDescription(String description)
Represents the description of an integration.
description
- Represents the description of an integration.public String getDescription()
Represents the description of an integration.
public GetIntegrationResult withDescription(String description)
Represents the description of an integration.
description
- Represents the description of an integration.public void setIntegrationId(String integrationId)
Represents the identifier of an integration.
integrationId
- Represents the identifier of an integration.public String getIntegrationId()
Represents the identifier of an integration.
public GetIntegrationResult withIntegrationId(String integrationId)
Represents the identifier of an integration.
integrationId
- Represents the identifier of an integration.public void setIntegrationMethod(String integrationMethod)
Specifies the integration's HTTP method type.
integrationMethod
- Specifies the integration's HTTP method type.public String getIntegrationMethod()
Specifies the integration's HTTP method type.
public GetIntegrationResult withIntegrationMethod(String integrationMethod)
Specifies the integration's HTTP method type.
integrationMethod
- Specifies the integration's HTTP method type.public void setIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression)
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integrationResponseSelectionExpression
- The integration response selection expression for the integration. Supported only for WebSocket APIs. See
Integration Response Selection Expressions.public String getIntegrationResponseSelectionExpression()
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
public GetIntegrationResult withIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression)
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integrationResponseSelectionExpression
- The integration response selection expression for the integration. Supported only for WebSocket APIs. See
Integration Response Selection Expressions.public void setIntegrationSubtype(String integrationSubtype)
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn
more, see Integration subtype reference.public String getIntegrationSubtype()
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
public GetIntegrationResult withIntegrationSubtype(String integrationSubtype)
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn
more, see Integration subtype reference.public void setIntegrationType(String integrationType)
The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationType
public String getIntegrationType()
The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationType
public GetIntegrationResult withIntegrationType(String integrationType)
The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationType
public GetIntegrationResult withIntegrationType(IntegrationType integrationType)
The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or 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. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationType
public void setIntegrationUri(String integrationUri)
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
public String getIntegrationUri()
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
public GetIntegrationResult withIntegrationUri(String integrationUri)
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
public void setPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request,
and the available mapping templates specified as the requestTemplates property on the Integration
resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for
WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
PassthroughBehavior
public String getPassthroughBehavior()
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
PassthroughBehavior
public GetIntegrationResult withPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request,
and the available mapping templates specified as the requestTemplates property on the Integration
resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for
WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
PassthroughBehavior
public GetIntegrationResult withPassthroughBehavior(PassthroughBehavior passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request,
and the available mapping templates specified as the requestTemplates property on the Integration
resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for
WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
PassthroughBehavior
public void setPayloadFormatVersion(String payloadFormatVersion)
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for HTTP APIs.public String getPayloadFormatVersion()
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
public GetIntegrationResult withPayloadFormatVersion(String payloadFormatVersion)
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for HTTP APIs.public Map<String,String> getRequestParameters()
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend. 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 backend. The
method request parameter value must match the pattern of
method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
public void setRequestParameters(Map<String,String> requestParameters)
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend. 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 backend. The
method request parameter value must match the pattern of
method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request
to the backend. 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 backend. The method request parameter value must match the pattern of
method.request.For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
public GetIntegrationResult withRequestParameters(Map<String,String> requestParameters)
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend. 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 backend. The
method request parameter value must match the pattern of
method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request
to the backend. 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 backend. The method request parameter value must match the pattern of
method.request.For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
public GetIntegrationResult addRequestParametersEntry(String key, String value)
public GetIntegrationResult clearRequestParametersEntries()
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. Supported only for WebSocket APIs.
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. Supported only for WebSocket APIs.
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. Supported only for WebSocket APIs.public GetIntegrationResult 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. Supported only for WebSocket APIs.
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. Supported only for WebSocket APIs.public GetIntegrationResult addRequestTemplatesEntry(String key, String value)
public GetIntegrationResult clearRequestTemplatesEntries()
public Map<String,Map<String,String>> getResponseParameters()
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
public void setResponseParameters(Map<String,Map<String,String>> responseParameters)
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
responseParameters
- Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
integration before returning the response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code within the range of 200-599.
Response parameters are a key-value map. The key must match pattern
<action>:<header>.<location> or overwrite.statuscode. The action can be append,
overwrite or remove. The value can be a static value, or map to response data, stage variables, or context
variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.public GetIntegrationResult withResponseParameters(Map<String,Map<String,String>> responseParameters)
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
responseParameters
- Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
integration before returning the response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code within the range of 200-599.
Response parameters are a key-value map. The key must match pattern
<action>:<header>.<location> or overwrite.statuscode. The action can be append,
overwrite or remove. The value can be a static value, or map to response data, stage variables, or context
variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.public GetIntegrationResult addResponseParametersEntry(String key, Map<String,String> value)
public GetIntegrationResult clearResponseParametersEntries()
public void setTemplateSelectionExpression(String templateSelectionExpression)
The template selection expression for the integration. Supported only for WebSocket APIs.
templateSelectionExpression
- The template selection expression for the integration. Supported only for WebSocket APIs.public String getTemplateSelectionExpression()
The template selection expression for the integration. Supported only for WebSocket APIs.
public GetIntegrationResult withTemplateSelectionExpression(String templateSelectionExpression)
The template selection expression for the integration. Supported only for WebSocket APIs.
templateSelectionExpression
- The template selection expression for the integration. Supported only for WebSocket APIs.public void setTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000
milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP
APIs.public Integer getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
public GetIntegrationResult withTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000
milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP
APIs.public void setTlsConfig(TlsConfig tlsConfig)
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
tlsConfig
- The TLS configuration for a private integration. If you specify a TLS configuration, private integration
traffic uses the HTTPS protocol. Supported only for HTTP APIs.public TlsConfig getTlsConfig()
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
public GetIntegrationResult withTlsConfig(TlsConfig tlsConfig)
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
tlsConfig
- The TLS configuration for a private integration. If you specify a TLS configuration, private integration
traffic uses the HTTPS protocol. Supported only for HTTP APIs.public String toString()
toString
in class Object
Object.toString()
public GetIntegrationResult clone()