/AWS1/CL_EL2ACTION¶
Information about an action.
Each rule must include exactly one of the following routing actions: forward,
fixed-response, or redirect, and it must be the last
action to be performed.
Optionally, a rule for an HTTPS listener can also include one of the following
user authentication actions: authenticate-oidc,
authenticate-cognito, or jwt-validation.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_type TYPE /AWS1/EL2ACTIONTYPEENUM /AWS1/EL2ACTIONTYPEENUM¶
The type of action.
Optional arguments:¶
iv_targetgrouparn TYPE /AWS1/EL2TARGETGROUPARN /AWS1/EL2TARGETGROUPARN¶
The Amazon Resource Name (ARN) of the target group. Specify only when
Typeisforwardand you want to route to a single target group. To route to multiple target groups, you must useForwardConfiginstead.
io_authenticateoidcconfig TYPE REF TO /AWS1/CL_EL2AUTHNTCTOIDCACTCFG /AWS1/CL_EL2AUTHNTCTOIDCACTCFG¶
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when
Typeisauthenticate-oidc.
io_authenticatecognitoconfig TYPE REF TO /AWS1/CL_EL2AUTHNCOGNITOACTCFG /AWS1/CL_EL2AUTHNCOGNITOACTCFG¶
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Typeisauthenticate-cognito.
iv_order TYPE /AWS1/EL2ACTIONORDER /AWS1/EL2ACTIONORDER¶
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.
io_redirectconfig TYPE REF TO /AWS1/CL_EL2REDIRACTIONCONFIG /AWS1/CL_EL2REDIRACTIONCONFIG¶
[Application Load Balancer] Information for creating a redirect action. Specify only when
Typeisredirect.
io_fixedresponseconfig TYPE REF TO /AWS1/CL_EL2FIXEDRSPACTIONCFG /AWS1/CL_EL2FIXEDRSPACTIONCFG¶
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when
Typeisfixed-response.
io_forwardconfig TYPE REF TO /AWS1/CL_EL2FORWARDACTIONCFG /AWS1/CL_EL2FORWARDACTIONCFG¶
Information for creating an action that distributes requests among multiple target groups. Specify only when
Typeisforward.If you specify both
ForwardConfigandTargetGroupArn, you can specify only one target group usingForwardConfigand it must be the same target group specified inTargetGroupArn.
io_jwtvalidationconfig TYPE REF TO /AWS1/CL_EL2JWTVALIDATIONACT00 /AWS1/CL_EL2JWTVALIDATIONACT00¶
[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when
Typeisjwt-validation.
Queryable Attributes¶
Type¶
The type of action.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
TargetGroupArn¶
The Amazon Resource Name (ARN) of the target group. Specify only when
Typeisforwardand you want to route to a single target group. To route to multiple target groups, you must useForwardConfiginstead.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETGROUPARN() |
Getter for TARGETGROUPARN, with configurable default |
ASK_TARGETGROUPARN() |
Getter for TARGETGROUPARN w/ exceptions if field has no valu |
HAS_TARGETGROUPARN() |
Determine if TARGETGROUPARN has a value |
AuthenticateOidcConfig¶
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when
Typeisauthenticate-oidc.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHENTICATEOIDCCONFIG() |
Getter for AUTHENTICATEOIDCCONFIG |
AuthenticateCognitoConfig¶
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Typeisauthenticate-cognito.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHNTCTCOGNITOCONFIG() |
Getter for AUTHENTICATECOGNITOCONFIG |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORDER() |
Getter for ORDER, with configurable default |
ASK_ORDER() |
Getter for ORDER w/ exceptions if field has no value |
HAS_ORDER() |
Determine if ORDER has a value |
RedirectConfig¶
[Application Load Balancer] Information for creating a redirect action. Specify only when
Typeisredirect.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REDIRECTCONFIG() |
Getter for REDIRECTCONFIG |
FixedResponseConfig¶
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when
Typeisfixed-response.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FIXEDRESPONSECONFIG() |
Getter for FIXEDRESPONSECONFIG |
ForwardConfig¶
Information for creating an action that distributes requests among multiple target groups. Specify only when
Typeisforward.If you specify both
ForwardConfigandTargetGroupArn, you can specify only one target group usingForwardConfigand it must be the same target group specified inTargetGroupArn.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORWARDCONFIG() |
Getter for FORWARDCONFIG |
JwtValidationConfig¶
[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when
Typeisjwt-validation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JWTVALIDATIONCONFIG() |
Getter for JWTVALIDATIONCONFIG |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_ACTIONS¶
TYPES TT_ACTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_EL2ACTION WITH DEFAULT KEY
.