Interface Action.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Action.Builder,Action>, SdkBuilder<Action.Builder,Action>, SdkPojo

Enclosing class:

Action

@Mutable
@NotThreadSafe
public static interface Action.Builder
extends SdkPojo, CopyableBuilder<Action.Builder,Action>

Method Summary

Modifier and Type	Method	Description
default Action.Builder	authenticateCognitoConfig(Consumer<AuthenticateCognitoActionConfig.Builder> authenticateCognitoConfig)	[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
Action.Builder	authenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)	[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
default Action.Builder	authenticateOidcConfig(Consumer<AuthenticateOidcActionConfig.Builder> authenticateOidcConfig)	[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
Action.Builder	authenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)	[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
default Action.Builder	fixedResponseConfig(Consumer<FixedResponseActionConfig.Builder> fixedResponseConfig)	[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
Action.Builder	fixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)	[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
default Action.Builder	forwardConfig(Consumer<ForwardActionConfig.Builder> forwardConfig)	Information for creating an action that distributes requests among multiple target groups.
Action.Builder	forwardConfig(ForwardActionConfig forwardConfig)	Information for creating an action that distributes requests among multiple target groups.
default Action.Builder	jwtValidationConfig(Consumer<JwtValidationActionConfig.Builder> jwtValidationConfig)	[HTTPS listeners] Information for validating JWT access tokens in client requests.
Action.Builder	jwtValidationConfig(JwtValidationActionConfig jwtValidationConfig)	[HTTPS listeners] Information for validating JWT access tokens in client requests.
Action.Builder	order(Integer order)	The order for the action.
default Action.Builder	redirectConfig(Consumer<RedirectActionConfig.Builder> redirectConfig)	[Application Load Balancer] Information for creating a redirect action.
Action.Builder	redirectConfig(RedirectActionConfig redirectConfig)	[Application Load Balancer] Information for creating a redirect action.
Action.Builder	targetGroupArn(String targetGroupArn)	The Amazon Resource Name (ARN) of the target group.
Action.Builder	type(String type)	The type of action.
Action.Builder	type(ActionTypeEnum type)	The type of action.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

type

Action.Builder type(String type)

The type of action.

Parameters:

type - The type of action.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ActionTypeEnum
• ActionTypeEnum

type

Action.Builder type(ActionTypeEnum type)

The type of action.

Parameters:

type - The type of action.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ActionTypeEnum
• ActionTypeEnum

targetGroupArn

Action.Builder targetGroupArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

authenticateOidcConfig

Action.Builder authenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticateOidcConfig

default Action.Builder authenticateOidcConfig(Consumer<AuthenticateOidcActionConfig.Builder> authenticateOidcConfig)

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

This is a convenience method that creates an instance of the AuthenticateOidcActionConfig.Builder avoiding the need to create one manually via AuthenticateOidcActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticateOidcConfig(AuthenticateOidcActionConfig).

Parameters:

authenticateOidcConfig - a consumer that will call methods on AuthenticateOidcActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• authenticateOidcConfig(AuthenticateOidcActionConfig)

authenticateCognitoConfig

Action.Builder authenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticateCognitoConfig

default Action.Builder authenticateCognitoConfig(Consumer<AuthenticateCognitoActionConfig.Builder> authenticateCognitoConfig)

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

This is a convenience method that creates an instance of the AuthenticateCognitoActionConfig.Builder avoiding the need to create one manually via AuthenticateCognitoActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticateCognitoConfig(AuthenticateCognitoActionConfig).

Parameters:

authenticateCognitoConfig - a consumer that will call methods on AuthenticateCognitoActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• authenticateCognitoConfig(AuthenticateCognitoActionConfig)

order

Action.Builder order(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

redirectConfig

Action.Builder redirectConfig(RedirectActionConfig redirectConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

redirectConfig

default Action.Builder redirectConfig(Consumer<RedirectActionConfig.Builder> redirectConfig)

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

This is a convenience method that creates an instance of the RedirectActionConfig.Builder avoiding the need to create one manually via RedirectActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redirectConfig(RedirectActionConfig).

Parameters:

redirectConfig - a consumer that will call methods on RedirectActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• redirectConfig(RedirectActionConfig)

fixedResponseConfig

Action.Builder fixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

fixedResponseConfig

default Action.Builder fixedResponseConfig(Consumer<FixedResponseActionConfig.Builder> fixedResponseConfig)

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

This is a convenience method that creates an instance of the FixedResponseActionConfig.Builder avoiding the need to create one manually via FixedResponseActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fixedResponseConfig(FixedResponseActionConfig).

Parameters:

fixedResponseConfig - a consumer that will call methods on FixedResponseActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• fixedResponseConfig(FixedResponseActionConfig)

forwardConfig

Action.Builder forwardConfig(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

forwardConfig

default Action.Builder forwardConfig(Consumer<ForwardActionConfig.Builder> 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.

This is a convenience method that creates an instance of the ForwardActionConfig.Builder avoiding the need to create one manually via ForwardActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to forwardConfig(ForwardActionConfig).

Parameters:

forwardConfig - a consumer that will call methods on ForwardActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• forwardConfig(ForwardActionConfig)

jwtValidationConfig

Action.Builder jwtValidationConfig(JwtValidationActionConfig jwtValidationConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

jwtValidationConfig

default Action.Builder jwtValidationConfig(Consumer<JwtValidationActionConfig.Builder> jwtValidationConfig)

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

This is a convenience method that creates an instance of the JwtValidationActionConfig.Builder avoiding the need to create one manually via JwtValidationActionConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jwtValidationConfig(JwtValidationActionConfig).

Parameters:

jwtValidationConfig - a consumer that will call methods on JwtValidationActionConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• jwtValidationConfig(JwtValidationActionConfig)