software.amazon.awscdk.services.ecs.patterns

Interface ApplicationLoadBalancedEc2ServiceProps

All Superinterfaces:

ApplicationLoadBalancedServiceBaseProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplicationLoadBalancedEc2ServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:52.457Z")
 @Stability(value=Stable)
public interface ApplicationLoadBalancedEc2ServiceProps
extends software.amazon.jsii.JsiiSerializable, ApplicationLoadBalancedServiceBaseProps

The properties for the ApplicationLoadBalancedEc2Service service.

Example:

 Cluster cluster;
 ApplicationLoadBalancedEc2Service loadBalancedEcsService = ApplicationLoadBalancedEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("test"))
                 .environment(Map.of(
                         "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                         "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
                 .build())
         .desiredCount(2)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApplicationLoadBalancedEc2ServiceProps.Builder	builder()
default Number	getCpu() The number of cpu units used by the task.
default Number	getMemoryLimitMiB() The hard limit (in MiB) of memory to present to the container.
default Number	getMemoryReservationMiB() The soft limit (in MiB) of memory to reserve for the container.
default Ec2TaskDefinition	getTaskDefinition() The task definition to use for tasks in the service.

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

getCertificate, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentController, getDesiredCount, getDomainName, getDomainZone, getEnableECSManagedTags, getHealthCheckGracePeriod, getListenerPort, getLoadBalancer, getLoadBalancerName, getMaxHealthyPercent, getMinHealthyPercent, getOpenListener, getPropagateTags, getProtocol, getProtocolVersion, getPublicLoadBalancer, getRecordType, getRedirectHTTP, getServiceName, getSslPolicy, getTargetProtocol, getTaskImageOptions, getVpc

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCpu

@Stability(value=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: none

getMemoryLimitMiB

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

The hard limit (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Default: - No memory limit.

getMemoryReservationMiB

@Stability(value=Stable)
 @Nullable
default Number getMemoryReservationMiB()

The soft limit (in MiB) of memory to reserve for the container.

When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Default: - No memory reserved.

getTaskDefinition

@Stability(value=Stable)
 @Nullable
default Ec2TaskDefinition 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

builder

@Stability(value=Stable)
static ApplicationLoadBalancedEc2ServiceProps.Builder builder()

Specified by:

builder in interface ApplicationLoadBalancedServiceBaseProps

Returns:

a ApplicationLoadBalancedEc2ServiceProps.Builder of ApplicationLoadBalancedEc2ServiceProps