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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html

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()
default Object	getAuth()
default String	getMethod()
default String	getPath()
default String	getPayloadFormatVersion()
default Object	getRouteSettings()
default Number	getTimeoutInMillis()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-apiid

getAuth

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-auth

getMethod

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-method

getPath

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-path

getPayloadFormatVersion

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-payloadformatversion

getRouteSettings

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-routesettings

getTimeoutInMillis

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-timeoutinmillis

builder

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

Returns:

a CfnFunction.HttpApiEventProperty.Builder of CfnFunction.HttpApiEventProperty