Class ApplicationListenerRule

Define a new listener rule.

Inheritance
System.Object
Construct
ApplicationListenerRule
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public class ApplicationListenerRule : Construct, IConstruct, IDependable
Syntax (vb)
Public Class ApplicationListenerRule
    Inherits Construct
    Implements IConstruct, IDependable
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;

ApplicationListener applicationListener;
ApplicationTargetGroup applicationTargetGroup;
ListenerAction listenerAction;
ListenerCondition listenerCondition;

var applicationListenerRule = new ApplicationListenerRule(this, "MyApplicationListenerRule", new ApplicationListenerRuleProps {
    Listener = applicationListener,
    Priority = 123,

    // the properties below are optional
    Action = listenerAction,
    Conditions = new [] { listenerCondition },
    FixedResponse = new FixedResponse {
        StatusCode = "statusCode",

        // the properties below are optional
        ContentType = ContentType.TEXT_PLAIN,
        MessageBody = "messageBody"
    },
    HostHeader = "hostHeader",
    PathPattern = "pathPattern",
    PathPatterns = new [] { "pathPatterns" },
    RedirectResponse = new RedirectResponse {
        StatusCode = "statusCode",

        // the properties below are optional
        Host = "host",
        Path = "path",
        Port = "port",
        Protocol = "protocol",
        Query = "query"
    },
    TargetGroups = new [] { applicationTargetGroup }
});

Synopsis

Constructors

ApplicationListenerRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
ApplicationListenerRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
ApplicationListenerRule(Construct, String, IApplicationListenerRuleProps)

Properties

ListenerRuleArn

The ARN of this rule.

Methods

AddCondition(ListenerCondition)

Add a non-standard condition to this rule.
AddFixedResponse(IFixedResponse)

(deprecated) Add a fixed response.
AddRedirectResponse(IRedirectResponse)

(deprecated) Add a redirect response.
AddTargetGroup(IApplicationTargetGroup)

(deprecated) Add a TargetGroup to load balance to.
ConfigureAction(ListenerAction)

Configure the action to perform for this rule.
SetCondition(String, String[])

(deprecated) Add a non-standard condition to this rule.
Validate()

Validate the rule.

Constructors

ApplicationListenerRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ApplicationListenerRule(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ApplicationListenerRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ApplicationListenerRule(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ApplicationListenerRule(Construct, String, IApplicationListenerRuleProps)

public ApplicationListenerRule(Construct scope, string id, IApplicationListenerRuleProps props)
Parameters
scope Constructs.Construct
id System.String
props IApplicationListenerRuleProps

Properties

ListenerRuleArn

The ARN of this rule.

public virtual string ListenerRuleArn { get; }
Property Value

System.String

Methods

AddCondition(ListenerCondition)

Add a non-standard condition to this rule.

public virtual void AddCondition(ListenerCondition condition)
Parameters
condition ListenerCondition

AddFixedResponse(IFixedResponse)

(deprecated) Add a fixed response.

public virtual void AddFixedResponse(IFixedResponse fixedResponse)
Parameters
fixedResponse IFixedResponse
Remarks

Stability: Deprecated

AddRedirectResponse(IRedirectResponse)

(deprecated) Add a redirect response.

public virtual void AddRedirectResponse(IRedirectResponse redirectResponse)
Parameters
redirectResponse IRedirectResponse
Remarks

Stability: Deprecated

AddTargetGroup(IApplicationTargetGroup)

(deprecated) Add a TargetGroup to load balance to.

public virtual void AddTargetGroup(IApplicationTargetGroup targetGroup)
Parameters
targetGroup IApplicationTargetGroup
Remarks

Stability: Deprecated

ConfigureAction(ListenerAction)

Configure the action to perform for this rule.

public virtual void ConfigureAction(ListenerAction action)
Parameters
action ListenerAction

SetCondition(String, String[])

(deprecated) Add a non-standard condition to this rule.

public virtual void SetCondition(string field, string[] values = null)
Parameters
field System.String
values System.String[]
Remarks

If the condition conflicts with an already set condition, it will be overwritten by the one you specified.

Stability: Deprecated

Validate()

Validate the rule.

protected override string[] Validate()
Returns

System.String[]

Overrides

Implements

Constructs.IConstruct