NetworkListenerAction

class aws_cdk.aws_elasticloadbalancingv2.NetworkListenerAction(default_action_json, next=None)

Bases: object

What to do when a client makes a request to a listener.

Some actions can be combined with other ones (specifically, you can perform authentication before serving the request).

Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

If an action supports chaining, the next action can be indicated by passing it in the next property.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_elasticloadbalancingv2 as elbv2

# network_target_group: elbv2.NetworkTargetGroup

network_listener_action = elbv2.NetworkListenerAction.forward([network_target_group],
    stickiness_duration=cdk.Duration.minutes(30)
)

Create an instance of NetworkListenerAction.

The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.

Parameters:

Methods

bind(scope, listener)

Called when the action is being used in a listener.

Parameters:
Return type:

None

render_actions()

Render the listener default actions in this chain.

Return type:

List[ActionProperty]

render_rule_actions()

Render the listener rule actions in this chain.

Return type:

List[ActionProperty]

Static Methods

classmethod forward(target_groups, *, stickiness_duration=None)

Forward to one or more Target Groups.

Parameters:

  • target_groups (Sequence[INetworkTargetGroup]) –

  • stickiness_duration (Optional[Duration]) – For how long clients should be directed to the same target group. Range between 1 second and 7 days. Default: - No stickiness

Return type:

NetworkListenerAction

classmethod weighted_forward(target_groups, *, stickiness_duration=None)

Forward to one or more Target Groups which are weighted differently.

Parameters:

  • target_groups (Sequence[Union[NetworkWeightedTargetGroup, Dict[str, Any]]]) –

  • stickiness_duration (Optional[Duration]) – For how long clients should be directed to the same target group. Range between 1 second and 7 days. Default: - No stickiness

Return type:

NetworkListenerAction