Class CfnListener.ActionProperty.Builder
java.lang.Object
software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.ActionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnListener.ActionProperty>
- Enclosing interface:
CfnListener.ActionProperty
@Stability(Stable)
public static final class CfnListener.ActionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnListener.ActionProperty>
A builder for
CfnListener.ActionProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthenticateCognitoConfig
(IResolvable authenticateCognitoConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateCognitoConfig()
authenticateCognitoConfig
(CfnListener.AuthenticateCognitoConfigProperty authenticateCognitoConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateCognitoConfig()
authenticateOidcConfig
(IResolvable authenticateOidcConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateOidcConfig()
authenticateOidcConfig
(CfnListener.AuthenticateOidcConfigProperty authenticateOidcConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateOidcConfig()
build()
Builds the configured instance.fixedResponseConfig
(IResolvable fixedResponseConfig) Sets the value ofCfnListener.ActionProperty.getFixedResponseConfig()
fixedResponseConfig
(CfnListener.FixedResponseConfigProperty fixedResponseConfig) Sets the value ofCfnListener.ActionProperty.getFixedResponseConfig()
forwardConfig
(IResolvable forwardConfig) Sets the value ofCfnListener.ActionProperty.getForwardConfig()
forwardConfig
(CfnListener.ForwardConfigProperty forwardConfig) Sets the value ofCfnListener.ActionProperty.getForwardConfig()
Sets the value ofCfnListener.ActionProperty.getOrder()
redirectConfig
(IResolvable redirectConfig) Sets the value ofCfnListener.ActionProperty.getRedirectConfig()
redirectConfig
(CfnListener.RedirectConfigProperty redirectConfig) Sets the value ofCfnListener.ActionProperty.getRedirectConfig()
targetGroupArn
(String targetGroupArn) Sets the value ofCfnListener.ActionProperty.getTargetGroupArn()
Sets the value ofCfnListener.ActionProperty.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
type
Sets the value ofCfnListener.ActionProperty.getType()
- Parameters:
type
- The type of action. This parameter is required.- Returns:
this
-
authenticateCognitoConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder authenticateCognitoConfig(IResolvable authenticateCognitoConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateCognitoConfig()
- Parameters:
authenticateCognitoConfig
- [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only whenType
isauthenticate-cognito
.- Returns:
this
-
authenticateCognitoConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder authenticateCognitoConfig(CfnListener.AuthenticateCognitoConfigProperty authenticateCognitoConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateCognitoConfig()
- Parameters:
authenticateCognitoConfig
- [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only whenType
isauthenticate-cognito
.- Returns:
this
-
authenticateOidcConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder authenticateOidcConfig(IResolvable authenticateOidcConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateOidcConfig()
- Parameters:
authenticateOidcConfig
- [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only whenType
isauthenticate-oidc
.- Returns:
this
-
authenticateOidcConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder authenticateOidcConfig(CfnListener.AuthenticateOidcConfigProperty authenticateOidcConfig) Sets the value ofCfnListener.ActionProperty.getAuthenticateOidcConfig()
- Parameters:
authenticateOidcConfig
- [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only whenType
isauthenticate-oidc
.- Returns:
this
-
fixedResponseConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder fixedResponseConfig(IResolvable fixedResponseConfig) Sets the value ofCfnListener.ActionProperty.getFixedResponseConfig()
- Parameters:
fixedResponseConfig
- [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only whenType
isfixed-response
.- Returns:
this
-
fixedResponseConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder fixedResponseConfig(CfnListener.FixedResponseConfigProperty fixedResponseConfig) Sets the value ofCfnListener.ActionProperty.getFixedResponseConfig()
- Parameters:
fixedResponseConfig
- [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only whenType
isfixed-response
.- Returns:
this
-
forwardConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder forwardConfig(IResolvable forwardConfig) Sets the value ofCfnListener.ActionProperty.getForwardConfig()
- 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:
this
-
forwardConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder forwardConfig(CfnListener.ForwardConfigProperty forwardConfig) Sets the value ofCfnListener.ActionProperty.getForwardConfig()
- 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:
this
-
order
Sets the value ofCfnListener.ActionProperty.getOrder()
- 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:
this
-
redirectConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder redirectConfig(IResolvable redirectConfig) Sets the value ofCfnListener.ActionProperty.getRedirectConfig()
- Parameters:
redirectConfig
- [Application Load Balancer] Information for creating a redirect action. Specify only whenType
isredirect
.- Returns:
this
-
redirectConfig
@Stability(Stable) public CfnListener.ActionProperty.Builder redirectConfig(CfnListener.RedirectConfigProperty redirectConfig) Sets the value ofCfnListener.ActionProperty.getRedirectConfig()
- Parameters:
redirectConfig
- [Application Load Balancer] Information for creating a redirect action. Specify only whenType
isredirect
.- Returns:
this
-
targetGroupArn
Sets the value ofCfnListener.ActionProperty.getTargetGroupArn()
- 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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnListener.ActionProperty>
- Returns:
- a new instance of
CfnListener.ActionProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-