@Stability(value=Stable) public static final class StepFunctionsExecutionIntegrationOptions.Builder extends Object implements software.amazon.jsii.Builder<StepFunctionsExecutionIntegrationOptions>
StepFunctionsExecutionIntegrationOptions| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder authorizer(Boolean authorizer)
StepFunctionsExecutionIntegrationOptions.getAuthorizer()authorizer - If the whole authorizer object, including custom context values should be in the execution input.
The execution input will include a new key authorizer:
{ "body": {}, "authorizer": { "key": "value" } }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder headers(Boolean headers)
StepFunctionsExecutionIntegrationOptions.getHeaders()headers - Check if header is to be included inside the execution input.
The execution input will include a new key headers:
{ "body": {}, "headers": { "header1": "value", "header2": "value" } }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder path(Boolean path)
StepFunctionsExecutionIntegrationOptions.getPath()path - Check if path is to be included inside the execution input.
The execution input will include a new key path:
{ "body": {}, "path": { "resourceName": "resourceValue" } }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder querystring(Boolean querystring)
StepFunctionsExecutionIntegrationOptions.getQuerystring()querystring - Check if querystring is to be included inside the execution input.
The execution input will include a new key queryString:
{ "body": {}, "querystring": { "key": "value" } }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder requestContext(RequestContext requestContext)
StepFunctionsExecutionIntegrationOptions.getRequestContext()requestContext - Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.
The execution input will include a new key requestContext:
{ "body": {}, "requestContext": { "key": "value" } }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder cacheKeyParameters(List<String> cacheKeyParameters)
IntegrationOptions.getCacheKeyParameters()cacheKeyParameters - A list of request parameters whose values are to be cached.
It determines
request parameters that will make it into the cache key.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder cacheNamespace(String cacheNamespace)
IntegrationOptions.getCacheNamespace()cacheNamespace - An API-specific tag group of related cached parameters.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder connectionType(ConnectionType connectionType)
IntegrationOptions.getConnectionType()connectionType - The type of network connection to the integration endpoint.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder contentHandling(ContentHandling contentHandling)
IntegrationOptions.getContentHandling()contentHandling - Specifies how to handle request payload content type conversions.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder credentialsPassthrough(Boolean credentialsPassthrough)
IntegrationOptions.getCredentialsPassthrough()credentialsPassthrough - Requires that the caller's identity be passed through from the request.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder credentialsRole(IRole credentialsRole)
IntegrationOptions.getCredentialsRole()credentialsRole - An IAM role that API Gateway assumes.
Mutually exclusive with credentialsPassThrough.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder integrationResponses(List<? extends IntegrationResponse> integrationResponses)
IntegrationOptions.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 StepFunctionsExecutionIntegrationOptions.Builder passthroughBehavior(PassthroughBehavior passthroughBehavior)
IntegrationOptions.getPassthroughBehavior()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.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder requestParameters(Map<String,String> requestParameters)
IntegrationOptions.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 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.
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder requestTemplates(Map<String,String> requestTemplates)
IntegrationOptions.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": "{ \"statusCode\": 200 }" }
this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder timeout(Duration timeout)
IntegrationOptions.getTimeout()timeout - The maximum amount of time an integration will run before it returns without a response.
Must be between 50 milliseconds and 29 seconds.this@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions.Builder vpcLink(IVpcLink vpcLink)
IntegrationOptions.getVpcLink()vpcLink - The VpcLink used for the integration.
Required if connectionType is VPC_LINKthis@Stability(value=Stable) public StepFunctionsExecutionIntegrationOptions build()
build in interface software.amazon.jsii.Builder<StepFunctionsExecutionIntegrationOptions>StepFunctionsExecutionIntegrationOptionsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.