@Stability(value=Stable)
public static interface CfnListenerRule.AuthenticateCognitoConfigProperty
extends software.amazon.jsii.JsiiSerializable
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();
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 |
Modifier and Type | Method and Description |
---|---|
static CfnListenerRule.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 Number |
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.
|
@Stability(value=Stable) @NotNull String getUserPoolArn()
@Stability(value=Stable) @NotNull String getUserPoolClientId()
@Stability(value=Stable) @NotNull String getUserPoolDomain()
@Stability(value=Stable) @Nullable default Object getAuthenticationRequestExtraParams()
@Stability(value=Stable) @Nullable default String getOnUnauthenticatedRequest()
@Stability(value=Stable) @Nullable default String getScope()
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
@Stability(value=Stable) @Nullable default String getSessionCookieName()
The default is AWSELBAuthSessionCookie.
@Stability(value=Stable) @Nullable default Number getSessionTimeout()
The default is 604800 seconds (7 days).
@Stability(value=Stable) static CfnListenerRule.AuthenticateCognitoConfigProperty.Builder builder()
Copyright © 2023. All rights reserved.