AuthenticateCognitoActionConfig

public struct AuthenticateCognitoActionConfig : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let authenticationRequestExtraParams: [String : String]?

  • 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.

    Declaration

    Swift

    public let onUnauthenticatedRequest: AuthenticateCognitoActionConditionalBehaviorEnum?

  • 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.

    Declaration

    Swift

    public let scope: String?

  • The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

    Declaration

    Swift

    public let sessionCookieName: String?

  • The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

    Declaration

    Swift

    public let sessionTimeout: Int64?

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

    Declaration

    Swift

    public let userPoolArn: String

  • The ID of the Amazon Cognito user pool client.

    Declaration

    Swift

    public let userPoolClientId: String

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

    Declaration

    Swift

    public let userPoolDomain: String

  • Undocumented

    Declaration

    Swift

    public init(authenticationRequestExtraParams: [String : String]? = nil, onUnauthenticatedRequest: AuthenticateCognitoActionConditionalBehaviorEnum? = nil, scope: String? = nil, sessionCookieName: String? = nil, sessionTimeout: Int64? = nil, userPoolArn: String, userPoolClientId: String, userPoolDomain: String)