Package io.micronaut.starter.feature.aws

Class Cdk

java.lang.Object

io.micronaut.starter.feature.aws.Cdk

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, MultiProjectFeature, InfrastructureAsCodeFeature

@Requires(property="micronaut.starter.feature.aws.cdk.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Cdk
extends Object
implements MultiProjectFeature, InfrastructureAsCodeFeature

Micronaut feature that provides support for AWS Cloud Development Kit (CDK) to enable infrastructure-as-code for multi-project setups.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INFRA_MODULE
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Cdk(CoordinateResolver coordinateResolver, X86 x86)

Method Summary

Modifier and Type	Method	Description
String	getCategory()
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
String	getTitle()
boolean	supports(Options options)	This method must be implemented to ensure it is only selectable for the desired application types.
boolean	useVersionCatalog()

Methods inherited from class java.lang.Object

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

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

getDescription

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

apply, getFrameworkDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Methods inherited from interface io.micronaut.starter.feature.InfrastructureAsCodeFeature

getOrder

Field Details

INFRA_MODULE

public static final String INFRA_MODULE

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

Cdk

public Cdk(CoordinateResolver coordinateResolver,
 X86 x86)

Method Details

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

supports

public 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

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

useVersionCatalog

public boolean useVersionCatalog()

Returns:

Whether the build should use Micronaut Gradle Version Catalog.

getThirdPartyDocumentation

public 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