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

Interface NetworkLoadBalancedFargateServiceProps

All Superinterfaces:

FargateServiceBaseProps, software.amazon.jsii.JsiiSerializable, NetworkLoadBalancedServiceBaseProps

All Known Implementing Classes:

NetworkLoadBalancedFargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.251Z")
@Stability(Stable)
public interface NetworkLoadBalancedFargateServiceProps
extends software.amazon.jsii.JsiiSerializable, NetworkLoadBalancedServiceBaseProps, FargateServiceBaseProps

The properties for the NetworkLoadBalancedFargateService service.

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

Method Summary

Modifier and Type	Method	Description
static NetworkLoadBalancedFargateServiceProps.Builder	builder()
default Boolean	getAssignPublicIp()	Determines whether the service will be assigned a public IP address.
default List<ISecurityGroup>	getSecurityGroups()	The security groups to associate with the service.
default SubnetSelection	getTaskSubnets()	The subnets to associate with the service.

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.FargateServiceBaseProps

getCpu, getEphemeralStorageGiB, getMemoryLimitMiB, getPlatformVersion, getRuntimePlatform, getTaskDefinition

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBaseProps

getCapacityProviderStrategies, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentController, getDesiredCount, getDomainName, getDomainZone, getEnableECSManagedTags, getEnableExecuteCommand, getHealthCheckGracePeriod, getIpAddressType, getListenerCertificate, getListenerPort, getLoadBalancer, getMaxHealthyPercent, getMinHealthyPercent, getPropagateTags, getPublicLoadBalancer, getRecordType, getServiceName, getTaskImageOptions, getVpc

Method Details

getAssignPublicIp

@Stability(Stable)
@Nullable
default Boolean getAssignPublicIp()

Determines whether the service will be assigned a public IP address.

Default: false

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

Default: - A new security group is created.

getTaskSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getTaskSubnets()

The subnets to associate with the service.

Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

builder

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

Returns:

a NetworkLoadBalancedFargateServiceProps.Builder of NetworkLoadBalancedFargateServiceProps