Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListener.AuthenticateCognitoConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListener.AuthenticateCognitoConfigProperty.Jsii$Proxy

Enclosing class:

CfnListener

@Stability(Stable)
public static interface CfnListener.AuthenticateCognitoConfigProperty
extends software.amazon.jsii.JsiiSerializable

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("sessionTimeout")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnListener.AuthenticateCognitoConfigProperty.Builder	builder()
default Object	getAuthenticationRequestExtraParams()	The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
default String	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 String	getSessionTimeout()	The maximum duration of the authentication session, in seconds.
String	getUserPoolArn()	The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
String	getUserPoolClientId()	The ID of the Amazon Cognito user pool client.
String	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 Details

getUserPoolArn

@Stability(Stable)
@NotNull
String getUserPoolArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn

getUserPoolClientId

@Stability(Stable)
@NotNull
String getUserPoolClientId()

The ID of the Amazon Cognito user pool client.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid

getUserPoolDomain

@Stability(Stable)
@NotNull
String getUserPoolDomain()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain

getAuthenticationRequestExtraParams

@Stability(Stable)
@Nullable
default Object getAuthenticationRequestExtraParams()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams

getOnUnauthenticatedRequest

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest

getScope

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope

getSessionCookieName

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

The name of the cookie used to maintain session information.

The default is AWSELBAuthSessionCookie.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename

getSessionTimeout

@Stability(Stable)
@Nullable
default String getSessionTimeout()

The maximum duration of the authentication session, in seconds.

The default is 604800 seconds (7 days).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout

builder

@Stability(Stable)
static CfnListener.AuthenticateCognitoConfigProperty.Builder builder()

Returns:

a CfnListener.AuthenticateCognitoConfigProperty.Builder of CfnListener.AuthenticateCognitoConfigProperty