Package software.amazon.awscdk.services.sam

Interface CfnFunction.HttpApiEventProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.HttpApiEventProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.HttpApiEventProperty
extends software.amazon.jsii.JsiiSerializable

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.sam.*;
 HttpApiEventProperty httpApiEventProperty = HttpApiEventProperty.builder()
         .apiId("apiId")
         .auth(HttpApiFunctionAuthProperty.builder()
                 .authorizationScopes(List.of("authorizationScopes"))
                 .authorizer("authorizer")
                 .build())
         .method("method")
         .path("path")
         .payloadFormatVersion("payloadFormatVersion")
         .routeSettings(RouteSettingsProperty.builder()
                 .dataTraceEnabled(false)
                 .detailedMetricsEnabled(false)
                 .loggingLevel("loggingLevel")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build())
         .timeoutInMillis(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunction.HttpApiEventProperty.Builder	builder()
default String	getApiId()	CfnFunction.HttpApiEventProperty.ApiId.
default Object	getAuth()	CfnFunction.HttpApiEventProperty.Auth.
default String	getMethod()	CfnFunction.HttpApiEventProperty.Method.
default String	getPath()	CfnFunction.HttpApiEventProperty.Path.
default String	getPayloadFormatVersion()	CfnFunction.HttpApiEventProperty.PayloadFormatVersion.
default Object	getRouteSettings()	CfnFunction.HttpApiEventProperty.RouteSettings.
default Number	getTimeoutInMillis()	CfnFunction.HttpApiEventProperty.TimeoutInMillis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@Nullable
default String getApiId()

CfnFunction.HttpApiEventProperty.ApiId.

getAuth

@Stability(Stable)
@Nullable
default Object getAuth()

CfnFunction.HttpApiEventProperty.Auth.

getMethod

@Stability(Stable)
@Nullable
default String getMethod()

CfnFunction.HttpApiEventProperty.Method.

getPath

@Stability(Stable)
@Nullable
default String getPath()

CfnFunction.HttpApiEventProperty.Path.

getPayloadFormatVersion

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

CfnFunction.HttpApiEventProperty.PayloadFormatVersion.

getRouteSettings

@Stability(Stable)
@Nullable
default Object getRouteSettings()

CfnFunction.HttpApiEventProperty.RouteSettings.

getTimeoutInMillis

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

CfnFunction.HttpApiEventProperty.TimeoutInMillis.

builder

@Stability(Stable)
static CfnFunction.HttpApiEventProperty.Builder builder()

Returns:

a CfnFunction.HttpApiEventProperty.Builder of CfnFunction.HttpApiEventProperty