Package software.amazon.awscdk.services.sam

Interface CfnFunction.ApiEventProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunction.ApiEventProperty.Jsii$Proxy

Enclosing class:

CfnFunction

@Stability(Stable)
public static interface CfnFunction.ApiEventProperty
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.*;
 Object customStatements;
 ApiEventProperty apiEventProperty = ApiEventProperty.builder()
         .method("method")
         .path("path")
         // the properties below are optional
         .auth(AuthProperty.builder()
                 .apiKeyRequired(false)
                 .authorizationScopes(List.of("authorizationScopes"))
                 .authorizer("authorizer")
                 .resourcePolicy(AuthResourcePolicyProperty.builder()
                         .awsAccountBlacklist(List.of("awsAccountBlacklist"))
                         .awsAccountWhitelist(List.of("awsAccountWhitelist"))
                         .customStatements(List.of(customStatements))
                         .intrinsicVpcBlacklist(List.of("intrinsicVpcBlacklist"))
                         .intrinsicVpceBlacklist(List.of("intrinsicVpceBlacklist"))
                         .intrinsicVpceWhitelist(List.of("intrinsicVpceWhitelist"))
                         .intrinsicVpcWhitelist(List.of("intrinsicVpcWhitelist"))
                         .ipRangeBlacklist(List.of("ipRangeBlacklist"))
                         .ipRangeWhitelist(List.of("ipRangeWhitelist"))
                         .sourceVpcBlacklist(List.of("sourceVpcBlacklist"))
                         .sourceVpcWhitelist(List.of("sourceVpcWhitelist"))
                         .build())
                 .build())
         .requestModel(RequestModelProperty.builder()
                 .model("model")
                 // the properties below are optional
                 .required(false)
                 .validateBody(false)
                 .validateParameters(false)
                 .build())
         .requestParameters(List.of("requestParameters"))
         .restApiId("restApiId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunction.ApiEventProperty.Builder	builder()
default Object	getAuth()	CfnFunction.ApiEventProperty.Auth.
String	getMethod()	CfnFunction.ApiEventProperty.Method.
String	getPath()	CfnFunction.ApiEventProperty.Path.
default Object	getRequestModel()	CfnFunction.ApiEventProperty.RequestModel.
default Object	getRequestParameters()	CfnFunction.ApiEventProperty.RequestParameters.
default String	getRestApiId()	CfnFunction.ApiEventProperty.RestApiId.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@NotNull
String getMethod()

CfnFunction.ApiEventProperty.Method.

getPath

@Stability(Stable)
@NotNull
String getPath()

CfnFunction.ApiEventProperty.Path.

getAuth

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

CfnFunction.ApiEventProperty.Auth.

getRequestModel

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

CfnFunction.ApiEventProperty.RequestModel.

getRequestParameters

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

CfnFunction.ApiEventProperty.RequestParameters.

getRestApiId

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

CfnFunction.ApiEventProperty.RestApiId.

builder

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

Returns:

a CfnFunction.ApiEventProperty.Builder of CfnFunction.ApiEventProperty