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

Interface QueueProcessingFargateServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, QueueProcessingServiceBaseProps

All Known Implementing Classes:

QueueProcessingFargateServiceProps.Jsii$Proxy

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

The properties for the QueueProcessingFargateService service.

Example:

 Cluster cluster;
 cluster.enableFargateCapacityProviders();
 QueueProcessingFargateService queueProcessingFargateService = QueueProcessingFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(512)
         .image(ContainerImage.fromRegistry("test"))
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE_SPOT")
                 .weight(2)
                 .build(), CapacityProviderStrategy.builder()
                 .capacityProvider("FARGATE")
                 .weight(1)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static QueueProcessingFargateServiceProps.Builder	builder()
default Boolean	getAssignPublicIp()	Specifies whether the task's elastic network interface receives a public IP address.
default String	getContainerName()	Optional name for the container added.
default Number	getCpu()	The number of cpu units used by the task.
default HealthCheck	getHealthCheck()	The health check command and associated configuration parameters for the container.
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 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.jsii.JsiiSerializable

$jsii$toJson

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 Details

getAssignPublicIp

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

Specifies whether the task's elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

Default: false

getContainerName

@Stability(Stable)
@Nullable
default String getContainerName()

Optional name for the container added.

Default: - QueueProcessingContainer

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

getHealthCheck

@Stability(Stable)
@Nullable
default HealthCheck getHealthCheck()

The health check command and associated configuration parameters for the container.

Default: - Health check configuration from container.

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:

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

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

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

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

Between 8GB and 30GB in 1GB increments - 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

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 QueueProcessingFargateServiceProps.Builder builder()

Returns:

a QueueProcessingFargateServiceProps.Builder of QueueProcessingFargateServiceProps