Class IntegrationOptions.Jsii$Proxy
- All Implemented Interfaces:
IntegrationOptions
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
IntegrationOptions
IntegrationOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IntegrationOptions
IntegrationOptions.Builder, IntegrationOptions.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(IntegrationOptions.Builder builder) Constructor that initializes the object based on literal property values passed by theIntegrationOptions.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
A list of request parameters whose values are to be cached.final String
An API-specific tag group of related cached parameters.final ConnectionType
The type of network connection to the integration endpoint.final ContentHandling
Specifies how to handle request payload content type conversions.final Boolean
Requires that the caller's identity be passed through from the request.final IRole
An IAM role that API Gateway assumes.final List<IntegrationResponse>
The response that API Gateway provides after a method's backend completes processing a request.final 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.The request parameters that API Gateway sends with the backend request.A map of Apache Velocity templates that are applied on the request payload.final Duration
The maximum amount of time an integration will run before it returns without a response.final IVpcLink
The VpcLink used for the integration.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theIntegrationOptions.Builder
.
-
-
Method Details
-
getCacheKeyParameters
Description copied from interface:IntegrationOptions
A list of request parameters whose values are to be cached.It determines request parameters that will make it into the cache key.
- Specified by:
getCacheKeyParameters
in interfaceIntegrationOptions
-
getCacheNamespace
Description copied from interface:IntegrationOptions
An API-specific tag group of related cached parameters.- Specified by:
getCacheNamespace
in interfaceIntegrationOptions
-
getConnectionType
Description copied from interface:IntegrationOptions
The type of network connection to the integration endpoint.Default: - ConnectionType.VPC_LINK if `vpcLink` property is configured; ConnectionType.Internet otherwise.
- Specified by:
getConnectionType
in interfaceIntegrationOptions
-
getContentHandling
Description copied from interface:IntegrationOptions
Specifies how to handle request payload content type conversions.Default: none if this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `passthroughBehaviors` property is configured to support payload pass-through.
- Specified by:
getContentHandling
in interfaceIntegrationOptions
-
getCredentialsPassthrough
Description copied from interface:IntegrationOptions
Requires that the caller's identity be passed through from the request.Default: Caller identity is not passed through
- Specified by:
getCredentialsPassthrough
in interfaceIntegrationOptions
-
getCredentialsRole
Description copied from interface:IntegrationOptions
An IAM role that API Gateway assumes.Mutually exclusive with
credentialsPassThrough
.Default: A role is not assumed
- Specified by:
getCredentialsRole
in interfaceIntegrationOptions
-
getIntegrationResponses
Description copied from interface:IntegrationOptions
The response that API Gateway provides after a method's backend completes processing a request.API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.
- Specified by:
getIntegrationResponses
in interfaceIntegrationOptions
-
getPassthroughBehavior
Description copied from interface:IntegrationOptions
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.
- Specified by:
getPassthroughBehavior
in interfaceIntegrationOptions
-
getRequestParameters
Description copied from interface:IntegrationOptions
The request parameters that API Gateway sends with the backend request.Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.
Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.
The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.
- Specified by:
getRequestParameters
in interfaceIntegrationOptions
-
getRequestTemplates
Description copied from interface:IntegrationOptions
A map of Apache Velocity templates that are applied on the request payload.The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:
{ "application/json": "{ \"statusCode\": 200 }" }
- Specified by:
getRequestTemplates
in interfaceIntegrationOptions
- See Also:
-
getTimeout
Description copied from interface:IntegrationOptions
The maximum amount of time an integration will run before it returns without a response.Must be between 50 milliseconds and 29 seconds.
Default: Duration.seconds(29)
- Specified by:
getTimeout
in interfaceIntegrationOptions
-
getVpcLink
Description copied from interface:IntegrationOptions
The VpcLink used for the integration.Required if connectionType is VPC_LINK
- Specified by:
getVpcLink
in interfaceIntegrationOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-