Package software.aws.awsprototypingsdk.openapigateway

Interface ApiGatewayIntegration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayIntegration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:24.726Z")
@Stability(Experimental)
public interface ApiGatewayIntegration
extends software.amazon.jsii.JsiiSerializable

(experimental) Represents an api gateway integration.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApiGatewayIntegration.Builder	A builder for ApiGatewayIntegration
static class	ApiGatewayIntegration.Jsii$Proxy	An implementation for ApiGatewayIntegration

Method Summary

Modifier and Type	Method	Description
static ApiGatewayIntegration.Builder	builder()
default List<String>	getCacheKeyParameters()	(experimental) A list of request parameters whose values are to be cached.
default String	getCacheNamespace()	(experimental) An API-specific tag group of related cached parameters.
default String	getConnectionId()	(experimental) The ID of a VpcLink for the private integration.
default String	getConnectionType()	(experimental) The integration connection type.
default String	getContentHandling()	(experimental) Request payload encoding conversion types.
default String	getCredentials()	(experimental) For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role.
default String	getHttpMethod()	(experimental) The HTTP method used in the integration request.
default String	getPassthroughBehavior()	(experimental) Specifies how a request payload of unmapped content type is passed through the integration request without modification.
default Map<String,String>	getRequestParameters()	(experimental) Specifies mappings from method request parameters to integration request parameters.
default Map<String,String>	getRequestTemplates()	(experimental) Mapping templates for a request payload of specified MIME types.
default Map<String,ApiGatewayIntegrationResponse>	getResponses()	(experimental) Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.
default Number	getTimeoutInMillis()	(experimental) Custom timeout between 50 and 29,000 milliseconds.
default ApiGatewayIntegrationTlsConfig	getTlsConfig()	(experimental) Specifies the TLS configuration for an integration.
default String	getType()	(experimental) The type of integration with the specified backend.
default String	getUri()	(experimental) The endpoint URI of the backend.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCacheKeyParameters

@Stability(Experimental)
@Nullable
default List<String> getCacheKeyParameters()

(experimental) A list of request parameters whose values are to be cached.

getCacheNamespace

@Stability(Experimental)
@Nullable
default String getCacheNamespace()

(experimental) An API-specific tag group of related cached parameters.

getConnectionId

@Stability(Experimental)
@Nullable
default String getConnectionId()

(experimental) The ID of a VpcLink for the private integration.

See Also:

https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html

getConnectionType

@Stability(Experimental)
@Nullable
default String getConnectionType()

(experimental) The integration connection type.

The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise.

getContentHandling

@Stability(Experimental)
@Nullable
default String getContentHandling()

(experimental) Request payload encoding conversion types.

Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification.

getCredentials

@Stability(Experimental)
@Nullable
default String getCredentials()

(experimental) For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role.

If unspecified, credentials default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy.

Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this API is deployed for best performance.

getHttpMethod

@Stability(Experimental)
@Nullable
default String getHttpMethod()

(experimental) The HTTP method used in the integration request.

For Lambda function invocations, the value must be POST.

getPassthroughBehavior

@Stability(Experimental)
@Nullable
default String getPassthroughBehavior()

(experimental) Specifies how a request payload of unmapped content type is passed through the integration request without modification.

Supported values are when_no_templates, when_no_match, and never.

See Also:

https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior

getRequestParameters

@Stability(Experimental)
@Nullable
default Map<String,String> getRequestParameters()

(experimental) Specifies mappings from method request parameters to integration request parameters.

Supported request parameters are querystring, path, header, and body.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html

getRequestTemplates

@Stability(Experimental)
@Nullable
default Map<String,String> getRequestTemplates()

(experimental) Mapping templates for a request payload of specified MIME types.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html

getResponses

@Stability(Experimental)
@Nullable
default Map<String,ApiGatewayIntegrationResponse> getResponses()

(experimental) Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html

getTimeoutInMillis

@Stability(Experimental)
@Nullable
default Number getTimeoutInMillis()

(experimental) Custom timeout between 50 and 29,000 milliseconds.

The default value is 29,000 milliseconds or 29 seconds.

getTlsConfig

@Stability(Experimental)
@Nullable
default ApiGatewayIntegrationTlsConfig getTlsConfig()

(experimental) Specifies the TLS configuration for an integration.

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html

getType

@Stability(Experimental)
@Nullable
default String getType()

(experimental) The type of integration with the specified backend.

See Also:

https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type

getUri

@Stability(Experimental)
@Nullable
default String getUri()

(experimental) The endpoint URI of the backend.

For integrations of the aws type, this is an ARN value. For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme.

builder

@Stability(Experimental)
static ApiGatewayIntegration.Builder builder()

Returns:

a ApiGatewayIntegration.Builder of ApiGatewayIntegration