Package software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2

Interface CfnListenerPropsMixin.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerPropsMixin.ActionProperty.Jsii$Proxy

Enclosing class:

CfnListenerPropsMixin

@Stability(Stable)
public static interface CfnListenerPropsMixin.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.cfnpropertymixins.services.elasticloadbalancingv2.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
                 .authenticationRequestExtraParams(Map.of(
                         "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                 .onUnauthenticatedRequest("onUnauthenticatedRequest")
                 .scope("scope")
                 .sessionCookieName("sessionCookieName")
                 .sessionTimeout("sessionTimeout")
                 .userPoolArn("userPoolArn")
                 .userPoolClientId("userPoolClientId")
                 .userPoolDomain("userPoolDomain")
                 .build())
         .authenticateOidcConfig(AuthenticateOidcConfigProperty.builder()
                 .authenticationRequestExtraParams(Map.of(
                         "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                 .authorizationEndpoint("authorizationEndpoint")
                 .clientId("clientId")
                 .clientSecret("clientSecret")
                 .issuer("issuer")
                 .onUnauthenticatedRequest("onUnauthenticatedRequest")
                 .scope("scope")
                 .sessionCookieName("sessionCookieName")
                 .sessionTimeout("sessionTimeout")
                 .tokenEndpoint("tokenEndpoint")
                 .useExistingClientSecret(false)
                 .userInfoEndpoint("userInfoEndpoint")
                 .build())
         .fixedResponseConfig(FixedResponseConfigProperty.builder()
                 .contentType("contentType")
                 .messageBody("messageBody")
                 .statusCode("statusCode")
                 .build())
         .forwardConfig(ForwardConfigProperty.builder()
                 .targetGroups(List.of(TargetGroupTupleProperty.builder()
                         .targetGroupArn("targetGroupArn")
                         .weight(123)
                         .build()))
                 .targetGroupStickinessConfig(TargetGroupStickinessConfigProperty.builder()
                         .durationSeconds(123)
                         .enabled(false)
                         .build())
                 .build())
         .jwtValidationConfig(JwtValidationConfigProperty.builder()
                 .additionalClaims(List.of(JwtValidationActionAdditionalClaimProperty.builder()
                         .format("format")
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .issuer("issuer")
                 .jwksEndpoint("jwksEndpoint")
                 .build())
         .order(123)
         .redirectConfig(RedirectConfigProperty.builder()
                 .host("host")
                 .path("path")
                 .port("port")
                 .protocol("protocol")
                 .query("query")
                 .statusCode("statusCode")
                 .build())
         .targetGroupArn("targetGroupArn")
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnListenerPropsMixin.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 multiple target groups.
default Object	getJwtValidationConfig()	[HTTPS listeners] Information for validating JWT access tokens in client requests.
default Number	getOrder()	The order for the action.
default Object	getRedirectConfig()	[Application Load Balancer] Information for creating a redirect action.
default Object	getTargetGroupArn()	The Amazon Resource Name (ARN) of the target group.
default String	getType()	The type of action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticateCognitoConfig

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

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

Specify only when Type is authenticate-cognito .

Returns union: either IResolvable or CfnListenerPropsMixin.AuthenticateCognitoConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig

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 .

Returns union: either IResolvable or CfnListenerPropsMixin.AuthenticateOidcConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig

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 .

Returns union: either IResolvable or CfnListenerPropsMixin.FixedResponseConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig

getForwardConfig

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

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 union: either IResolvable or CfnListenerPropsMixin.ForwardConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig

getJwtValidationConfig

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

[HTTPS listeners] Information for validating JWT access tokens in client requests.

Specify only when Type is jwt-validation .

Returns union: either IResolvable or CfnListenerPropsMixin.JwtValidationConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-jwtvalidationconfig

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-order

getRedirectConfig

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

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

Specify only when Type is redirect .

Returns union: either IResolvable or CfnListenerPropsMixin.RedirectConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig

getTargetGroupArn

@Stability(Stable)
@Nullable
default Object 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 multiple target groups, you must use ForwardConfig instead.

Returns union: either String or ITargetGroupRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-targetgrouparn

getType

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

The type of action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-type

builder

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

Returns:

a CfnListenerPropsMixin.ActionProperty.Builder of CfnListenerPropsMixin.ActionProperty