Package software.amazon.awscdk.services.ecs.patterns

Interface ApplicationTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplicationTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:27.510Z")
@Stability(Stable)
public interface ApplicationTargetProps
extends software.amazon.jsii.JsiiSerializable

Properties to define an application target group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 ApplicationTargetProps applicationTargetProps = ApplicationTargetProps.builder()
         .containerPort(123)
         // the properties below are optional
         .hostHeader("hostHeader")
         .listener("listener")
         .pathPattern("pathPattern")
         .priority(123)
         .protocol(Protocol.TCP)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApplicationTargetProps.Builder	builder()
Number	getContainerPort()	The port number of the container.
default String	getHostHeader()	Rule applies if the requested host matches the indicated host.
default String	getListener()	Name of the listener the target group attached to.
default String	getPathPattern()	Rule applies if the requested path matches the given path pattern.
default Number	getPriority()	Priority of this target group.
default Protocol	getProtocol()	The protocol used for the port mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerPort

@Stability(Stable)
@NotNull
Number getContainerPort()

The port number of the container.

Only applicable when using application/network load balancers.

getHostHeader

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

Rule applies if the requested host matches the indicated host.

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No host condition

See Also:

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

getListener

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

Name of the listener the target group attached to.

Default: - default listener (first added listener)

getPathPattern

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

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

May contain up to three '*' wildcards.

Requires that priority is set.

Default: No path condition

See Also:

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

getPriority

@Stability(Stable)
@Nullable
default Number getPriority()

Priority of this target group.

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

getProtocol

@Stability(Stable)
@Nullable
default Protocol getProtocol()

The protocol used for the port mapping.

Only applicable when using application load balancers.

Default: ecs.Protocol.TCP

builder

@Stability(Stable)
static ApplicationTargetProps.Builder builder()

Returns:

a ApplicationTargetProps.Builder of ApplicationTargetProps