Class AuthenticateCognitoActionConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AuthenticateCognitoActionConfig.Builder,
AuthenticateCognitoActionConfig>
Request parameters to use when integrating with Amazon Cognito to authenticate users.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe query parameters (up to 10) to include in the redirect request to the authorization endpoint.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams property.final int
hashCode()
The behavior if the user is not authenticated.final String
The behavior if the user is not authenticated.final String
scope()
The set of user claims to be requested from the IdP.static Class
<? extends AuthenticateCognitoActionConfig.Builder> final String
The name of the cookie used to maintain session information.final Long
The maximum duration of the authentication session, in seconds.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.final String
The ID of the Amazon Cognito user pool client.final String
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolArn
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
-
userPoolClientId
The ID of the Amazon Cognito user pool client.
- Returns:
- The ID of the Amazon Cognito user pool client.
-
userPoolDomain
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
- Returns:
- The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
-
sessionCookieName
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
- Returns:
- The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
-
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.
- Returns:
- 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.
-
sessionTimeout
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
- Returns:
- The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
-
hasAuthenticationRequestExtraParams
public final boolean hasAuthenticationRequestExtraParams()For responses, this returns true if the service returned a value for the AuthenticationRequestExtraParams property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAuthenticationRequestExtraParams()
method.- Returns:
- The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
-
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 returnAuthenticateCognitoActionConditionalBehaviorEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonUnauthenticatedRequestAsString()
.- Returns:
- 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:
-
-
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 returnAuthenticateCognitoActionConditionalBehaviorEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromonUnauthenticatedRequestAsString()
.- Returns:
- 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:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AuthenticateCognitoActionConfig.Builder,
AuthenticateCognitoActionConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-