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

Class NetworkLoadBalancedFargateService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBase

software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedFargateService

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:09.545Z")
@Stability(Stable)
public class NetworkLoadBalancedFargateService
extends NetworkLoadBalancedServiceBase

A Fargate service running on an ECS cluster fronted by a network load balancer.

Example:

 import software.amazon.awscdk.services.certificatemanager.Certificate;
 ICertificate certificate = Certificate.fromCertificateArn(this, "Cert", "arn:aws:acm:us-east-1:123456:certificate/abcdefg");
 NetworkLoadBalancedFargateService loadBalancedFargateService = NetworkLoadBalancedFargateService.Builder.create(this, "Service")
         // The default value of listenerPort is 443 if you pass in listenerCertificate
         // It is configured to port 4443 here
         .listenerPort(4443)
         .listenerCertificate(certificate)
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 // The default value of containerPort is 443 if you pass in listenerCertificate
                 // It is configured to port 8443 here
                 .containerPort(8443)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NetworkLoadBalancedFargateService.Builder	A fluent builder for NetworkLoadBalancedFargateService.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NetworkLoadBalancedFargateService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkLoadBalancedFargateService(software.amazon.jsii.JsiiObjectRef objRef)
	NetworkLoadBalancedFargateService(software.constructs.Construct scope, String id)	Constructs a new instance of the NetworkLoadBalancedFargateService class.
	NetworkLoadBalancedFargateService(software.constructs.Construct scope, String id, NetworkLoadBalancedFargateServiceProps props)	Constructs a new instance of the NetworkLoadBalancedFargateService class.

Method Summary

Modifier and Type	Method	Description
Boolean	getAssignPublicIp()
FargateService	getService()	The Fargate service in this construct.
FargateTaskDefinition	getTaskDefinition()	The Fargate task definition in this construct.

Methods inherited from class software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBase

addServiceAsTarget, createAWSLogDriver, getCluster, getDefaultCluster, getDefaultCluster, getInternalDesiredCount, getListener, getLoadBalancer, getTargetGroup

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

NetworkLoadBalancedFargateService

protected NetworkLoadBalancedFargateService(software.amazon.jsii.JsiiObjectRef objRef)

NetworkLoadBalancedFargateService

protected NetworkLoadBalancedFargateService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NetworkLoadBalancedFargateService

@Stability(Stable)
public NetworkLoadBalancedFargateService(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 NetworkLoadBalancedFargateServiceProps props)

Constructs a new instance of the NetworkLoadBalancedFargateService class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

NetworkLoadBalancedFargateService

@Stability(Stable)
public NetworkLoadBalancedFargateService(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Constructs a new instance of the NetworkLoadBalancedFargateService class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

getAssignPublicIp

@Stability(Stable)
@NotNull
public Boolean getAssignPublicIp()

getService

@Stability(Stable)
@NotNull
public FargateService getService()

The Fargate service in this construct.

getTaskDefinition

@Stability(Stable)
@NotNull
public FargateTaskDefinition getTaskDefinition()

The Fargate task definition in this construct.