Package software.amazon.awscdk.services.elasticloadbalancingv2

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnListener.ActionProperty.Builder	authenticateCognitoConfig(IResolvable authenticateCognitoConfig)	Sets the value of CfnListener.ActionProperty.getAuthenticateCognitoConfig()
CfnListener.ActionProperty.Builder	authenticateCognitoConfig(CfnListener.AuthenticateCognitoConfigProperty authenticateCognitoConfig)	Sets the value of CfnListener.ActionProperty.getAuthenticateCognitoConfig()
CfnListener.ActionProperty.Builder	authenticateOidcConfig(IResolvable authenticateOidcConfig)	Sets the value of CfnListener.ActionProperty.getAuthenticateOidcConfig()
CfnListener.ActionProperty.Builder	authenticateOidcConfig(CfnListener.AuthenticateOidcConfigProperty authenticateOidcConfig)	Sets the value of CfnListener.ActionProperty.getAuthenticateOidcConfig()
CfnListener.ActionProperty	build()	Builds the configured instance.
CfnListener.ActionProperty.Builder	fixedResponseConfig(IResolvable fixedResponseConfig)	Sets the value of CfnListener.ActionProperty.getFixedResponseConfig()
CfnListener.ActionProperty.Builder	fixedResponseConfig(CfnListener.FixedResponseConfigProperty fixedResponseConfig)	Sets the value of CfnListener.ActionProperty.getFixedResponseConfig()
CfnListener.ActionProperty.Builder	forwardConfig(IResolvable forwardConfig)	Sets the value of CfnListener.ActionProperty.getForwardConfig()
CfnListener.ActionProperty.Builder	forwardConfig(CfnListener.ForwardConfigProperty forwardConfig)	Sets the value of CfnListener.ActionProperty.getForwardConfig()
CfnListener.ActionProperty.Builder	order(Number order)	Sets the value of CfnListener.ActionProperty.getOrder()
CfnListener.ActionProperty.Builder	redirectConfig(IResolvable redirectConfig)	Sets the value of CfnListener.ActionProperty.getRedirectConfig()
CfnListener.ActionProperty.Builder	redirectConfig(CfnListener.RedirectConfigProperty redirectConfig)	Sets the value of CfnListener.ActionProperty.getRedirectConfig()
CfnListener.ActionProperty.Builder	targetGroupArn(String targetGroupArn)	Sets the value of CfnListener.ActionProperty.getTargetGroupArn()
CfnListener.ActionProperty.Builder	type(String type)	Sets the value of CfnListener.ActionProperty.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

type

@Stability(Stable)
public CfnListener.ActionProperty.Builder type(String type)

Sets the value of CfnListener.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 of CfnListener.ActionProperty.getAuthenticateCognitoConfig()

Parameters:

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

Returns:

this

authenticateCognitoConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder authenticateCognitoConfig(CfnListener.AuthenticateCognitoConfigProperty authenticateCognitoConfig)

Sets the value of CfnListener.ActionProperty.getAuthenticateCognitoConfig()

Parameters:

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

Returns:

this

authenticateOidcConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder authenticateOidcConfig(IResolvable authenticateOidcConfig)

Sets the value of CfnListener.ActionProperty.getAuthenticateOidcConfig()

Parameters:

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

Returns:

this

authenticateOidcConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder authenticateOidcConfig(CfnListener.AuthenticateOidcConfigProperty authenticateOidcConfig)

Sets the value of CfnListener.ActionProperty.getAuthenticateOidcConfig()

Parameters:

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

Returns:

this

fixedResponseConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder fixedResponseConfig(IResolvable fixedResponseConfig)

Sets the value of CfnListener.ActionProperty.getFixedResponseConfig()

Parameters:

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

Returns:

this

fixedResponseConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder fixedResponseConfig(CfnListener.FixedResponseConfigProperty fixedResponseConfig)

Sets the value of CfnListener.ActionProperty.getFixedResponseConfig()

Parameters:

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

Returns:

this

forwardConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder forwardConfig(IResolvable forwardConfig)

Sets the value of CfnListener.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 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:

this

forwardConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder forwardConfig(CfnListener.ForwardConfigProperty forwardConfig)

Sets the value of CfnListener.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 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:

this

order

@Stability(Stable)
public CfnListener.ActionProperty.Builder order(Number order)

Sets the value of CfnListener.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 of CfnListener.ActionProperty.getRedirectConfig()

Parameters:

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

Returns:

this

redirectConfig

@Stability(Stable)
public CfnListener.ActionProperty.Builder redirectConfig(CfnListener.RedirectConfigProperty redirectConfig)

Sets the value of CfnListener.ActionProperty.getRedirectConfig()

Parameters:

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

Returns:

this

targetGroupArn

@Stability(Stable)
public CfnListener.ActionProperty.Builder targetGroupArn(String targetGroupArn)

Sets the value of CfnListener.ActionProperty.getTargetGroupArn()

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 one or more target groups, use ForwardConfig instead.

Returns:

this

build

@Stability(Stable)
public CfnListener.ActionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnListener.ActionProperty>

Returns:

a new instance of CfnListener.ActionProperty

Throws:

NullPointerException - if any required attribute was not provided