software.amazon.awscdk.services.elasticloadbalancingv2

Enum Protocol

java.lang.Object

java.lang.Enum<Protocol>

software.amazon.awscdk.services.elasticloadbalancingv2.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.131Z")
 @Stability(value=Stable)
public enum Protocol
extends Enum<Protocol>

Backend protocol for network load balancers and health checks.

Example:

 import software.amazon.awscdk.services.certificatemanager.Certificate;
 import software.amazon.awscdk.services.ec2.InstanceType;
 import software.amazon.awscdk.services.ecs.Cluster;
 import software.amazon.awscdk.services.ecs.ContainerImage;
 import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol;
 import software.amazon.awscdk.services.elasticloadbalancingv2.Protocol;
 import software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy;
 import software.amazon.awscdk.services.route53.PublicHostedZone;
 Vpc vpc = Vpc.Builder.create(this, "Vpc").maxAzs(1).build();
 ApplicationMultipleTargetGroupsFargateService loadBalancedFargateService = ApplicationMultipleTargetGroupsFargateService.Builder.create(this, "myService")
         .cluster(Cluster.Builder.create(this, "EcsCluster").vpc(vpc).build())
         .memoryLimitMiB(256)
         .taskImageOptions(ApplicationLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .enableExecuteCommand(true)
         .loadBalancers(List.of(ApplicationLoadBalancerProps.builder()
                 .name("lb")
                 .idleTimeout(Duration.seconds(400))
                 .domainName("api.example.com")
                 .domainZone(PublicHostedZone.Builder.create(this, "HostedZone").zoneName("example.com").build())
                 .listeners(List.of(ApplicationListenerProps.builder()
                         .name("listener")
                         .protocol(ApplicationProtocol.HTTPS)
                         .certificate(Certificate.fromCertificateArn(this, "Cert", "helloworld"))
                         .sslPolicy(SslPolicy.TLS12_EXT)
                         .build()))
                 .build(), ApplicationLoadBalancerProps.builder()
                 .name("lb2")
                 .idleTimeout(Duration.seconds(120))
                 .domainName("frontend.com")
                 .domainZone(PublicHostedZone.Builder.create(this, "HostedZone").zoneName("frontend.com").build())
                 .listeners(List.of(ApplicationListenerProps.builder()
                         .name("listener2")
                         .protocol(ApplicationProtocol.HTTPS)
                         .certificate(Certificate.fromCertificateArn(this, "Cert2", "helloworld"))
                         .sslPolicy(SslPolicy.TLS12_EXT)
                         .build()))
                 .build()))
         .targetGroups(List.of(ApplicationTargetProps.builder()
                 .containerPort(80)
                 .listener("listener")
                 .build(), ApplicationTargetProps.builder()
                 .containerPort(90)
                 .pathPattern("a/b/c")
                 .priority(10)
                 .listener("listener")
                 .build(), ApplicationTargetProps.builder()
                 .containerPort(443)
                 .listener("listener2")
                 .build(), ApplicationTargetProps.builder()
                 .containerPort(80)
                 .pathPattern("a/b/c")
                 .priority(10)
                 .listener("listener2")
                 .build()))
         .build();
 loadBalancedFargateService.targetGroups[0].configureHealthCheck(HealthCheck.builder()
         .port("8050")
         .protocol(Protocol.HTTP)
         .healthyThresholdCount(2)
         .unhealthyThresholdCount(2)
         .timeout(Duration.seconds(10))
         .interval(Duration.seconds(30))
         .healthyHttpCodes("200")
         .build());
 loadBalancedFargateService.targetGroups[1].configureHealthCheck(HealthCheck.builder()
         .port("8050")
         .protocol(Protocol.HTTP)
         .healthyThresholdCount(2)
         .unhealthyThresholdCount(2)
         .timeout(Duration.seconds(10))
         .interval(Duration.seconds(30))
         .healthyHttpCodes("200")
         .build());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTTP HTTP (ALB health checks and NLB health checks).
HTTPS HTTPS (ALB health checks and NLB health checks).
TCP TCP (NLB, NLB health checks).
TCP_UDP Listen to both TCP and UDP on the same port (NLB).
TLS TLS (NLB).
UDP UDP (NLB).

Method Summary

Modifier and Type	Method and Description
static Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static Protocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HTTP

@Stability(value=Stable)
public static final Protocol HTTP

HTTP (ALB health checks and NLB health checks).

HTTPS

@Stability(value=Stable)
public static final Protocol HTTPS

HTTPS (ALB health checks and NLB health checks).

TCP

@Stability(value=Stable)
public static final Protocol TCP

TCP (NLB, NLB health checks).

TLS

@Stability(value=Stable)
public static final Protocol TLS

TLS (NLB).

UDP

@Stability(value=Stable)
public static final Protocol UDP

UDP (NLB).

TCP_UDP

@Stability(value=Stable)
public static final Protocol TCP_UDP

Listen to both TCP and UDP on the same port (NLB).

Method Detail

values

public static Protocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Protocol c : Protocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Protocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null