AWS CDK Reference

Appearance

v2.274.0

OperatingSystemFamily Class ​

The operating system for Fargate Runtime Platform.

Source
aws-ecs/lib/runtime-platform.ts
Type last changed
v2.207.0 · 24 Jul 2025

Example ​

ts
// Create a Task Definition for the Windows container to start
const taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
  runtimePlatform: {
    operatingSystemFamily: ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,
    cpuArchitecture: ecs.CpuArchitecture.X86_64,
  },
  cpu: 1024,
  memoryLimitMiB: 2048,
});

taskDefinition.addContainer('windowsservercore', {
  logging: ecs.LogDriver.awsLogs({ streamPrefix: 'win-iis-on-fargate' }),
  portMappings: [{ containerPort: 80 }],
  image: ecs.ContainerImage.fromRegistry('mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019'),
});

Properties ​

WINDOWS_SERVER_2004_COREOperatingSystemFamilywindows_server_2004_coreOperatingSystemFamilyWINDOWS_SERVER_2004_COREOperatingSystemFamilyWINDOWS_SERVER_2004_COREOperatingSystemFamilyWINDOWS_SERVER_2004_COREOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2004_CORE.
WINDOWS_SERVER_2016_FULLOperatingSystemFamilywindows_server_2016_fullOperatingSystemFamilyWINDOWS_SERVER_2016_FULLOperatingSystemFamilyWINDOWS_SERVER_2016_FULLOperatingSystemFamilyWINDOWS_SERVER_2016_FULLOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2016_FULL.
WINDOWS_SERVER_2019_COREOperatingSystemFamilywindows_server_2019_coreOperatingSystemFamilyWINDOWS_SERVER_2019_COREOperatingSystemFamilyWINDOWS_SERVER_2019_COREOperatingSystemFamilyWINDOWS_SERVER_2019_COREOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2019_CORE.
WINDOWS_SERVER_2019_FULLOperatingSystemFamilywindows_server_2019_fullOperatingSystemFamilyWINDOWS_SERVER_2019_FULLOperatingSystemFamilyWINDOWS_SERVER_2019_FULLOperatingSystemFamilyWINDOWS_SERVER_2019_FULLOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2019_FULL.
WINDOWS_SERVER_2022_COREOperatingSystemFamilywindows_server_2022_coreOperatingSystemFamilyWINDOWS_SERVER_2022_COREOperatingSystemFamilyWINDOWS_SERVER_2022_COREOperatingSystemFamilyWINDOWS_SERVER_2022_COREOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2022_CORE.
WINDOWS_SERVER_2022_FULLOperatingSystemFamilywindows_server_2022_fullOperatingSystemFamilyWINDOWS_SERVER_2022_FULLOperatingSystemFamilyWINDOWS_SERVER_2022_FULLOperatingSystemFamilyWINDOWS_SERVER_2022_FULLOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2022_FULL.
WINDOWS_SERVER_2025_COREOperatingSystemFamilywindows_server_2025_coreOperatingSystemFamilyWINDOWS_SERVER_2025_COREOperatingSystemFamilyWINDOWS_SERVER_2025_COREOperatingSystemFamilyWINDOWS_SERVER_2025_COREOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2025_CORE.
WINDOWS_SERVER_2025_FULLOperatingSystemFamilywindows_server_2025_fullOperatingSystemFamilyWINDOWS_SERVER_2025_FULLOperatingSystemFamilyWINDOWS_SERVER_2025_FULLOperatingSystemFamilyWINDOWS_SERVER_2025_FULLOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_2025_FULL.
WINDOWS_SERVER_20H2_COREOperatingSystemFamilywindows_server_20_h2_coreOperatingSystemFamilyWINDOWS_SERVER_20H2_COREOperatingSystemFamilyWINDOWS_SERVER_20H2_COREOperatingSystemFamilyWINDOWS_SERVER_20H2_COREOperatingSystemFamilyrequiredstatic#
WINDOWS_SERVER_20H2_CORE.

Methods ​

isLinux(): booleandef is_linux(self, ) -> boolpublic Boolean isLinux()public bool IsLinux()func IsLinux() *bool#
Indicates whether the operating system family is Linux.
isWindows(): booleandef is_windows(self, ) -> boolpublic Boolean isWindows()public bool IsWindows()func IsWindows() *bool#
Indicates whether the operating system family is Windows.
of(family: string): OperatingSystemFamily // chainable@staticmethod def of(family: str) -> OperatingSystemFamilypublic static OperatingSystemFamily of(String family)public static OperatingSystemFamily Of(string family)func Of(Family *string) OperatingSystemFamilystatic#
Other operating system family.
1 parameter

Parameters

  • familyfamilyfamilyfamilyFamily — operating system family.