software.amazon.awssdk.services.elasticloadbalancingv2.model

Class Action

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.model.Action

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Action.Builder,Action>

@Generated(value="software.amazon.awssdk:codegen")
public final class Action
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Action.Builder,Action>

Information about an action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Action.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticateCognitoActionConfig	authenticateCognitoConfig() [HTTPS listener] Information for using Amazon Cognito to authenticate users.
AuthenticateOidcActionConfig	authenticateOidcConfig() [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC).
static Action.Builder	builder()
boolean	equals(Object obj)
FixedResponseActionConfig	fixedResponseConfig() [Application Load Balancer] Information for creating an action that returns a custom HTTP response.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	order() The order for the action.
RedirectActionConfig	redirectConfig() [Application Load Balancer] Information for creating a redirect action.
List<SdkField<?>>	sdkFields()
static Class<? extends Action.Builder>	serializableBuilderClass()
String	targetGroupArn() The Amazon Resource Name (ARN) of the target group.
Action.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
ActionTypeEnum	type() The type of action.
String	typeAsString() The type of action.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public ActionTypeEnum type()

The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

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. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

See Also:

ActionTypeEnum

typeAsString

public String typeAsString()

The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

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. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

See Also:

ActionTypeEnum

targetGroupArn

public String targetGroupArn()

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

Returns:

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

authenticateOidcConfig

public AuthenticateOidcActionConfig authenticateOidcConfig()

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

Returns:

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

authenticateCognitoConfig

public AuthenticateCognitoActionConfig authenticateCognitoConfig()

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

Returns:

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

order

public 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. The final action to be performed must be a forward or a fixed-response action.

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. The final action to be performed must be a forward or a fixed-response action.

redirectConfig

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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