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

Interface QueueProcessingFargateServiceProps

All Superinterfaces:

FargateServiceBaseProps, software.amazon.jsii.JsiiSerializable, QueueProcessingServiceBaseProps

All Known Implementing Classes:

QueueProcessingFargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:07.741Z")
@Stability(Stable)
public interface QueueProcessingFargateServiceProps
extends software.amazon.jsii.JsiiSerializable, QueueProcessingServiceBaseProps, FargateServiceBaseProps

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 HealthCheck	getHealthCheck()	The health check command and associated configuration parameters for the container.
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.awscdk.services.ecs.patterns.FargateServiceBaseProps

getCpu, getEphemeralStorageGiB, getMemoryLimitMiB, getPlatformVersion, getRuntimePlatform, getTaskDefinition

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, getCooldown, getCpuTargetUtilizationPercent, getDeploymentController, getDisableCpuBasedScaling, getEnableECSManagedTags, getEnableExecuteCommand, 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.

This name is not used when taskDefinition is provided.

Default: - QueueProcessingContainer

getHealthCheck

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

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

Default: - Health check configuration from container.

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