@Generated(value="software.amazon.awssdk:codegen") public final class AuthenticateCognitoActionConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AuthenticateCognitoActionConfig.Builder,AuthenticateCognitoActionConfig>
Request parameters to use when integrating with Amazon Cognito to authenticate users.
Modifier and Type | Class and Description |
---|---|
static interface |
AuthenticateCognitoActionConfig.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
authenticationRequestExtraParams()
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
|
static AuthenticateCognitoActionConfig.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAuthenticationRequestExtraParams()
Returns true if the AuthenticationRequestExtraParams property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
AuthenticateCognitoActionConditionalBehaviorEnum |
onUnauthenticatedRequest()
The behavior if the user is not authenticated.
|
String |
onUnauthenticatedRequestAsString()
The behavior if the user is not authenticated.
|
String |
scope()
The set of user claims to be requested from the IdP.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AuthenticateCognitoActionConfig.Builder> |
serializableBuilderClass() |
String |
sessionCookieName()
The name of the cookie used to maintain session information.
|
Long |
sessionTimeout()
The maximum duration of the authentication session, in seconds.
|
AuthenticateCognitoActionConfig.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
userPoolArn()
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
|
String |
userPoolClientId()
The ID of the Amazon Cognito user pool client.
|
String |
userPoolDomain()
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
|
copy
public final String userPoolArn()
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
public final String userPoolClientId()
The ID of the Amazon Cognito user pool client.
public final String userPoolDomain()
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
public final String sessionCookieName()
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
public final String scope()
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.
openid
.
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
public final Long sessionTimeout()
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
public final boolean hasAuthenticationRequestExtraParams()
public final Map<String,String> authenticationRequestExtraParams()
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAuthenticationRequestExtraParams()
to see if a value was sent in this field.
public final AuthenticateCognitoActionConditionalBehaviorEnum onUnauthenticatedRequest()
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.
If the service returns an enum value that is not available in the current SDK version,
onUnauthenticatedRequest
will return
AuthenticateCognitoActionConditionalBehaviorEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from onUnauthenticatedRequestAsString()
.
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.
AuthenticateCognitoActionConditionalBehaviorEnum
public final String onUnauthenticatedRequestAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
onUnauthenticatedRequest
will return
AuthenticateCognitoActionConditionalBehaviorEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from onUnauthenticatedRequestAsString()
.
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.
AuthenticateCognitoActionConditionalBehaviorEnum
public AuthenticateCognitoActionConfig.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AuthenticateCognitoActionConfig.Builder,AuthenticateCognitoActionConfig>
public static AuthenticateCognitoActionConfig.Builder builder()
public static Class<? extends AuthenticateCognitoActionConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.