Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ELBV2.Types.Action

Description

Synopsis

data Action = Action' {
}
newAction :: ActionTypeEnum -> Action
action_fixedResponseConfig :: Lens' Action (Maybe FixedResponseActionConfig)
action_targetGroupArn :: Lens' Action (Maybe Text)
action_forwardConfig :: Lens' Action (Maybe ForwardActionConfig)
action_redirectConfig :: Lens' Action (Maybe RedirectActionConfig)
action_authenticateCognitoConfig :: Lens' Action (Maybe AuthenticateCognitoActionConfig)
action_order :: Lens' Action (Maybe Natural)
action_authenticateOidcConfig :: Lens' Action (Maybe AuthenticateOidcActionConfig)
action_type :: Lens' Action ActionTypeEnum

Documentation

data Action Source #

Information about an action.

Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed.

See: newAction smart constructor.

Constructors

Action'

Fields

fixedResponseConfig :: Maybe FixedResponseActionConfig
Application Load Balancer
Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
targetGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
forwardConfig :: Maybe ForwardActionConfig
Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.
redirectConfig :: Maybe RedirectActionConfig
Application Load Balancer
Information for creating a redirect action. Specify only when Type is redirect.
authenticateCognitoConfig :: Maybe AuthenticateCognitoActionConfig
HTTPS listeners
Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
order :: Maybe Natural
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
authenticateOidcConfig :: Maybe AuthenticateOidcActionConfig
HTTPS listeners
Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
type' :: ActionTypeEnum
The type of action.

Instances

Instances details

Eq Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Read Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods readsPrec :: Int -> ReadS Action # readList :: ReadS [Action] # readPrec :: ReadPrec Action # readListPrec :: ReadPrec [Action] #
Show Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
Generic Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Associated Types type Rep Action :: Type -> Type # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
NFData Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods rnf :: Action -> () #
Hashable Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods hashWithSalt :: Int -> Action -> Int # hash :: Action -> Int #
ToQuery Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods toQuery :: Action -> QueryString #
FromXML Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action Methods parseXML :: [Node] -> Either String Action #
type Rep Action Source #
Instance details Defined in Amazonka.ELBV2.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.ELBV2.Types.Action" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "fixedResponseConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FixedResponseActionConfig)) :: S1 ('MetaSel ('Just "targetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "forwardConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ForwardActionConfig)) :: S1 ('MetaSel ('Just "redirectConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedirectActionConfig)))) :: ((S1 ('MetaSel ('Just "authenticateCognitoConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticateCognitoActionConfig)) :: S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "authenticateOidcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticateOidcActionConfig)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActionTypeEnum)))))

newAction Source #

Arguments

:: ActionTypeEnum	`$sel:type':Action'`
-> Action

Create a value of Action with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fixedResponseConfig:Action', action_fixedResponseConfig - [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

$sel:targetGroupArn:Action', action_targetGroupArn - The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

$sel:forwardConfig:Action', action_forwardConfig - Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

$sel:redirectConfig:Action', action_redirectConfig - [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

$sel:authenticateCognitoConfig:Action', action_authenticateCognitoConfig - [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

$sel:order:Action', action_order - The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

$sel:authenticateOidcConfig:Action', action_authenticateOidcConfig - [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

$sel:type':Action', action_type - The type of action.

action_fixedResponseConfig :: Lens' Action (Maybe FixedResponseActionConfig) Source #

Application Load Balancer: Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

action_targetGroupArn :: Lens' Action (Maybe Text) Source #

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

action_forwardConfig :: Lens' Action (Maybe ForwardActionConfig) Source #

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

action_redirectConfig :: Lens' Action (Maybe RedirectActionConfig) Source #

Application Load Balancer: Information for creating a redirect action. Specify only when Type is redirect.

action_authenticateCognitoConfig :: Lens' Action (Maybe AuthenticateCognitoActionConfig) Source #

HTTPS listeners: Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

action_order :: Lens' Action (Maybe Natural) Source #

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

action_authenticateOidcConfig :: Lens' Action (Maybe AuthenticateOidcActionConfig) Source #

HTTPS listeners: Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

action_type :: Lens' Action ActionTypeEnum Source #

The type of action.