Class ApplicationTargetProps

Properties to define an application target group.

Inheritance

System.Object

ApplicationTargetProps

Implements

IApplicationTargetProps

Namespace: Amazon.CDK.AWS.ECS.Patterns

Assembly: Amazon.CDK.AWS.ECS.Patterns.dll

Syntax (csharp)

public class ApplicationTargetProps : Object, IApplicationTargetProps

Syntax (vb)

Public Class ApplicationTargetProps
    Inherits Object
    Implements IApplicationTargetProps

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.ECS;
using Amazon.CDK.AWS.ECS.Patterns;

var applicationTargetProps = new ApplicationTargetProps {
    ContainerPort = 123,

    // the properties below are optional
    HostHeader = "hostHeader",
    Listener = "listener",
    PathPattern = "pathPattern",
    Priority = 123,
    Protocol = Protocol.TCP
};

Synopsis

Constructors

ApplicationTargetProps()

Properties

ContainerPort	The port number of the container.
HostHeader	Rule applies if the requested host matches the indicated host.
Listener	Name of the listener the target group attached to.
PathPattern	Rule applies if the requested path matches the given path pattern.
Priority	Priority of this target group.
Protocol	The protocol used for the port mapping.

Constructors

ApplicationTargetProps()

public ApplicationTargetProps()

Properties

ContainerPort

The port number of the container.

public double ContainerPort { get; set; }

Property Value

System.Double

Remarks

Only applicable when using application/network load balancers.

HostHeader

Rule applies if the requested host matches the indicated host.

public string HostHeader { get; set; }

Property Value

System.String

Remarks

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No host condition

See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#host-conditions

Listener

Name of the listener the target group attached to.

public string Listener { get; set; }

Property Value

System.String

Remarks

Default: - default listener (first added listener)

PathPattern

Rule applies if the requested path matches the given path pattern.

public string PathPattern { get; set; }

Property Value

System.String

Remarks

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No path condition

See: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#path-conditions

Priority

Priority of this target group.

public Nullable<double> Priority { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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.

Default: Target groups are used as defaults

Protocol

The protocol used for the port mapping.

public Nullable<Protocol> Protocol { get; set; }

Property Value

System.Nullable<Protocol>

Remarks

Only applicable when using application load balancers.

Default: ecs.Protocol.TCP

Implements

IApplicationTargetProps