@Generated(value="software.amazon.awssdk:codegen") public final class UpdateIntegrationRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateIntegrationRequest.Builder,UpdateIntegrationRequest>
Updates an Integration.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateIntegrationRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
apiId()
The API identifier.
|
static UpdateIntegrationRequest.Builder |
builder() |
String |
connectionId()
The ID of the VPC link for a private integration.
|
ConnectionType |
connectionType()
The type of the network connection to the integration endpoint.
|
String |
connectionTypeAsString()
The type of the network connection to the integration endpoint.
|
ContentHandlingStrategy |
contentHandlingStrategy()
Supported only for WebSocket APIs.
|
String |
contentHandlingStrategyAsString()
Supported only for WebSocket APIs.
|
String |
credentialsArn()
Specifies the credentials required for the integration, if any.
|
String |
description()
The description of the integration
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasRequestParameters()
Returns true if the RequestParameters property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasRequestTemplates()
Returns true if the RequestTemplates property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
String |
integrationId()
The integration ID.
|
String |
integrationMethod()
Specifies the integration's HTTP method type.
|
String |
integrationSubtype()
Supported only for HTTP API AWS_PROXY integrations.
|
IntegrationType |
integrationType()
The integration type of an integration.
|
String |
integrationTypeAsString()
The integration type of an integration.
|
String |
integrationUri()
For a Lambda integration, specify the URI of a Lambda function.
|
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.
|
String |
passthroughBehaviorAsString()
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 |
payloadFormatVersion()
Specifies the format of the payload sent to an integration.
|
Map<String,String> |
requestParameters()
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the
backend.
|
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateIntegrationRequest.Builder> |
serializableBuilderClass() |
String |
templateSelectionExpression()
The template selection expression for the integration.
|
Integer |
timeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
HTTP APIs.
|
TlsConfigInput |
tlsConfig()
The TLS configuration for a private integration.
|
UpdateIntegrationRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic String apiId()
The API identifier.
public String connectionId()
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
public 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.
If the service returns an enum value that is not available in the current SDK version, connectionType
will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from connectionTypeAsString().
ConnectionTypepublic String connectionTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, connectionType
will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from connectionTypeAsString().
ConnectionTypepublic 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.
If the service returns an enum value that is not available in the current SDK version,
contentHandlingStrategy will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from contentHandlingStrategyAsString().
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.
ContentHandlingStrategypublic String contentHandlingStrategyAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
contentHandlingStrategy will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from contentHandlingStrategyAsString().
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.
ContentHandlingStrategypublic 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.
public String description()
The description of the integration
public String integrationId()
The integration ID.
public String integrationMethod()
Specifies the integration's HTTP method type.
public String integrationSubtype()
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
public 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. For HTTP API private integrations, use an 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.
If the service returns an enum value that is not available in the current SDK version, integrationType
will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from integrationTypeAsString().
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. For HTTP API private integrations, use an 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.
IntegrationTypepublic String integrationTypeAsString()
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. For HTTP API private integrations, use an 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.
If the service returns an enum value that is not available in the current SDK version, integrationType
will return IntegrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from integrationTypeAsString().
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. For HTTP API private integrations, use an 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.
IntegrationTypepublic 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.
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 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.
If the service returns an enum value that is not available in the current SDK version,
passthroughBehavior will return PassthroughBehavior.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from passthroughBehaviorAsString().
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.
PassthroughBehaviorpublic String passthroughBehaviorAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
passthroughBehavior will return PassthroughBehavior.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from passthroughBehaviorAsString().
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.
PassthroughBehaviorpublic String payloadFormatVersion()
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
public boolean hasRequestParameters()
public 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 APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRequestParameters() to see if a value was sent in this field.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. 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.
public boolean hasRequestTemplates()
public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRequestTemplates() to see if a value was sent in this field.
public String templateSelectionExpression()
The template selection expression for the integration.
public 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.
public TlsConfigInput 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 UpdateIntegrationRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateIntegrationRequest.Builder,UpdateIntegrationRequest>toBuilder in class ApiGatewayV2Requestpublic static UpdateIntegrationRequest.Builder builder()
public static Class<? extends UpdateIntegrationRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode in class AwsRequestpublic boolean equals(Object obj)
equals in class AwsRequestpublic boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2020. All rights reserved.