Class Action

java.lang.Object
software.amazon.awssdk.services.elasticloadbalancingv2.model.Action
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Action.Builder,Action>
@Generated("software.amazon.awssdk:codegen") public final class Action extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Action.Builder,Action>

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.

See Also:

  • Method Details

    • type

      public final ActionTypeEnum type()

      The type of action.

      If the service returns an enum value that is not available in the current SDK version, type will return ActionTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of action.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of action.

      If the service returns an enum value that is not available in the current SDK version, type will return ActionTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of action.
      See Also:

    • targetGroupArn

      public final String 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 multiple target groups, you must use ForwardConfig instead.

      Returns:
      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 multiple target groups, you must use ForwardConfig instead.

    • authenticateOidcConfig

      public final AuthenticateOidcActionConfig authenticateOidcConfig()

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

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

    • authenticateCognitoConfig

      public final AuthenticateCognitoActionConfig authenticateCognitoConfig()

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

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

    • order

      public final Integer 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

      public final RedirectActionConfig redirectConfig()

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

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

    • fixedResponseConfig

      public final FixedResponseActionConfig fixedResponseConfig()

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

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

    • forwardConfig

      public final ForwardActionConfig forwardConfig()

      Information for creating an action that distributes requests among multiple target groups. 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.

      Returns:
      Information for creating an action that distributes requests among multiple target groups. 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.

    • jwtValidationConfig

      public final JwtValidationActionConfig jwtValidationConfig()

      [HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when Type is jwt-validation.

      Returns:
      [HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when Type is jwt-validation.

    • toBuilder

      public Action.Builder 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 interface ToCopyableBuilder<Action.Builder,Action>
      Returns:
      a builder for type T

    • builder

      public static Action.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Action.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.