Class Action
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Action.Builder,
Action>
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 Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescription[HTTPS listeners] Information for using Amazon Cognito to authenticate users.[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).static Action.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.[Application Load Balancer] Information for creating an action that returns a custom HTTP response.final ForwardActionConfig
Information for creating an action that distributes requests among one or more target groups.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
order()
The order for the action.final RedirectActionConfig
[Application Load Balancer] Information for creating a redirect action.static Class
<? extends Action.Builder> final String
The Amazon Resource Name (ARN) of the target group.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ActionTypeEnum
type()
The type of action.final String
The type of action.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of action.
If the service returns an enum value that is not available in the current SDK version,
type
will returnActionTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of action.
- See Also:
-
typeAsString
The type of action.
If the service returns an enum value that is not available in the current SDK version,
type
will returnActionTypeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of action.
- See Also:
-
targetGroupArn
The Amazon Resource Name (ARN) of the target group. Specify only when
Type
isforward
and you want to route to a single target group. To route to one or more target groups, useForwardConfig
instead.- Returns:
- The Amazon Resource Name (ARN) of the target group. Specify only when
Type
isforward
and you want to route to a single target group. To route to one or more target groups, useForwardConfig
instead.
-
authenticateOidcConfig
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when
Type
isauthenticate-oidc
.- Returns:
- [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
Specify only when
Type
isauthenticate-oidc
.
-
authenticateCognitoConfig
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Type
isauthenticate-cognito
.- Returns:
- [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Type
isauthenticate-cognito
.
-
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.
- Returns:
- 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.
-
redirectConfig
[Application Load Balancer] Information for creating a redirect action. Specify only when
Type
isredirect
.- Returns:
- [Application Load Balancer] Information for creating a redirect action. Specify only when
Type
isredirect
.
-
fixedResponseConfig
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when
Type
isfixed-response
.- Returns:
- [Application Load Balancer] Information for creating an action that returns a custom HTTP response.
Specify only when
Type
isfixed-response
.
-
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
isforward
. If you specify bothForwardConfig
andTargetGroupArn
, you can specify only one target group usingForwardConfig
and it must be the same target group specified inTargetGroupArn
.- Returns:
- 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
isforward
. If you specify bothForwardConfig
andTargetGroupArn
, you can specify only one target group usingForwardConfig
and it must be the same target group specified inTargetGroupArn
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Action.Builder,
Action> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-