Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListener.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListener.ActionProperty.Jsii$Proxy

Enclosing class:

CfnListener

@Stability(Stable)
public static interface CfnListener.ActionProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an action for a listener rule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .type("type")
         // the properties below are optional
         .authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
                 .userPoolArn("userPoolArn")
                 .userPoolClientId("userPoolClientId")
                 .userPoolDomain("userPoolDomain")
                 // the properties below are optional
                 .authenticationRequestExtraParams(Map.of(
                         "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                 .onUnauthenticatedRequest("onUnauthenticatedRequest")
                 .scope("scope")
                 .sessionCookieName("sessionCookieName")
                 .sessionTimeout("sessionTimeout")
                 .build())
         .authenticateOidcConfig(AuthenticateOidcConfigProperty.builder()
                 .authorizationEndpoint("authorizationEndpoint")
                 .clientId("clientId")
                 .issuer("issuer")
                 .tokenEndpoint("tokenEndpoint")
                 .userInfoEndpoint("userInfoEndpoint")
                 // the properties below are optional
                 .authenticationRequestExtraParams(Map.of(
                         "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                 .clientSecret("clientSecret")
                 .onUnauthenticatedRequest("onUnauthenticatedRequest")
                 .scope("scope")
                 .sessionCookieName("sessionCookieName")
                 .sessionTimeout("sessionTimeout")
                 .useExistingClientSecret(false)
                 .build())
         .fixedResponseConfig(FixedResponseConfigProperty.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .contentType("contentType")
                 .messageBody("messageBody")
                 .build())
         .forwardConfig(ForwardConfigProperty.builder()
                 .targetGroups(List.of(TargetGroupTupleProperty.builder()
                         .targetGroupArn("targetGroupArn")
                         .weight(123)
                         .build()))
                 .targetGroupStickinessConfig(TargetGroupStickinessConfigProperty.builder()
                         .durationSeconds(123)
                         .enabled(false)
                         .build())
                 .build())
         .order(123)
         .redirectConfig(RedirectConfigProperty.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .host("host")
                 .path("path")
                 .port("port")
                 .protocol("protocol")
                 .query("query")
                 .build())
         .targetGroupArn("targetGroupArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnListener.ActionProperty.Builder	A builder for CfnListener.ActionProperty
static final class	CfnListener.ActionProperty.Jsii$Proxy	An implementation for CfnListener.ActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnListener.ActionProperty.Builder	builder()
default Object	getAuthenticateCognitoConfig()	[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
default Object	getAuthenticateOidcConfig()	[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
default Object	getFixedResponseConfig()	[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
default Object	getForwardConfig()	Information for creating an action that distributes requests among one or more target groups.
default Number	getOrder()	The order for the action.
default Object	getRedirectConfig()	[Application Load Balancer] Information for creating a redirect action.
default String	getTargetGroupArn()	The Amazon Resource Name (ARN) of the target group.
String	getType()	The type of action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of action.

getAuthenticateCognitoConfig

@Stability(Stable)
@Nullable
default Object getAuthenticateCognitoConfig()

[HTTPS listeners] Information for using Amazon Cognito to authenticate users.

Specify only when Type is authenticate-cognito .

getAuthenticateOidcConfig

@Stability(Stable)
@Nullable
default Object getAuthenticateOidcConfig()

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).

Specify only when Type is authenticate-oidc .

getFixedResponseConfig

@Stability(Stable)
@Nullable
default Object getFixedResponseConfig()

[Application Load Balancer] Information for creating an action that returns a custom HTTP response.

Specify only when Type is fixed-response .

getForwardConfig

@Stability(Stable)
@Nullable
default Object getForwardConfig()

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 .

getOrder

@Stability(Stable)
@Nullable
default Number getOrder()

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.

getRedirectConfig

@Stability(Stable)
@Nullable
default Object getRedirectConfig()

[Application Load Balancer] Information for creating a redirect action.

Specify only when Type is redirect .

getTargetGroupArn

@Stability(Stable)
@Nullable
default String getTargetGroupArn()

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.

builder

@Stability(Stable)
static CfnListener.ActionProperty.Builder builder()

Returns:

a CfnListener.ActionProperty.Builder of CfnListener.ActionProperty