Class CfnIntegration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.95.0 (build f1ff514)", date="2024-03-26T18:09:19.011Z") @Stability(Stable) 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();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnIntegration

      protected CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnIntegration

      protected CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnIntegration

      @Stability(Stable) public CfnIntegration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIntegrationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.
    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.
    • getIntegrationType

      @Stability(Stable) @NotNull public String getIntegrationType()
      The integration type of an integration.

      One of the following:.

    • setIntegrationType

      @Stability(Stable) public void setIntegrationType(@NotNull String value)
      The integration type of an integration.

      One of the following:.

    • getConnectionId

      @Stability(Stable) @Nullable public String getConnectionId()
      The ID of the VPC link for a private integration.
    • setConnectionId

      @Stability(Stable) public void setConnectionId(@Nullable String value)
      The ID of the VPC link for a private integration.
    • getConnectionType

      @Stability(Stable) @Nullable public String getConnectionType()
      The type of the network connection to the integration endpoint.
    • setConnectionType

      @Stability(Stable) public void setConnectionType(@Nullable String value)
      The type of the network connection to the integration endpoint.
    • getContentHandlingStrategy

      @Stability(Stable) @Nullable public String getContentHandlingStrategy()
      Supported only for WebSocket APIs.
    • setContentHandlingStrategy

      @Stability(Stable) public void setContentHandlingStrategy(@Nullable String value)
      Supported only for WebSocket APIs.
    • getCredentialsArn

      @Stability(Stable) @Nullable public String getCredentialsArn()
      Specifies the credentials required for the integration, if any.
    • setCredentialsArn

      @Stability(Stable) public void setCredentialsArn(@Nullable String value)
      Specifies the credentials required for the integration, if any.
    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the integration.
    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the integration.
    • getIntegrationMethod

      @Stability(Stable) @Nullable public String getIntegrationMethod()
      Specifies the integration's HTTP method type.
    • setIntegrationMethod

      @Stability(Stable) public void setIntegrationMethod(@Nullable String value)
      Specifies the integration's HTTP method type.
    • getIntegrationSubtype

      @Stability(Stable) @Nullable public String getIntegrationSubtype()
      Supported only for HTTP API AWS_PROXY integrations.
    • setIntegrationSubtype

      @Stability(Stable) public void setIntegrationSubtype(@Nullable String value)
      Supported only for HTTP API AWS_PROXY integrations.
    • getIntegrationUri

      @Stability(Stable) @Nullable public String getIntegrationUri()
      For a Lambda integration, specify the URI of a Lambda function.
    • setIntegrationUri

      @Stability(Stable) public void setIntegrationUri(@Nullable String value)
      For a Lambda integration, specify the URI of a Lambda function.
    • getPassthroughBehavior

      @Stability(Stable) @Nullable public 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.
    • setPassthroughBehavior

      @Stability(Stable) public void setPassthroughBehavior(@Nullable 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.
    • getPayloadFormatVersion

      @Stability(Stable) @Nullable public String getPayloadFormatVersion()
      Specifies the format of the payload sent to an integration.
    • setPayloadFormatVersion

      @Stability(Stable) public void setPayloadFormatVersion(@Nullable String value)
      Specifies the format of the payload sent to an integration.
    • getRequestParameters

      @Stability(Stable) @Nullable public Object getRequestParameters()
      For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
    • setRequestParameters

      @Stability(Stable) public void setRequestParameters(@Nullable Object value)
      For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
    • getRequestTemplates

      @Stability(Stable) @Nullable public 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.
    • setRequestTemplates

      @Stability(Stable) public void setRequestTemplates(@Nullable 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.
    • getResponseParameters

      @Stability(Stable) @Nullable public Object getResponseParameters()
      Supported only for HTTP APIs.
    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@Nullable Object value)
      Supported only for HTTP APIs.
    • getTemplateSelectionExpression

      @Stability(Stable) @Nullable public String getTemplateSelectionExpression()
      The template selection expression for the integration.
    • setTemplateSelectionExpression

      @Stability(Stable) public void setTemplateSelectionExpression(@Nullable String value)
      The template selection expression for the integration.
    • getTimeoutInMillis

      @Stability(Stable) @Nullable public Number getTimeoutInMillis()
      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
    • setTimeoutInMillis

      @Stability(Stable) public void setTimeoutInMillis(@Nullable Number value)
      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
    • getTlsConfig

      @Stability(Stable) @Nullable public Object getTlsConfig()
      The TLS configuration for a private integration.
    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable IResolvable value)
      The TLS configuration for a private integration.
    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable CfnIntegration.TlsConfigProperty value)
      The TLS configuration for a private integration.