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

Interface NetworkMultipleTargetGroupsFargateServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, NetworkMultipleTargetGroupsServiceBaseProps

All Known Implementing Classes:

NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.762Z")
@Stability(Stable)
public interface NetworkMultipleTargetGroupsFargateServiceProps
extends software.amazon.jsii.JsiiSerializable, NetworkMultipleTargetGroupsServiceBaseProps

The properties for the NetworkMultipleTargetGroupsFargateService service.

Example:

 // Two network load balancers, each with their own listener and target group.
 Cluster cluster;
 NetworkMultipleTargetGroupsFargateService loadBalancedFargateService = NetworkMultipleTargetGroupsFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .taskImageOptions(NetworkLoadBalancedTaskImageProps.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .loadBalancers(List.of(NetworkLoadBalancerProps.builder()
                 .name("lb1")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener1")
                         .build()))
                 .build(), NetworkLoadBalancerProps.builder()
                 .name("lb2")
                 .listeners(List.of(NetworkListenerProps.builder()
                         .name("listener2")
                         .build()))
                 .build()))
         .targetGroups(List.of(NetworkTargetProps.builder()
                 .containerPort(80)
                 .listener("listener1")
                 .build(), NetworkTargetProps.builder()
                 .containerPort(90)
                 .listener("listener2")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NetworkMultipleTargetGroupsFargateServiceProps.Builder	builder()
default Boolean	getAssignPublicIp()	Determines whether the service will be assigned a public IP address.
default Number	getCpu()	The number of cpu units used by the task.
default Number	getMemoryLimitMiB()	The amount (in MiB) of memory used by the task.
default FargatePlatformVersion	getPlatformVersion()	The platform version on which to run your service.
default FargateTaskDefinition	getTaskDefinition()	The task definition to use for tasks in the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getCloudMapOptions, getCluster, getDesiredCount, getEnableECSManagedTags, getHealthCheckGracePeriod, getLoadBalancers, getPropagateTags, getServiceName, getTargetGroups, getTaskImageOptions, getVpc

Method Details

getAssignPublicIp

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

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

Default: false

getCpu

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

The number of cpu units used by the task.

Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Default: 256

getMemoryLimitMiB

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

The amount (in MiB) of memory used by the task.

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Default: 512

getPlatformVersion

@Stability(Stable)
@Nullable
default FargatePlatformVersion getPlatformVersion()

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Default: Latest

getTaskDefinition

@Stability(Stable)
@Nullable
default FargateTaskDefinition getTaskDefinition()

The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.

[disable-awslint:ref-via-interface]

Default: - none

builder

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

Returns:

a NetworkMultipleTargetGroupsFargateServiceProps.Builder of NetworkMultipleTargetGroupsFargateServiceProps