Interface Action.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Action.Builder,
,Action> SdkBuilder<Action.Builder,
,Action> SdkPojo
- Enclosing class:
Action
-
Method Summary
Modifier and TypeMethodDescriptiondefault Action.Builder
authenticateCognitoConfig
(Consumer<AuthenticateCognitoActionConfig.Builder> authenticateCognitoConfig) [HTTPS listeners] Information for using Amazon Cognito to authenticate users.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).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.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 one or more target groups.forwardConfig
(ForwardActionConfig forwardConfig) Information for creating an action that distributes requests among one or more target groups.The order for the action.default Action.Builder
redirectConfig
(Consumer<RedirectActionConfig.Builder> redirectConfig) [Application Load Balancer] Information for creating a redirect action.redirectConfig
(RedirectActionConfig redirectConfig) [Application Load Balancer] Information for creating a redirect action.targetGroupArn
(String targetGroupArn) The Amazon Resource Name (ARN) of the target group.The type of action.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, sdkFields
-
Method Details
-
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:
-
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:
-
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.- Parameters:
targetGroupArn
- The Amazon Resource Name (ARN) of the target group. Specify only whenType
isforward
and you want to route to a single target group. To route to one or more target groups, useForwardConfig
instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticateOidcConfig
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when
Type
isauthenticate-oidc
.- Parameters:
authenticateOidcConfig
- [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only whenType
isauthenticate-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
This is a convenience method that creates an instance of theType
isauthenticate-oidc
.AuthenticateOidcActionConfig.Builder
avoiding the need to create one manually viaAuthenticateOidcActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauthenticateOidcConfig(AuthenticateOidcActionConfig)
.- Parameters:
authenticateOidcConfig
- a consumer that will call methods onAuthenticateOidcActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authenticateCognitoConfig
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Type
isauthenticate-cognito
.- Parameters:
authenticateCognitoConfig
- [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only whenType
isauthenticate-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
This is a convenience method that creates an instance of theType
isauthenticate-cognito
.AuthenticateCognitoActionConfig.Builder
avoiding the need to create one manually viaAuthenticateCognitoActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauthenticateCognitoConfig(AuthenticateCognitoActionConfig)
.- Parameters:
authenticateCognitoConfig
- a consumer that will call methods onAuthenticateCognitoActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
[Application Load Balancer] Information for creating a redirect action. Specify only when
Type
isredirect
.- Parameters:
redirectConfig
- [Application Load Balancer] Information for creating a redirect action. Specify only whenType
isredirect
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
redirectConfig
[Application Load Balancer] Information for creating a redirect action. Specify only when
This is a convenience method that creates an instance of theType
isredirect
.RedirectActionConfig.Builder
avoiding the need to create one manually viaRedirectActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toredirectConfig(RedirectActionConfig)
.- Parameters:
redirectConfig
- a consumer that will call methods onRedirectActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fixedResponseConfig
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when
Type
isfixed-response
.- Parameters:
fixedResponseConfig
- [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only whenType
isfixed-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
This is a convenience method that creates an instance of theType
isfixed-response
.FixedResponseActionConfig.Builder
avoiding the need to create one manually viaFixedResponseActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofixedResponseConfig(FixedResponseActionConfig)
.- Parameters:
fixedResponseConfig
- a consumer that will call methods onFixedResponseActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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 whenType
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theType
isforward
. If you specify bothForwardConfig
andTargetGroupArn
, you can specify only one target group usingForwardConfig
and it must be the same target group specified inTargetGroupArn
.ForwardActionConfig.Builder
avoiding the need to create one manually viaForwardActionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toforwardConfig(ForwardActionConfig)
.- Parameters:
forwardConfig
- a consumer that will call methods onForwardActionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-