software.amazon.awscdk.services.ecs.patterns

Interface QueueProcessingEc2ServiceProps

All Superinterfaces:

QueueProcessingServiceBaseProps

All Known Implementing Classes:

QueueProcessingEc2ServiceProps.Jsii$Proxy

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

The properties for the QueueProcessingEc2Service service.

Example:

 Cluster cluster;
 QueueProcessingEc2Service queueProcessingEc2Service = QueueProcessingEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .image(ContainerImage.fromRegistry("test"))
         .command(List.of("-c", "4", "amazon.com"))
         .enableLogging(false)
         .desiredTaskCount(2)
         .environment(Map.of(
                 "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                 "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
         .maxScalingCapacity(5)
         .containerName("test")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static QueueProcessingEc2ServiceProps.Builder	builder()
default java.lang.String	getContainerName() Optional name for the container added.
default java.lang.Number	getCpu() The number of cpu units used by the task.
default java.lang.Number	getGpuCount() Gpu count for container in task definition.
default java.lang.Number	getMemoryLimitMiB() The hard limit (in MiB) of memory to present to the container.
default java.lang.Number	getMemoryReservationMiB() The soft limit (in MiB) of memory to reserve for the container.
default java.util.List<PlacementConstraint>	getPlacementConstraints() The placement constraints to use for tasks in the service.
default java.util.List<PlacementStrategy>	getPlacementStrategies() The placement strategies to use for tasks in the service.

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

getCapacityProviderStrategies, getCircuitBreaker, getCluster, getCommand, getDeploymentController, getDesiredTaskCount, getEnableECSManagedTags, getEnableLogging, getEnvironment, getFamily, getImage, getLogDriver, getMaxHealthyPercent, getMaxReceiveCount, getMaxScalingCapacity, getMinHealthyPercent, getMinScalingCapacity, getPropagateTags, getQueue, getRetentionPeriod, getScalingSteps, getSecrets, getServiceName, getVisibilityTimeout, getVpc

Method Detail

getContainerName

default java.lang.String getContainerName()

Optional name for the container added.

Default: - QueueProcessingContainer

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: none

getGpuCount

default java.lang.Number getGpuCount()

Gpu count for container in task definition.

Set this if you want to use gpu based instances.

Default: - No GPUs assigned.

getMemoryLimitMiB

default java.lang.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 for non-Fargate services.

Default: - No memory limit.

getMemoryReservationMiB

default java.lang.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 for non-Fargate services.

Default: - No memory reserved.

getPlacementConstraints

default java.util.List<PlacementConstraint> getPlacementConstraints()

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Default: - No constraints.

getPlacementStrategies

default java.util.List<PlacementStrategy> getPlacementStrategies()

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Default: - No strategies.

builder

static QueueProcessingEc2ServiceProps.Builder builder()

Specified by:

builder in interface QueueProcessingServiceBaseProps

Returns:

a QueueProcessingEc2ServiceProps.Builder of QueueProcessingEc2ServiceProps