software.amazon.awscdk.services.ecs.patterns

Interface ApplicationTargetProps

All Known Implementing Classes:

ApplicationTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:36.711Z")
public interface ApplicationTargetProps

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 and Description
static class	ApplicationTargetProps.Builder A builder for ApplicationTargetProps
static class	ApplicationTargetProps.Jsii$Proxy An implementation for ApplicationTargetProps

Method Summary

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

Method Detail

getContainerPort

java.lang.Number getContainerPort()

The port number of the container.

Only applicable when using application/network load balancers.

getHostHeader

default java.lang.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

default java.lang.String getListener()

Name of the listener the target group attached to.

Default: - default listener (first added listener)

getPathPattern

default java.lang.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

default java.lang.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

default Protocol getProtocol()

The protocol used for the port mapping.

Only applicable when using application load balancers.

Default: ecs.Protocol.TCP

builder

static ApplicationTargetProps.Builder builder()

Returns:

a ApplicationTargetProps.Builder of ApplicationTargetProps