AWSElasticLoadBalancingAuthenticateCognitoActionConfig

Objective-C

@interface AWSElasticLoadBalancingAuthenticateCognitoActionConfig

Swift

class AWSElasticLoadBalancingAuthenticateCognitoActionConfig

Request parameters to use when integrating with Amazon Cognito to authenticate users.

Required parameters: [UserPoolArn, UserPoolClientId, UserPoolDomain]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable authenticationRequestExtraParams;

    Swift

    var authenticationRequestExtraParams: [String : String]? { get set }

  • 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

    Objective-C

    @property (nonatomic) AWSElasticLoadBalancingAuthenticateCognitoActionConditionalBehaviorEnum onUnauthenticatedRequest;

    Swift

    var onUnauthenticatedRequest: AWSElasticLoadBalancingAuthenticateCognitoActionConditionalBehaviorEnum { get set }

  • 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable scope;

    Swift

    var scope: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sessionCookieName;

    Swift

    var sessionCookieName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable sessionTimeout;

    Swift

    var sessionTimeout: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolArn;

    Swift

    var userPoolArn: String? { get set }

  • The ID of the Amazon Cognito user pool client.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolClientId;

    Swift

    var userPoolClientId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolDomain;

    Swift

    var userPoolDomain: String? { get set }