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();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnListener.AuthenticateCognitoConfigProperty
static final class
An implementation forCfnListener.AuthenticateCognitoConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.default String
The behavior if the user is not authenticated.default String
getScope()
The set of user claims to be requested from the IdP.default String
The name of the cookie used to maintain session information.default String
The maximum duration of the authentication session, in seconds.The Amazon Resource Name (ARN) of the Amazon Cognito user pool.The ID of the Amazon Cognito user pool client.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
The Amazon Resource Name (ARN) of the Amazon Cognito user pool. -
getUserPoolClientId
The ID of the Amazon Cognito user pool client. -
getUserPoolDomain
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. -
getAuthenticationRequestExtraParams
The query parameters (up to 10) to include in the redirect request to the authorization endpoint. -
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
The set of user claims to be requested from the IdP. The default isopenid
.To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
-
getSessionCookieName
The name of the cookie used to maintain session information.The default is AWSELBAuthSessionCookie.
-
getSessionTimeout
The maximum duration of the authentication session, in seconds.The default is 604800 seconds (7 days).
-
builder
-