aws-cdk-lib.aws_elasticloadbalancingv2.AddApplicationActionProps

AddApplicationActionProps Struct

Properties for adding a new action to a listener.

AddApplicationActionProps

extends

• AddRuleProps

Source

aws-elasticloadbalancingv2/lib/alb/application-listener.ts

Type last changed

v2.138.0 · 18 Apr 2024

Example

declare const listener: elbv2.ApplicationListener;

listener.addAction('Fixed', {
  priority: 10,
  conditions: [
    elbv2.ListenerCondition.pathPatterns(['/ok']),
  ],
  action: elbv2.ListenerAction.fixedResponse(200, {
    contentType: 'text/plain',
    messageBody: 'OK',
  })
});

Properties

actionListenerActionactionListenerActionactionListenerActionActionListenerActionActionListenerActionrequired#

Action to perform.

conditions?optionalListenerCondition[]conditions?optionaltyping.List[ListenerCondition]conditions?optionalList<ListenerCondition>Conditions?optionalListenerCondition[]Conditions?optional*[]ListenerCondition#

Rule applies if matches the conditions.

Default: No conditions.

priority?optionalnumberpriority?optionalint | floatpriority?optionalNumberPriority?optionaldoublePriority?optional*float64#

Priority of this target group.

Default: Target groups are used as defaults

The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions.

Priorities must be unique.

removeSuffix?optionalbooleanremove_suffix?optionalboolremoveSuffix?optionalBooleanRemoveSuffix?optionalboolRemoveSuffix?optional*bool#

`ListenerRule`s have a `Rule` suffix on their logicalId by default. This allows you to remove that suffix.

Default: use standard logicalId with the Rule suffix

notes

Legacy behavior of the addTargetGroups() convenience method did not include the Rule suffix on the logicalId of the generated ListenerRule. At some point, increasing complexity of requirements can require users to switch from the addTargetGroups() method to the addAction() method. When migrating ListenerRules deployed by a legacy version of addTargetGroups(), you will need to enable this flag to avoid changing the logicalId of your resource. Otherwise Cfn will attempt to replace the ListenerRule and fail.