software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerRule.AuthenticateCognitoConfigProperty

All Known Implementing Classes:

CfnListenerRule.AuthenticateCognitoConfigProperty.Jsii$Proxy

Enclosing class:

CfnListenerRule

public static interface CfnListenerRule.AuthenticateCognitoConfigProperty

Specifies information required when integrating with Amazon Cognito to authenticate users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 AuthenticateCognitoConfigProperty authenticateCognitoConfigProperty = AuthenticateCognitoConfigProperty.builder()
         .userPoolArn("userPoolArn")
         .userPoolClientId("userPoolClientId")
         .userPoolDomain("userPoolDomain")
         // the properties below are optional
         .authenticationRequestExtraParams(Map.of(
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
         .onUnauthenticatedRequest("onUnauthenticatedRequest")
         .scope("scope")
         .sessionCookieName("sessionCookieName")
         .sessionTimeout(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	builder()
default java.lang.Object	getAuthenticationRequestExtraParams() The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
default java.lang.String	getOnUnauthenticatedRequest() The behavior if the user is not authenticated.
default java.lang.String	getScope() The set of user claims to be requested from the IdP.
default java.lang.String	getSessionCookieName() The name of the cookie used to maintain session information.
default java.lang.Number	getSessionTimeout() The maximum duration of the authentication session, in seconds.
java.lang.String	getUserPoolArn() The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
java.lang.String	getUserPoolClientId() The ID of the Amazon Cognito user pool client.
java.lang.String	getUserPoolDomain() The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Method Detail

getUserPoolArn

java.lang.String getUserPoolArn()

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

getUserPoolClientId

java.lang.String getUserPoolClientId()

The ID of the Amazon Cognito user pool client.

getUserPoolDomain

java.lang.String getUserPoolDomain()

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

getAuthenticationRequestExtraParams

default java.lang.Object getAuthenticationRequestExtraParams()

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

getOnUnauthenticatedRequest

default java.lang.String getOnUnauthenticatedRequest()

The behavior if the user is not authenticated. The following are possible values:.

• deny `` - Return an HTTP 401 Unauthorized error.
• allow `` - Allow the request to be forwarded to the target.
• authenticate `` - Redirect the request to the IdP authorization endpoint. This is the default value.

getScope

default java.lang.String getScope()

The set of user claims to be requested from the IdP. The default is `openid` .

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

getSessionCookieName

default java.lang.String getSessionCookieName()

The name of the cookie used to maintain session information.

The default is AWSELBAuthSessionCookie.

getSessionTimeout

default java.lang.Number getSessionTimeout()

The maximum duration of the authentication session, in seconds.

The default is 604800 seconds (7 days).

builder

static CfnListenerRule.AuthenticateCognitoConfigProperty.Builder builder()

Returns:

a CfnListenerRule.AuthenticateCognitoConfigProperty.Builder of CfnListenerRule.AuthenticateCognitoConfigProperty