@Stability(value=Stable) @Internal public static final class CfnMethod.IntegrationProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnMethod.IntegrationProperty
CfnMethod.IntegrationPropertysoftware.amazon.jsii.JsiiObject.InitializationModeCfnMethod.IntegrationProperty.Builder, CfnMethod.IntegrationProperty.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnMethod.IntegrationProperty.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnMethod.IntegrationProperty.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
List<String> |
getCacheKeyParameters()
A list of request parameters whose values API Gateway caches.
|
String |
getCacheNamespace()
An API-specific tag group of related cached parameters.
|
String |
getConnectionId()
The ID of the `VpcLink` used for the integration when `connectionType=VPC_LINK` , otherwise undefined.
|
String |
getConnectionType()
The type of the network connection to the integration endpoint.
|
String |
getContentHandling()
Specifies how to handle request payload content type conversions.
|
String |
getCredentials()
The credentials that are required for the integration.
|
String |
getIntegrationHttpMethod()
The integration's HTTP method type.
|
Object |
getIntegrationResponses()
The response that API Gateway provides after a method's backend completes processing a request.
|
String |
getPassthroughBehavior()
Indicates when API Gateway passes requests to the targeted backend.
|
Object |
getRequestParameters()
The request parameters that API Gateway sends with the backend request.
|
Object |
getRequestTemplates()
A map of Apache Velocity templates that are applied on the request payload.
|
Number |
getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds.
|
String |
getType()
The type of backend that your method is running, such as `HTTP` or `MOCK` .
|
String |
getUri()
The Uniform Resource Identifier (URI) for the integration.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnMethod.IntegrationProperty.Builder builder)
CfnMethod.IntegrationProperty.Builder.public final List<String> getCacheKeyParameters()
CfnMethod.IntegrationProperty
For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in RequestParameters to be supported in CacheKeyParameters .
getCacheKeyParameters in interface CfnMethod.IntegrationPropertypublic final String getCacheNamespace()
CfnMethod.IntegrationPropertygetCacheNamespace in interface CfnMethod.IntegrationPropertypublic final String getConnectionId()
CfnMethod.IntegrationPropertygetConnectionId in interface CfnMethod.IntegrationPropertypublic final String getConnectionType()
CfnMethod.IntegrationProperty
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 .
getConnectionType in interface CfnMethod.IntegrationPropertypublic final String getContentHandling()
CfnMethod.IntegrationProperty
CONVERT_TO_BINARY : Converts a request payload from a base64-encoded string to a binary blob.CONVERT_TO_TEXT : Converts a request payload from a binary blob to a base64-encoded string.
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.
getContentHandling in interface CfnMethod.IntegrationPropertypublic final String getCredentials()
CfnMethod.IntegrationPropertyTo specify an AWS Identity and Access Management (IAM) role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/.
To use resource-based permissions on the AWS Lambda (Lambda) function, don't specify this property. Use the AWS::Lambda::Permission resource to permit API Gateway to call the function. For more information, see Allow Amazon API Gateway to Invoke a Lambda Function in the AWS Lambda Developer Guide .
getCredentials in interface CfnMethod.IntegrationPropertypublic final String getIntegrationHttpMethod()
CfnMethod.IntegrationProperty
For the Type property, if you specify MOCK , this property is optional. For all other types, you must specify this property.
getIntegrationHttpMethod in interface CfnMethod.IntegrationPropertypublic final Object getIntegrationResponses()
CfnMethod.IntegrationPropertyAPI 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.
getIntegrationResponses in interface CfnMethod.IntegrationPropertypublic final String getPassthroughBehavior()
CfnMethod.IntegrationProperty
This behavior depends on the request's Content-Type header and whether you defined a mapping template for it.
For more information and valid values, see the passthroughBehavior field in the API Gateway API Reference .
getPassthroughBehavior in interface CfnMethod.IntegrationPropertypublic final Object getRequestParameters()
CfnMethod.IntegrationPropertySpecify 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 query string, 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.
getRequestParameters in interface CfnMethod.IntegrationPropertypublic final Object getRequestTemplates()
CfnMethod.IntegrationProperty
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": "{\n \"statusCode\": 200\n}"
For more information about templates, see API Gateway Mapping Template and Access Logging Variable Reference in the API Gateway Developer Guide .
getRequestTemplates in interface CfnMethod.IntegrationPropertypublic final Number getTimeoutInMillis()
CfnMethod.IntegrationPropertyThe default value is 29,000 milliseconds or 29 seconds.
getTimeoutInMillis in interface CfnMethod.IntegrationPropertypublic final String getType()
CfnMethod.IntegrationProperty
For all of the valid values, see the type property for the Integration resource in the Amazon API Gateway REST API Reference .
getType in interface CfnMethod.IntegrationPropertypublic final String getUri()
CfnMethod.IntegrationProperty
If you specify HTTP for the Type property, specify the API endpoint URL.
If you specify MOCK for the Type property, don't specify this property.
If you specify AWS for the Type property, specify an AWS service that follows this form: arn:aws:apigateway: region : subdomain . service|service : path|action / service_api . For example, a Lambda function URI follows this form: arn:aws:apigateway: region :lambda:path/ path . The path is usually in the form /2015-03-31/functions/ LambdaFunctionARN /invocations. For more information, see the uri property of the Integration resource in the Amazon API Gateway REST API Reference.
If you specified HTTP or AWS for the Type property, you must specify this property.
getUri in interface CfnMethod.IntegrationProperty@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.