software.amazon.awscdk.services.elasticloadbalancingv2.actions

Interface AuthenticateCognitoActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthenticateCognitoActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.136Z")
 @Stability(value=Stable)
public interface AuthenticateCognitoActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for AuthenticateCognitoAction.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cognito.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.actions.*;
 ListenerAction listenerAction;
 UserPool userPool;
 UserPoolClient userPoolClient;
 UserPoolDomain userPoolDomain;
 AuthenticateCognitoActionProps authenticateCognitoActionProps = AuthenticateCognitoActionProps.builder()
         .next(listenerAction)
         .userPool(userPool)
         .userPoolClient(userPoolClient)
         .userPoolDomain(userPoolDomain)
         // the properties below are optional
         .authenticationRequestExtraParams(Map.of(
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
         .onUnauthenticatedRequest(UnauthenticatedAction.DENY)
         .scope("scope")
         .sessionCookieName("sessionCookieName")
         .sessionTimeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AuthenticateCognitoActionProps.Builder	builder()
default Map<String,String>	getAuthenticationRequestExtraParams() The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
ListenerAction	getNext() What action to execute next.
default UnauthenticatedAction	getOnUnauthenticatedRequest() The behavior if the user is not authenticated.
default String	getScope() The set of user claims to be requested from the IdP.
default String	getSessionCookieName() The name of the cookie used to maintain session information.
default Duration	getSessionTimeout() The maximum duration of the authentication session.
IUserPool	getUserPool() The Amazon Cognito user pool.
IUserPoolClient	getUserPoolClient() The Amazon Cognito user pool client.
IUserPoolDomain	getUserPoolDomain() The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNext

@Stability(value=Stable)
 @NotNull
ListenerAction getNext()

What action to execute next.

Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

getUserPool

@Stability(value=Stable)
 @NotNull
IUserPool getUserPool()

The Amazon Cognito user pool.

getUserPoolClient

@Stability(value=Stable)
 @NotNull
IUserPoolClient getUserPoolClient()

The Amazon Cognito user pool client.

getUserPoolDomain

@Stability(value=Stable)
 @NotNull
IUserPoolDomain getUserPoolDomain()

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

getAuthenticationRequestExtraParams

@Stability(value=Stable)
 @Nullable
default Map<String,String> getAuthenticationRequestExtraParams()

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

Default: - No extra parameters

getOnUnauthenticatedRequest

@Stability(value=Stable)
 @Nullable
default UnauthenticatedAction getOnUnauthenticatedRequest()

The behavior if the user is not authenticated.

Default: UnauthenticatedAction.AUTHENTICATE

getScope

@Stability(value=Stable)
 @Nullable
default String getScope()

The set of user claims to be requested from the IdP.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

Default: "openid"

getSessionCookieName

@Stability(value=Stable)
 @Nullable
default String getSessionCookieName()

The name of the cookie used to maintain session information.

Default: "AWSELBAuthSessionCookie"

getSessionTimeout

@Stability(value=Stable)
 @Nullable
default Duration getSessionTimeout()

The maximum duration of the authentication session.

Default: Duration.days(7)

builder

@Stability(value=Stable)
static AuthenticateCognitoActionProps.Builder builder()

Returns:

a AuthenticateCognitoActionProps.Builder of AuthenticateCognitoActionProps