Class ApiGatewayIntegration.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- software.aws.awsprototypingsdk.openapigateway.ApiGatewayIntegration.Jsii$Proxy
-
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable,ApiGatewayIntegration
- Enclosing interface:
- ApiGatewayIntegration
@Stability(Experimental) @Internal public static final class ApiGatewayIntegration.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ApiGatewayIntegration
An implementation forApiGatewayIntegration
-
-
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.aws.awsprototypingsdk.openapigateway.ApiGatewayIntegration
ApiGatewayIntegration.Builder, ApiGatewayIntegration.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.protectedJsii$Proxy(ApiGatewayIntegration.Builder builder)Constructor that initializes the object based on literal property values passed by theApiGatewayIntegration.Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)List<String>getCacheKeyParameters()(experimental) A list of request parameters whose values are to be cached.StringgetCacheNamespace()(experimental) An API-specific tag group of related cached parameters.StringgetConnectionId()(experimental) The ID of a VpcLink for the private integration.StringgetConnectionType()(experimental) The integration connection type.StringgetContentHandling()(experimental) Request payload encoding conversion types.StringgetCredentials()(experimental) For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role.StringgetHttpMethod()(experimental) The HTTP method used in the integration request.StringgetPassthroughBehavior()(experimental) Specifies how a request payload of unmapped content type is passed through the integration request without modification.Map<String,String>getRequestParameters()(experimental) Specifies mappings from method request parameters to integration request parameters.Map<String,String>getRequestTemplates()(experimental) Mapping templates for a request payload of specified MIME types.Map<String,ApiGatewayIntegrationResponse>getResponses()(experimental) Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.NumbergetTimeoutInMillis()(experimental) Custom timeout between 50 and 29,000 milliseconds.ApiGatewayIntegrationTlsConfiggetTlsConfig()(experimental) Specifies the TLS configuration for an integration.StringgetType()(experimental) The type of integration with the specified backend.StringgetUri()(experimental) The endpoint URI of the backend.inthashCode()
-
-
-
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(ApiGatewayIntegration.Builder builder)
Constructor that initializes the object based on literal property values passed by theApiGatewayIntegration.Builder.
-
-
Method Detail
-
getCacheKeyParameters
public final List<String> getCacheKeyParameters()
Description copied from interface:ApiGatewayIntegration(experimental) A list of request parameters whose values are to be cached.- Specified by:
getCacheKeyParametersin interfaceApiGatewayIntegration
-
getCacheNamespace
public final String getCacheNamespace()
Description copied from interface:ApiGatewayIntegration(experimental) An API-specific tag group of related cached parameters.- Specified by:
getCacheNamespacein interfaceApiGatewayIntegration
-
getConnectionId
public final String getConnectionId()
Description copied from interface:ApiGatewayIntegration(experimental) The ID of a VpcLink for the private integration.- Specified by:
getConnectionIdin interfaceApiGatewayIntegration- See Also:
- https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html
-
getConnectionType
public final String getConnectionType()
Description copied from interface:ApiGatewayIntegration(experimental) The integration connection type.The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise.
- Specified by:
getConnectionTypein interfaceApiGatewayIntegration
-
getContentHandling
public final String getContentHandling()
Description copied from interface:ApiGatewayIntegration(experimental) Request payload encoding conversion types.Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification.
- Specified by:
getContentHandlingin interfaceApiGatewayIntegration
-
getCredentials
public final String getCredentials()
Description copied from interface:ApiGatewayIntegration(experimental) For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role.If unspecified, credentials default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy.
Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this API is deployed for best performance.
- Specified by:
getCredentialsin interfaceApiGatewayIntegration
-
getHttpMethod
public final String getHttpMethod()
Description copied from interface:ApiGatewayIntegration(experimental) The HTTP method used in the integration request.For Lambda function invocations, the value must be POST.
- Specified by:
getHttpMethodin interfaceApiGatewayIntegration
-
getPassthroughBehavior
public final String getPassthroughBehavior()
Description copied from interface:ApiGatewayIntegration(experimental) Specifies how a request payload of unmapped content type is passed through the integration request without modification.Supported values are when_no_templates, when_no_match, and never.
- Specified by:
getPassthroughBehaviorin interfaceApiGatewayIntegration- See Also:
- https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior
-
getRequestParameters
public final Map<String,String> getRequestParameters()
Description copied from interface:ApiGatewayIntegration(experimental) Specifies mappings from method request parameters to integration request parameters.Supported request parameters are querystring, path, header, and body.
-
getRequestTemplates
public final Map<String,String> getRequestTemplates()
Description copied from interface:ApiGatewayIntegration(experimental) Mapping templates for a request payload of specified MIME types.
-
getResponses
public final Map<String,ApiGatewayIntegrationResponse> getResponses()
Description copied from interface:ApiGatewayIntegration(experimental) Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.- Specified by:
getResponsesin interfaceApiGatewayIntegration- See Also:
- https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html
-
getTimeoutInMillis
public final Number getTimeoutInMillis()
Description copied from interface:ApiGatewayIntegration(experimental) Custom timeout between 50 and 29,000 milliseconds.The default value is 29,000 milliseconds or 29 seconds.
- Specified by:
getTimeoutInMillisin interfaceApiGatewayIntegration
-
getTlsConfig
public final ApiGatewayIntegrationTlsConfig getTlsConfig()
Description copied from interface:ApiGatewayIntegration(experimental) Specifies the TLS configuration for an integration.- Specified by:
getTlsConfigin interfaceApiGatewayIntegration- See Also:
- https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html
-
getType
public final String getType()
Description copied from interface:ApiGatewayIntegration(experimental) The type of integration with the specified backend.- Specified by:
getTypein interfaceApiGatewayIntegration- See Also:
- https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type
-
getUri
public final String getUri()
Description copied from interface:ApiGatewayIntegration(experimental) The endpoint URI of the backend.For integrations of the aws type, this is an ARN value. For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme.
- Specified by:
getUriin interfaceApiGatewayIntegration
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-