Package io.micronaut.starter.feature.aws

Interface AwsApiFeature

All Superinterfaces:

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

All Known Implementing Classes:

AmazonApiGateway, AmazonApiGatewayHttp, LambdaFunctionUrl

public interface AwsApiFeature
extends AwsLambdaEventFeature, LambdaTrigger

Field Summary

Fields

Modifier and Type	Field	Description
static final Dependency	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

Method Summary

Modifier and Type	Method	Description
default void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
default String	getFrameworkDocumentation(GeneratorContext generatorContext)
default String	getThirdPartyDocumentation(GeneratorContext generatorContext)
default boolean	supports(Options options)	This method must be implemented to ensure it is only selectable for the desired application types.

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

getDescription, getName, getOrder, getTitle, isCommunity, isPreview, isVisible, processSelectedFeatures

Field Details

MICRONAUT_AWS_APIGATEWAY

static final Dependency MICRONAUT_AWS_APIGATEWAY

Method Details

getFrameworkDocumentation

default String getFrameworkDocumentation(GeneratorContext generatorContext)

Specified by:

getFrameworkDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

getThirdPartyDocumentation

default String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org

supports

default boolean supports(Options options)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Specified by:

supports in interface Feature

Parameters:

options - Options

Returns:

True if the feature can be selected by the user

apply

default void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context