software.amazon.awscdk.services.ecs.patterns

Interface FargateServiceBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ApplicationLoadBalancedFargateServiceProps, ApplicationMultipleTargetGroupsFargateServiceProps, NetworkLoadBalancedFargateServiceProps, NetworkMultipleTargetGroupsFargateServiceProps, QueueProcessingFargateServiceProps, ScheduledFargateTaskImageOptions, ScheduledFargateTaskProps

All Known Implementing Classes:

ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy, ApplicationMultipleTargetGroupsFargateServiceProps.Jsii$Proxy, FargateServiceBaseProps.Jsii$Proxy, NetworkLoadBalancedFargateServiceProps.Jsii$Proxy, NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy, QueueProcessingFargateServiceProps.Jsii$Proxy, ScheduledFargateTaskImageOptions.Jsii$Proxy, ScheduledFargateTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.794Z")
 @Stability(value=Stable)
public interface FargateServiceBaseProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 CpuArchitecture cpuArchitecture;
 FargateTaskDefinition fargateTaskDefinition;
 OperatingSystemFamily operatingSystemFamily;
 FargateServiceBaseProps fargateServiceBaseProps = FargateServiceBaseProps.builder()
         .cpu(123)
         .memoryLimitMiB(123)
         .platformVersion(FargatePlatformVersion.LATEST)
         .runtimePlatform(RuntimePlatform.builder()
                 .cpuArchitecture(cpuArchitecture)
                 .operatingSystemFamily(operatingSystemFamily)
                 .build())
         .taskDefinition(fargateTaskDefinition)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FargateServiceBaseProps.Builder	builder()
default Number	getCpu() The number of cpu units used by the task.
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 RuntimePlatform	getRuntimePlatform() The runtime platform of the task definition.
default FargateTaskDefinition	getTaskDefinition() The task definition to use for tasks in the service.

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

getMemoryLimitMiB

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

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

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

getRuntimePlatform

@Stability(value=Stable)
 @Nullable
default RuntimePlatform getRuntimePlatform()

The runtime platform of the task definition.

Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64

getTaskDefinition

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

builder

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

Returns:

a FargateServiceBaseProps.Builder of FargateServiceBaseProps