Package software.amazon.awscdk.services.apigatewayv2

Class CfnIntegrationProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.CfnIntegrationProps.Jsii$Proxy

All Implemented Interfaces:

CfnIntegrationProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnIntegrationProps

@Stability(Stable)
@Internal
public static final class CfnIntegrationProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnIntegrationProps

An implementation for CfnIntegrationProps

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.apigatewayv2.CfnIntegrationProps

CfnIntegrationProps.Builder, CfnIntegrationProps.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getApiId()	The API identifier.
final String	getConnectionId()	The ID of the VPC link for a private integration.
final String	getConnectionType()	The type of the network connection to the integration endpoint.
final String	getContentHandlingStrategy()	Supported only for WebSocket APIs.
final String	getCredentialsArn()	Specifies the credentials required for the integration, if any.
final String	getDescription()	The description of the integration.
final String	getIntegrationMethod()	Specifies the integration's HTTP method type.
final String	getIntegrationSubtype()	Supported only for HTTP API AWS_PROXY integrations.
final String	getIntegrationType()	The integration type of an integration.
final String	getIntegrationUri()	For a Lambda integration, specify the URI of a Lambda function.
final String	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.
final String	getPayloadFormatVersion()	Specifies the format of the payload sent to an integration.
final Object	getRequestParameters()	For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
final Object	getRequestTemplates()	Represents 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 Object	getResponseParameters()	Supported only for HTTP APIs.
final String	getTemplateSelectionExpression()	The template selection expression for the integration.
final Number	getTimeoutInMillis()	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
final Object	getTlsConfig()	The TLS configuration for a private integration.
final 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

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

protected Jsii$Proxy(CfnIntegrationProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnIntegrationProps.Builder.

Method Details

getApiId

public final String getApiId()

Description copied from interface: CfnIntegrationProps

The API identifier.

Specified by:

getApiId in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid

getIntegrationType

public final String getIntegrationType()

Description copied from interface: CfnIntegrationProps

The integration type of an integration. One of the following:.

AWS : for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.

AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

Specified by:

getIntegrationType in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype

getConnectionId

public final String getConnectionId()

Description copied from interface: CfnIntegrationProps

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

Specified by:

getConnectionId in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectionid

getConnectionType

public final String getConnectionType()

Description copied from interface: CfnIntegrationProps

The type of the network connection to the integration endpoint.

Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .

Specified by:

getConnectionType in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype

getContentHandlingStrategy

public final String getContentHandlingStrategy()

Description copied from interface: CfnIntegrationProps

Supported only for WebSocket APIs.

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Specified by:

getContentHandlingStrategy in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy

getCredentialsArn

public final String getCredentialsArn()

Description copied from interface: CfnIntegrationProps

Specifies 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, don't specify this parameter.

Specified by:

getCredentialsArn in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn

getDescription

public final String getDescription()

Description copied from interface: CfnIntegrationProps

The description of the integration.

Specified by:

getDescription in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description

getIntegrationMethod

public final String getIntegrationMethod()

Description copied from interface: CfnIntegrationProps

Specifies the integration's HTTP method type.

For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .

Specified by:

getIntegrationMethod in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod

getIntegrationSubtype

public final String getIntegrationSubtype()

Description copied from interface: CfnIntegrationProps

Supported only for HTTP API AWS_PROXY integrations.

Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .

Specified by:

getIntegrationSubtype in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationsubtype

getIntegrationUri

public final String getIntegrationUri()

Description copied from interface: CfnIntegrationProps

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

Specified by:

getIntegrationUri in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri

getPassthroughBehavior

public final String getPassthroughBehavior()

Description copied from interface: CfnIntegrationProps

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 . Supported only for WebSocket APIs.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Specified by:

getPassthroughBehavior in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior

getPayloadFormatVersion

public final String getPayloadFormatVersion()

Description copied from interface: CfnIntegrationProps

Specifies the format of the payload sent to an integration.

Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .

Specified by:

getPayloadFormatVersion in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion

getRequestParameters

public final Object getRequestParameters()

Description copied from interface: CfnIntegrationProps

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

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 backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

Specified by:

getRequestParameters in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters

getRequestTemplates

public final Object getRequestTemplates()

Description copied from interface: CfnIntegrationProps

Represents 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. Supported only for WebSocket APIs.

Specified by:

getRequestTemplates in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates

getResponseParameters

public final Object getResponseParameters()

Description copied from interface: CfnIntegrationProps

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

Specified by:

getResponseParameters in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-responseparameters

getTemplateSelectionExpression

public final String getTemplateSelectionExpression()

Description copied from interface: CfnIntegrationProps

The template selection expression for the integration.

Supported only for WebSocket APIs.

Specified by:

getTemplateSelectionExpression in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression

getTimeoutInMillis

public final Number getTimeoutInMillis()

Description copied from interface: CfnIntegrationProps

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Specified by:

getTimeoutInMillis in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis

getTlsConfig

public final Object getTlsConfig()

Description copied from interface: CfnIntegrationProps

The TLS configuration for a private integration.

If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Specified by:

getTlsConfig in interface CfnIntegrationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-tlsconfig

$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