Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig

Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig

SYNOPSIS

Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users.

SYNTAX

Add-VSElasticLoadBalancingV2ListenerAuthenticateCognitoConfig [[-AuthenticationRequestExtraParams] <Hashtable>]
 [[-OnUnauthenticatedRequest] <Object>] [[-Scope] <Object>] [[-SessionCookieName] <Object>]
 [[-SessionTimeout] <Object>] [-UserPoolArn] <Object> [-UserPoolClientId] <Object> [-UserPoolDomain] <Object>
 [<CommonParameters>]

DESCRIPTION

Adds an AWS::ElasticLoadBalancingV2::Listener.AuthenticateCognitoConfig resource property to the template. Specifies information required when integrating with Amazon Cognito to authenticate users.

EXAMPLES

Example 1

PS C:\> 

PARAMETERS

-AuthenticationRequestExtraParams

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams DuplicatesAllowed: False PrimitiveItemType: String Type: Map UpdateType: Mutable

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SessionCookieName

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SessionTimeout

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout PrimitiveType: Long UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserPoolArn

The Amazon Resource Name ARN of the Amazon Cognito user pool.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserPoolClientId

The ID of the Amazon Cognito user pool client.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserPoolDomain

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Vaporshell.Resource.ElasticLoadBalancingV2.Listener.AuthenticateCognitoConfig

NOTES

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html