software.amazon.awscdk.services.apigatewayv2

Interface CfnIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.784Z")
 @Stability(value=Stable)
public interface CfnIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGatewayV2::Integration`.

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;
 CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIntegrationProps.Builder A builder for CfnIntegrationProps
static class	CfnIntegrationProps.Jsii$Proxy An implementation for CfnIntegrationProps

Method Summary

Modifier and Type	Method and Description
static CfnIntegrationProps.Builder	builder()
String	getApiId() `AWS::ApiGatewayV2::Integration.ApiId`.
default String	getConnectionId() `AWS::ApiGatewayV2::Integration.ConnectionId`.
default String	getConnectionType() `AWS::ApiGatewayV2::Integration.ConnectionType`.
default String	getContentHandlingStrategy() `AWS::ApiGatewayV2::Integration.ContentHandlingStrategy`.
default String	getCredentialsArn() `AWS::ApiGatewayV2::Integration.CredentialsArn`.
default String	getDescription() `AWS::ApiGatewayV2::Integration.Description`.
default String	getIntegrationMethod() `AWS::ApiGatewayV2::Integration.IntegrationMethod`.
default String	getIntegrationSubtype() `AWS::ApiGatewayV2::Integration.IntegrationSubtype`.
String	getIntegrationType() `AWS::ApiGatewayV2::Integration.IntegrationType`.
default String	getIntegrationUri() `AWS::ApiGatewayV2::Integration.IntegrationUri`.
default String	getPassthroughBehavior() `AWS::ApiGatewayV2::Integration.PassthroughBehavior`.
default String	getPayloadFormatVersion() `AWS::ApiGatewayV2::Integration.PayloadFormatVersion`.
default Object	getRequestParameters() `AWS::ApiGatewayV2::Integration.RequestParameters`.
default Object	getRequestTemplates() `AWS::ApiGatewayV2::Integration.RequestTemplates`.
default Object	getResponseParameters() `AWS::ApiGatewayV2::Integration.ResponseParameters`.
default String	getTemplateSelectionExpression() `AWS::ApiGatewayV2::Integration.TemplateSelectionExpression`.
default Number	getTimeoutInMillis() `AWS::ApiGatewayV2::Integration.TimeoutInMillis`.
default Object	getTlsConfig() `AWS::ApiGatewayV2::Integration.TlsConfig`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

@Stability(value=Stable)
 @NotNull
String getApiId()

`AWS::ApiGatewayV2::Integration.ApiId`.

getConnectionId

@Stability(value=Stable)
 @Nullable
default String getConnectionId()

`AWS::ApiGatewayV2::Integration.ConnectionId`.

getConnectionType

@Stability(value=Stable)
 @Nullable
default String getConnectionType()

`AWS::ApiGatewayV2::Integration.ConnectionType`.

getContentHandlingStrategy

@Stability(value=Stable)
 @Nullable
default String getContentHandlingStrategy()

`AWS::ApiGatewayV2::Integration.ContentHandlingStrategy`.

getCredentialsArn

@Stability(value=Stable)
 @Nullable
default String getCredentialsArn()

`AWS::ApiGatewayV2::Integration.CredentialsArn`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::ApiGatewayV2::Integration.Description`.

getIntegrationMethod

@Stability(value=Stable)
 @Nullable
default String getIntegrationMethod()

`AWS::ApiGatewayV2::Integration.IntegrationMethod`.

getIntegrationSubtype

@Stability(value=Stable)
 @Nullable
default String getIntegrationSubtype()

`AWS::ApiGatewayV2::Integration.IntegrationSubtype`.

getIntegrationType

@Stability(value=Stable)
 @NotNull
String getIntegrationType()

`AWS::ApiGatewayV2::Integration.IntegrationType`.

getIntegrationUri

@Stability(value=Stable)
 @Nullable
default String getIntegrationUri()

`AWS::ApiGatewayV2::Integration.IntegrationUri`.

getPassthroughBehavior

@Stability(value=Stable)
 @Nullable
default String getPassthroughBehavior()

`AWS::ApiGatewayV2::Integration.PassthroughBehavior`.

getPayloadFormatVersion

@Stability(value=Stable)
 @Nullable
default String getPayloadFormatVersion()

`AWS::ApiGatewayV2::Integration.PayloadFormatVersion`.

getRequestParameters

@Stability(value=Stable)
 @Nullable
default Object getRequestParameters()

`AWS::ApiGatewayV2::Integration.RequestParameters`.

getRequestTemplates

@Stability(value=Stable)
 @Nullable
default Object getRequestTemplates()

`AWS::ApiGatewayV2::Integration.RequestTemplates`.

getResponseParameters

@Stability(value=Stable)
 @Nullable
default Object getResponseParameters()

`AWS::ApiGatewayV2::Integration.ResponseParameters`.

getTemplateSelectionExpression

@Stability(value=Stable)
 @Nullable
default String getTemplateSelectionExpression()

`AWS::ApiGatewayV2::Integration.TemplateSelectionExpression`.

getTimeoutInMillis

@Stability(value=Stable)
 @Nullable
default Number getTimeoutInMillis()

`AWS::ApiGatewayV2::Integration.TimeoutInMillis`.

getTlsConfig

@Stability(value=Stable)
 @Nullable
default Object getTlsConfig()

`AWS::ApiGatewayV2::Integration.TlsConfig`.

builder

@Stability(value=Stable)
static CfnIntegrationProps.Builder builder()

Returns:

a CfnIntegrationProps.Builder of CfnIntegrationProps