Class CfnMethodPropsMixin.IntegrationProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnMethodPropsMixin.IntegrationProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnMethodPropsMixin.IntegrationProperty
CfnMethodPropsMixin.IntegrationProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnMethodPropsMixin.IntegrationProperty
CfnMethodPropsMixin.IntegrationProperty.Builder, CfnMethodPropsMixin.IntegrationProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnMethodPropsMixin.IntegrationProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanA list of request parameters whose values API Gateway caches.final StringSpecifies a group of related cached parameters.final StringThe ID of the VpcLink used for the integration whenconnectionType=VPC_LINKand undefined, otherwise.final StringThe type of the network connection to the integration endpoint.final StringSpecifies how to handle request payload content type conversions.final StringSpecifies the credentials required for the integration, if any.final StringSpecifies the integration's HTTP method type.final ObjectSpecifies the integration's responses.final StringThe ALB or NLB listener to send the request to.final StringSpecifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.final ObjectA key-value map specifying request parameters that are passed from the method request to the back end.final ObjectRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.final StringThe response transfer mode of the integration.final NumberCustom timeout between 50 and 29,000 milliseconds.final StringgetType()Specifies an API method integration type.final StringgetUri()Specifies Uniform Resource Identifier (URI) of the integration endpoint.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
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
Constructor that initializes the object based on literal property values passed by theCfnMethodPropsMixin.IntegrationProperty.Builder.
-
-
Method Details
-
getCacheKeyParameters
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyA list of request parameters whose values API Gateway caches.To be valid values for
cacheKeyParameters, these parameters must also be specified for MethodrequestParameters.- Specified by:
getCacheKeyParametersin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getCacheNamespace
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies a group of related cached parameters.By default, API Gateway uses the resource ID as the
cacheNamespace. You can specify the samecacheNamespaceacross resources to return the same cached data for requests to different resources.- Specified by:
getCacheNamespacein interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getConnectionId
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyThe ID of the VpcLink used for the integration whenconnectionType=VPC_LINKand undefined, otherwise.- Specified by:
getConnectionIdin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getConnectionType
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyThe type of the network connection to the integration endpoint.The valid value is
INTERNETfor connections through the public routable internet orVPC_LINKfor private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET.- Specified by:
getConnectionTypein interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getContentHandling
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies how to handle request payload content type conversions.Supported values are
CONVERT_TO_BINARYandCONVERT_TO_TEXT, with the following behaviors:If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the
passthroughBehavioris configured to support payload pass-through.- Specified by:
getContentHandlingin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getCredentials
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies the credentials required for the integration, if any.For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.- Specified by:
getCredentialsin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getIntegrationHttpMethod
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies the integration's HTTP method type.For the Type property, if you specify
MOCK, this property is optional. For Lambda integrations, you must set the integration method toPOST. For all other types, you must specify this property.- Specified by:
getIntegrationHttpMethodin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getIntegrationResponses
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies the integration's responses.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnMethodPropsMixin.IntegrationResponseProperty>- Specified by:
getIntegrationResponsesin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getIntegrationTarget
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyThe ALB or NLB listener to send the request to.Only supported for private integrations that use VPC links V2.
- Specified by:
getIntegrationTargetin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getPassthroughBehavior
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation.A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in
requestTemplates. The valid value is one of the following:WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.- Specified by:
getPassthroughBehaviorin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getRequestParameters
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyA key-value map specifying request parameters that are passed from the method request to the back end.The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of
method.request.{location}.{name}, wherelocationisquerystring,path, orheaderandnamemust be a valid and unique method request parameter name.Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- Specified by:
getRequestParametersin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getRequestTemplates
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyRepresents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.The content type value is the key in this map, and the template (as a String) is the value.
Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- Specified by:
getRequestTemplatesin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getResponseTransferMode
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyThe response transfer mode of the integration.Use
STREAMto have API Gateway stream response your back to you or useBUFFEREDto have API Gateway wait to receive the complete response before beginning transmission.Default: - "BUFFERED"
- Specified by:
getResponseTransferModein interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getTimeoutInMillis
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertyCustom timeout between 50 and 29,000 milliseconds.The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.
- Specified by:
getTimeoutInMillisin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getType
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies an API method integration type. The valid value is one of the following:.For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionTypeofVPC_LINKis referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.- Specified by:
getTypein interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
getUri
Description copied from interface:CfnMethodPropsMixin.IntegrationPropertySpecifies Uniform Resource Identifier (URI) of the integration endpoint.For
HTTPorHTTP_PROXYintegrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionTypeisVPC_LINKspecify the Network Load Balancer DNS name. ForAWSorAWS_PROXYintegrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}- Specified by:
getUriin interfaceCfnMethodPropsMixin.IntegrationProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-