@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:58.234Z") public class CfnIntegration extends CfnResource implements IInspectable
The AWS::ApiGatewayV2::Integration
resource creates an integration for an API.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigatewayv2.*; Object requestParameters; Object requestTemplates; Object responseParameters; CfnIntegration cfnIntegration = CfnIntegration.Builder.create(this, "MyCfnIntegration") .apiId("apiId") .integrationType("integrationType") // the properties below are optional .connectionId("connectionId") .connectionType("connectionType") .contentHandlingStrategy("contentHandlingStrategy") .credentialsArn("credentialsArn") .description("description") .integrationMethod("integrationMethod") .integrationSubtype("integrationSubtype") .integrationUri("integrationUri") .passthroughBehavior("passthroughBehavior") .payloadFormatVersion("payloadFormatVersion") .requestParameters(requestParameters) .requestTemplates(requestTemplates) .responseParameters(responseParameters) .templateSelectionExpression("templateSelectionExpression") .timeoutInMillis(123) .tlsConfig(TlsConfigProperty.builder() .serverNameToVerify("serverNameToVerify") .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnIntegration.Builder
A fluent builder for
CfnIntegration . |
static interface |
CfnIntegration.ResponseParameterListProperty
Specifies a list of response parameters for an HTTP API.
|
static interface |
CfnIntegration.ResponseParameterProperty
Supported only for HTTP APIs.
|
static interface |
CfnIntegration.TlsConfigProperty
The `TlsConfig` property specifies the TLS configuration for a private integration.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnIntegration(Construct scope,
java.lang.String id,
CfnIntegrationProps props)
Create a new `AWS::ApiGatewayV2::Integration`.
|
protected |
CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApiId()
The API identifier.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getConnectionId()
The ID of the VPC link for a private integration.
|
java.lang.String |
getConnectionType()
The type of the network connection to the integration endpoint.
|
java.lang.String |
getContentHandlingStrategy()
Supported only for WebSocket APIs.
|
java.lang.String |
getCredentialsArn()
Specifies the credentials required for the integration, if any.
|
java.lang.String |
getDescription()
The description of the integration.
|
java.lang.String |
getIntegrationMethod()
Specifies the integration's HTTP method type.
|
java.lang.String |
getIntegrationSubtype()
Supported only for HTTP API `AWS_PROXY` integrations.
|
java.lang.String |
getIntegrationType()
The integration type of an integration.
|
java.lang.String |
getIntegrationUri()
For a Lambda integration, specify the URI of a Lambda function.
|
java.lang.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.
|
java.lang.String |
getPayloadFormatVersion()
Specifies the format of the payload sent to an integration.
|
java.lang.Object |
getRequestParameters()
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
|
java.lang.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.
|
java.lang.Object |
getResponseParameters()
Supported only for HTTP APIs.
|
java.lang.String |
getTemplateSelectionExpression()
The template selection expression for the integration.
|
java.lang.Number |
getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
|
java.lang.Object |
getTlsConfig()
The TLS configuration for a private integration.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApiId(java.lang.String value)
The API identifier.
|
void |
setConnectionId(java.lang.String value)
The ID of the VPC link for a private integration.
|
void |
setConnectionType(java.lang.String value)
The type of the network connection to the integration endpoint.
|
void |
setContentHandlingStrategy(java.lang.String value)
Supported only for WebSocket APIs.
|
void |
setCredentialsArn(java.lang.String value)
Specifies the credentials required for the integration, if any.
|
void |
setDescription(java.lang.String value)
The description of the integration.
|
void |
setIntegrationMethod(java.lang.String value)
Specifies the integration's HTTP method type.
|
void |
setIntegrationSubtype(java.lang.String value)
Supported only for HTTP API `AWS_PROXY` integrations.
|
void |
setIntegrationType(java.lang.String value)
The integration type of an integration.
|
void |
setIntegrationUri(java.lang.String value)
For a Lambda integration, specify the URI of a Lambda function.
|
void |
setPassthroughBehavior(java.lang.String value)
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.
|
void |
setPayloadFormatVersion(java.lang.String value)
Specifies the format of the payload sent to an integration.
|
void |
setRequestParameters(java.lang.Object value)
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
|
void |
setRequestTemplates(java.lang.Object value)
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.
|
void |
setResponseParameters(java.lang.Object value)
Supported only for HTTP APIs.
|
void |
setTemplateSelectionExpression(java.lang.String value)
The template selection expression for the integration.
|
void |
setTimeoutInMillis(java.lang.Number value)
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
|
void |
setTlsConfig(CfnIntegration.TlsConfigProperty value)
The TLS configuration for a private integration.
|
void |
setTlsConfig(IResolvable value)
The TLS configuration for a private integration.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnIntegration(Construct scope, java.lang.String id, CfnIntegrationProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApiId()
public void setApiId(java.lang.String value)
public java.lang.String getIntegrationType()
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.
public void setIntegrationType(java.lang.String value)
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.
public java.lang.Object getRequestParameters()
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 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 .
public void setRequestParameters(java.lang.Object value)
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 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 .
public java.lang.Object getRequestTemplates()
The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
public void setRequestTemplates(java.lang.Object value)
The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
public java.lang.Object getResponseParameters()
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 .
public void setResponseParameters(java.lang.Object value)
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 .
public java.lang.String getConnectionId()
Supported only for HTTP APIs.
public void setConnectionId(java.lang.String value)
Supported only for HTTP APIs.
public java.lang.String getConnectionType()
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
.
public void setConnectionType(java.lang.String value)
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
.
public java.lang.String getContentHandlingStrategy()
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.
public void setContentHandlingStrategy(java.lang.String value)
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.
public java.lang.String getCredentialsArn()
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.
public void setCredentialsArn(java.lang.String value)
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.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getIntegrationMethod()
public void setIntegrationMethod(java.lang.String value)
public java.lang.String getIntegrationSubtype()
Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
public void setIntegrationSubtype(java.lang.String value)
Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
public java.lang.String getIntegrationUri()
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 .
public void setIntegrationUri(java.lang.String value)
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 .
public java.lang.String getPassthroughBehavior()
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.
public void setPassthroughBehavior(java.lang.String value)
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.
public java.lang.String getPayloadFormatVersion()
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 .
public void setPayloadFormatVersion(java.lang.String value)
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 .
public java.lang.String getTemplateSelectionExpression()
Supported only for WebSocket APIs.
public void setTemplateSelectionExpression(java.lang.String value)
Supported only for WebSocket APIs.
public java.lang.Number getTimeoutInMillis()
The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
public void setTimeoutInMillis(java.lang.Number value)
The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
public java.lang.Object getTlsConfig()
If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
public void setTlsConfig(IResolvable value)
If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
public void setTlsConfig(CfnIntegration.TlsConfigProperty value)
If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.