Package io.micronaut.starter.feature.aws

Class AmazonApiGatewayHttp

java.lang.Object

io.micronaut.starter.feature.aws.AwsLambdaRelatedFeature

io.micronaut.starter.feature.aws.AmazonApiGatewayHttp

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OneOfFeature, AwsApiFeature, AwsCloudFeature, AwsFeature, AwsLambdaEventFeature, LambdaTrigger, CloudFeature, LambdaRuntimeMainClass

@Requires(property="micronaut.starter.feature.amazon.api.gateway.http.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class AmazonApiGatewayHttp
extends AwsLambdaRelatedFeature
implements AwsApiFeature, LambdaRuntimeMainClass

Feature that enables integration with Amazon API Gateway HTTP API (v2).

This feature works with AWS CDK to define a low-latency HTTP API using API Gateway v2 and sets the runtime class to APIGatewayV2HTTPEventMicronautLambdaRuntime. It also ensures the appropriate handler provider feature is included.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.micronaut.starter.feature.aws.AwsApiFeature

MICRONAUT_AWS_APIGATEWAY

Fields inherited from interface io.micronaut.starter.feature.aws.AwsFeature

GROUP_ID_AWS_SDK_V2, GROUP_ID_MICRONAUT_AWS

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AmazonApiGatewayHttp(AwsLambda awsLambda, ApiGatewayV2AwsLambdaHandlerProvider apiGatewayV2AwsLambdaHandlerProvider)

Method Summary

Modifier and Type	Method	Description
@NonNull String	getDescription()
String	getLambdaRuntimeMainClass()
@NonNull String	getName()	The name of the feature.
String	getTitle()
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.starter.feature.aws.AwsApiFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, supports

Methods inherited from interface io.micronaut.starter.feature.aws.AwsCloudFeature

getCloud

Methods inherited from interface io.micronaut.starter.feature.aws.AwsLambdaEventFeature

getCategory, getFeatureClass

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getOrder, isCommunity, isPreview, isVisible

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

AmazonApiGatewayHttp

public AmazonApiGatewayHttp(AwsLambda awsLambda,
 ApiGatewayV2AwsLambdaHandlerProvider apiGatewayV2AwsLambdaHandlerProvider)

Method Details

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Overrides:

processSelectedFeatures in class AwsLambdaRelatedFeature

Parameters:

featureContext - The feature context

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

getLambdaRuntimeMainClass

public String getLambdaRuntimeMainClass()

Specified by:

getLambdaRuntimeMainClass in interface LambdaRuntimeMainClass