public static interface PutIntegrationRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>
| Modifier and Type | Method and Description |
|---|---|
PutIntegrationRequest.Builder |
cacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest.Builder |
cacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest.Builder |
cacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
|
PutIntegrationRequest.Builder |
connectionId(String connectionId)
|
PutIntegrationRequest.Builder |
connectionType(ConnectionType connectionType)
The type of the network connection to the integration endpoint.
|
PutIntegrationRequest.Builder |
connectionType(String connectionType)
The type of the network connection to the integration endpoint.
|
PutIntegrationRequest.Builder |
contentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions.
|
PutIntegrationRequest.Builder |
contentHandling(String contentHandling)
Specifies how to handle request payload content type conversions.
|
PutIntegrationRequest.Builder |
credentials(String credentials)
Specifies whether credentials are required for a put integration.
|
PutIntegrationRequest.Builder |
httpMethod(String httpMethod)
[Required] Specifies a put integration request's HTTP method.
|
PutIntegrationRequest.Builder |
integrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method.
|
PutIntegrationRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutIntegrationRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutIntegrationRequest.Builder |
passthroughBehavior(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. |
PutIntegrationRequest.Builder |
requestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end.
|
PutIntegrationRequest.Builder |
requestTemplates(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.
|
PutIntegrationRequest.Builder |
resourceId(String resourceId)
[Required] Specifies a put integration request's resource ID.
|
PutIntegrationRequest.Builder |
restApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
|
PutIntegrationRequest.Builder |
timeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds.
|
PutIntegrationRequest.Builder |
type(IntegrationType type)
[Required] Specifies a put integration input's type.
|
PutIntegrationRequest.Builder |
type(String type)
[Required] Specifies a put integration input's type.
|
PutIntegrationRequest.Builder |
uri(String uri)
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
buildoverrideConfigurationcopyapplyMutation, buildPutIntegrationRequest.Builder restApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
restApiId - [Required] The string identifier of the associated RestApi.PutIntegrationRequest.Builder resourceId(String resourceId)
[Required] Specifies a put integration request's resource ID.
resourceId - [Required] Specifies a put integration request's resource ID.PutIntegrationRequest.Builder httpMethod(String httpMethod)
[Required] Specifies a put integration request's HTTP method.
httpMethod - [Required] Specifies a put integration request's HTTP method.PutIntegrationRequest.Builder type(String type)
[Required] Specifies a put integration input's type.
type - [Required] Specifies a put integration input's type.IntegrationType,
IntegrationTypePutIntegrationRequest.Builder type(IntegrationType type)
[Required] Specifies a put integration input's type.
type - [Required] Specifies a put integration input's type.IntegrationType,
IntegrationTypePutIntegrationRequest.Builder integrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
integrationHttpMethod - Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is
required.PutIntegrationRequest.Builder uri(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}
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}
PutIntegrationRequest.Builder connectionType(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.
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.ConnectionType,
ConnectionTypePutIntegrationRequest.Builder connectionType(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.
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.ConnectionType,
ConnectionTypePutIntegrationRequest.Builder connectionId(String connectionId)
PutIntegrationRequest.Builder credentials(String credentials)
Specifies whether credentials are required for a put integration.
credentials - Specifies whether credentials are required for a put integration.PutIntegrationRequest.Builder requestParameters(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.
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.PutIntegrationRequest.Builder requestTemplates(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.
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.PutIntegrationRequest.Builder passthroughBehavior(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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back
end 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 415 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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the
integration back end 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 415 response.
PutIntegrationRequest.Builder cacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace - Specifies a put integration input's cache namespace.PutIntegrationRequest.Builder cacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters - Specifies a put integration input's cache key parameters.PutIntegrationRequest.Builder cacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters - Specifies a put integration input's cache key parameters.PutIntegrationRequest.Builder contentHandling(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 passthroughBehaviors is configured
to support payload pass-through.
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 passthroughBehaviors is
configured to support payload pass-through.
ContentHandlingStrategy,
ContentHandlingStrategyPutIntegrationRequest.Builder contentHandling(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 passthroughBehaviors is configured
to support payload pass-through.
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 passthroughBehaviors is
configured to support payload pass-through.
ContentHandlingStrategy,
ContentHandlingStrategyPutIntegrationRequest.Builder timeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29
seconds.PutIntegrationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.PutIntegrationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.