software.amazon.awscdk.services.ecs.patterns

Interface NetworkLoadBalancedFargateServiceProps

All Superinterfaces:

NetworkLoadBalancedServiceBaseProps

All Known Implementing Classes:

NetworkLoadBalancedFargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.900Z")
public interface NetworkLoadBalancedFargateServiceProps
extends NetworkLoadBalancedServiceBaseProps

The properties for the NetworkLoadBalancedFargateService service.

Example:

 Cluster cluster;
 NetworkLoadBalancedFargateService loadBalancedFargateService = NetworkLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .cpu(512)
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static NetworkLoadBalancedFargateServiceProps.Builder	builder()
default java.lang.Boolean	getAssignPublicIp() Determines whether the service will be assigned a public IP address.
default java.lang.Number	getCpu() The number of cpu units used by the task.
default java.lang.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.
default SubnetSelection	getTaskSubnets() The subnets to associate with the service.

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

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

Method Detail

getAssignPublicIp

default java.lang.Boolean getAssignPublicIp()

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

Default: false

getCpu

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

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

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

default FargateTaskDefinition getTaskDefinition()

The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

[disable-awslint:ref-via-interface]

Default: - none

getTaskSubnets

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

static NetworkLoadBalancedFargateServiceProps.Builder builder()

Specified by:

builder in interface NetworkLoadBalancedServiceBaseProps

Returns:

a NetworkLoadBalancedFargateServiceProps.Builder of NetworkLoadBalancedFargateServiceProps