@Stability(value=Stable) public static final class CfnMethod.IntegrationProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnMethod.IntegrationProperty>
CfnMethod.IntegrationProperty| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder cacheKeyParameters(List<String> cacheKeyParameters)
CfnMethod.IntegrationProperty.getCacheKeyParameters()cacheKeyParameters - A list of request parameters whose values API Gateway caches.
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 .this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder cacheNamespace(String cacheNamespace)
CfnMethod.IntegrationProperty.getCacheNamespace()cacheNamespace - An API-specific tag group of related cached parameters.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder connectionId(String connectionId)
CfnMethod.IntegrationProperty.getConnectionId()connectionId - The ID of the `VpcLink` used for the integration when `connectionType=VPC_LINK` , otherwise undefined.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder connectionType(String connectionType)
CfnMethod.IntegrationProperty.getConnectionType()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 .this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder contentHandling(String contentHandling)
CfnMethod.IntegrationProperty.getContentHandling()contentHandling - Specifies how to handle request payload content type conversions. Valid values are:.
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.
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder credentials(String credentials)
CfnMethod.IntegrationProperty.getCredentials()credentials - The credentials that are required for the integration.
To 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 .
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder integrationHttpMethod(String integrationHttpMethod)
CfnMethod.IntegrationProperty.getIntegrationHttpMethod()integrationHttpMethod - The integration's HTTP method type.
For the Type property, if you specify MOCK , this property is optional. For all other types, you must specify this property.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder integrationResponses(IResolvable integrationResponses)
CfnMethod.IntegrationProperty.getIntegrationResponses()integrationResponses - 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.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder integrationResponses(List<? extends Object> integrationResponses)
CfnMethod.IntegrationProperty.getIntegrationResponses()integrationResponses - 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.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder passthroughBehavior(String passthroughBehavior)
CfnMethod.IntegrationProperty.getPassthroughBehavior()passthroughBehavior - Indicates when API Gateway passes requests to the targeted backend.
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 .
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder requestParameters(IResolvable requestParameters)
CfnMethod.IntegrationProperty.getRequestParameters()requestParameters - 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 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.
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder requestParameters(Map<String,String> requestParameters)
CfnMethod.IntegrationProperty.getRequestParameters()requestParameters - 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 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.
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder requestTemplates(IResolvable requestTemplates)
CfnMethod.IntegrationProperty.getRequestTemplates()requestTemplates - 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": "{\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 .
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder requestTemplates(Map<String,String> requestTemplates)
CfnMethod.IntegrationProperty.getRequestTemplates()requestTemplates - 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": "{\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 .
this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder timeoutInMillis(Number timeoutInMillis)
CfnMethod.IntegrationProperty.getTimeoutInMillis()timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds.
The default value is 29,000 milliseconds or 29 seconds.this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder type(String type)
CfnMethod.IntegrationProperty.getType()type - The type of backend that your method is running, such as `HTTP` or `MOCK` .
For all of the valid values, see the type property for the Integration resource in the Amazon API Gateway REST API Reference .this@Stability(value=Stable) public CfnMethod.IntegrationProperty.Builder uri(String uri)
CfnMethod.IntegrationProperty.getUri()uri - The Uniform Resource Identifier (URI) for the integration.
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.
this@Stability(value=Stable) public CfnMethod.IntegrationProperty build()
build in interface software.amazon.jsii.Builder<CfnMethod.IntegrationProperty>CfnMethod.IntegrationPropertyNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.