Package io.micronaut.starter.feature.aws

Class AmazonCognito

java.lang.Object

io.micronaut.starter.feature.security.SecurityOAuth2Feature

io.micronaut.starter.feature.aws.AmazonCognito

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, AwsCloudFeature, AwsFeature, CloudFeature, SecurityAuthenticationModeProvider, SecurityOAuth2Configuration

@Requires(property="micronaut.starter.feature.amazon.cognito.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class AmazonCognito
extends SecurityOAuth2Feature
implements AwsFeature, SecurityOAuth2Configuration, SecurityAuthenticationModeProvider

Feature that enables integration with Amazon Cognito for authentication and authorization.

Configures Micronaut Security with OAuth 2.0 support and provides default issuer and authentication mode settings. Can be used with the CDK to provision a Cognito User Pool and OAuth 2.0 application.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

Fields inherited from interface io.micronaut.starter.feature.security.SecurityAuthenticationModeProvider

PROPERTY_MICRONAUT_SECURITY_AUTHENTICATION

Constructor Summary

Constructors

Constructor	Description
AmazonCognito(SecurityOAuth2 securityOAuth2, SecurityJWT securityJWT)

Method Summary

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

Methods inherited from class io.micronaut.starter.feature.security.SecurityOAuth2Feature

processSelectedFeatures

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.AwsCloudFeature

getCloud

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

getDescription

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

apply, getFrameworkDocumentation, getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, processSelectedFeatures

Methods inherited from interface io.micronaut.starter.feature.security.SecurityOAuth2Configuration

getClientId, getClientSecret

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

AmazonCognito

public AmazonCognito(SecurityOAuth2 securityOAuth2,
 SecurityJWT securityJWT)

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

@NonNull
public @NonNull 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

@NonNull
public @NonNull String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getIssuer

@NonNull
public @NonNull String getIssuer()

Specified by:

getIssuer in interface SecurityOAuth2Configuration

getSecurityAuthenticationMode

@NonNull
public @NonNull SecurityAuthenticationMode getSecurityAuthenticationMode()

Specified by:

getSecurityAuthenticationMode in interface SecurityAuthenticationModeProvider