StepFunctionsExecutionIntegrationOptions.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.StepFunctionsExecutionIntegrationOptions.Jsii$Proxy

All Implemented Interfaces:

IntegrationOptions, StepFunctionsExecutionIntegrationOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

StepFunctionsExecutionIntegrationOptions
```
@Stability(value=Stable)
 @Internal
public static final class StepFunctionsExecutionIntegrationOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements StepFunctionsExecutionIntegrationOptions
```
An implementation for StepFunctionsExecutionIntegrationOptions

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.StepFunctionsExecutionIntegrationOptions
  StepFunctionsExecutionIntegrationOptions.Builder, StepFunctionsExecutionIntegrationOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	`Jsii$Proxy(StepFunctionsExecutionIntegrationOptions.Builder builder)` Constructor that initializes the object based on literal property values passed by the `StepFunctionsExecutionIntegrationOptions.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Boolean`	`getAuthorizer()` If the whole authorizer object, including custom context values should be in the execution input.
`List<String>`	`getCacheKeyParameters()` A list of request parameters whose values are to be cached.
`String`	`getCacheNamespace()` An API-specific tag group of related cached parameters.
`ConnectionType`	`getConnectionType()` The type of network connection to the integration endpoint.
`ContentHandling`	`getContentHandling()` Specifies how to handle request payload content type conversions.
`Boolean`	`getCredentialsPassthrough()` Requires that the caller's identity be passed through from the request.
`IRole`	`getCredentialsRole()` An IAM role that API Gateway assumes.
`Boolean`	`getHeaders()` Check if header is to be included inside the execution input.
`List<IntegrationResponse>`	`getIntegrationResponses()` The response that API Gateway provides after a method's backend completes processing a request.
`PassthroughBehavior`	`getPassthroughBehavior()` 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.
`Boolean`	`getPath()` Check if path is to be included inside the execution input.
`Boolean`	`getQuerystring()` Check if querystring is to be included inside the execution input.
`RequestContext`	`getRequestContext()` Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.
`Map<String,String>`	`getRequestParameters()` The request parameters that API Gateway sends with the backend request.
`Map<String,String>`	`getRequestTemplates()` A map of Apache Velocity templates that are applied on the request payload.
`Duration`	`getTimeout()` The maximum amount of time an integration will run before it returns without a response.
`IVpcLink`	`getVpcLink()` The VpcLink used for the integration.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.apigateway.StepFunctionsExecutionIntegrationOptions
builder

- Constructor Detail
  - 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
```
protected Jsii$Proxy(StepFunctionsExecutionIntegrationOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the StepFunctionsExecutionIntegrationOptions.Builder.
- Method Detail
  - getAuthorizer
```
public final Boolean getAuthorizer()
```
    Description copied from interface: StepFunctionsExecutionIntegrationOptions
    
    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" } }
    Default: false
    
    Specified by:
    
    getAuthorizer in interface StepFunctionsExecutionIntegrationOptions
  - getHeaders
```
public final Boolean getHeaders()
```
    Description copied from interface: StepFunctionsExecutionIntegrationOptions
    
    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" } }
    Default: false
    
    Specified by:
    
    getHeaders in interface StepFunctionsExecutionIntegrationOptions
  - getPath
```
public final Boolean getPath()
```
    Description copied from interface: StepFunctionsExecutionIntegrationOptions
    
    Check if path is to be included inside the execution input.
    The execution input will include a new key path:
    { "body": {}, "path": { "resourceName": "resourceValue" } }
    Default: true
    
    Specified by:
    
    getPath in interface StepFunctionsExecutionIntegrationOptions
  - getQuerystring
```
public final Boolean getQuerystring()
```
    Description copied from interface: StepFunctionsExecutionIntegrationOptions
    
    Check if querystring is to be included inside the execution input.
    The execution input will include a new key queryString:
    { "body": {}, "querystring": { "key": "value" } }
    Default: true
    
    Specified by:
    
    getQuerystring in interface StepFunctionsExecutionIntegrationOptions
  - getRequestContext
```
public final RequestContext getRequestContext()
```
    Description copied from interface: StepFunctionsExecutionIntegrationOptions
    
    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" } }
    Default: - all parameters within request context will be set as false
    
    Specified by:
    
    getRequestContext in interface StepFunctionsExecutionIntegrationOptions
  - getCacheKeyParameters
```
public final List<String> 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 interface IntegrationOptions
  - getCacheNamespace
```
public final String getCacheNamespace()
```
    Description copied from interface: IntegrationOptions
    
    An API-specific tag group of related cached parameters.
    
    Specified by:
    
    getCacheNamespace in interface IntegrationOptions
  - getConnectionType
```
public final ConnectionType 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 interface IntegrationOptions
  - getContentHandling
```
public final ContentHandling 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 interface IntegrationOptions
  - getCredentialsPassthrough
```
public final Boolean 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 interface IntegrationOptions
  - getCredentialsRole
```
public final IRole 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 interface IntegrationOptions
  - getIntegrationResponses
```
public final List<IntegrationResponse> 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 interface IntegrationOptions
  - getPassthroughBehavior
```
public final PassthroughBehavior 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 interface IntegrationOptions
  - getRequestParameters
```
public final Map<String,String> 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 interface IntegrationOptions
  - getRequestTemplates
```
public final Map<String,String> 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 interface IntegrationOptions
    
    See Also:
    
    http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
  - getTimeout
```
public final Duration 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 interface IntegrationOptions
  - getVpcLink
```
public final IVpcLink getVpcLink()
```
    Description copied from interface: IntegrationOptions
    
    The VpcLink used for the integration.
    Required if connectionType is VPC_LINK
    
    Specified by:
    
    getVpcLink in interface IntegrationOptions
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class StepFunctionsExecutionIntegrationOptions.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.StepFunctionsExecutionIntegrationOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.apigateway.StepFunctionsExecutionIntegrationOptions

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAuthorizer

getHeaders

getPath

getQuerystring

getRequestContext

getCacheKeyParameters

getCacheNamespace

getConnectionType

getContentHandling

getCredentialsPassthrough

getCredentialsRole

getIntegrationResponses

getPassthroughBehavior

getRequestParameters

getRequestTemplates

getTimeout

getVpcLink

$jsii$toJson

equals

hashCode