# OperatingSystemFamily

The operating system for Fargate Runtime Platform.

Obtainable from: OperatingSystemFamily.LINUX, OperatingSystemFamily.WINDOWS_SERVER_2004_CORE, OperatingSystemFamily.WINDOWS_SERVER_2016_FULL, OperatingSystemFamily.WINDOWS_SERVER_2019_CORE, OperatingSystemFamily.WINDOWS_SERVER_2019_FULL, OperatingSystemFamily.WINDOWS_SERVER_2022_CORE, OperatingSystemFamily.WINDOWS_SERVER_2022_FULL, OperatingSystemFamily.WINDOWS_SERVER_2025_CORE, OperatingSystemFamily.WINDOWS_SERVER_2025_FULL, OperatingSystemFamily.WINDOWS_SERVER_20H2_CORE, OperatingSystemFamily.of
Used as argument in: [CloudWatchAgentVersion.getCloudWatchAgentImage](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-applicationsignals-alpha.CloudWatchAgentVersion.html#getcloudwatchagentimage)

- Source: [`aws-ecs/lib/runtime-platform.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-ecs/lib/runtime-platform.ts#L35)
- Type last changed: v2.207.0 · 24 Jul 2025

## Example

TypeScript:

```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'),
});
```

Python:

```python
# Create a Task Definition for the Windows container to start
task_definition = ecs.FargateTaskDefinition(self, "TaskDef",
    runtime_platform=ecs.RuntimePlatform(
        operating_system_family=ecs.OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,
        cpu_architecture=ecs.CpuArchitecture.X86_64
    ),
    cpu=1024,
    memory_limit_mi_b=2048
)

task_definition.add_container("windowsservercore",
    logging=ecs.LogDriver.aws_logs(stream_prefix="win-iis-on-fargate"),
    port_mappings=[ecs.PortMapping(container_port=80)],
    image=ecs.ContainerImage.from_registry("mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019")
)
```

Java:

```java
// Create a Task Definition for the Windows container to start
FargateTaskDefinition taskDefinition = FargateTaskDefinition.Builder.create(this, "TaskDef")
        .runtimePlatform(RuntimePlatform.builder()
                .operatingSystemFamily(OperatingSystemFamily.WINDOWS_SERVER_2019_CORE)
                .cpuArchitecture(CpuArchitecture.X86_64)
                .build())
        .cpu(1024)
        .memoryLimitMiB(2048)
        .build();

taskDefinition.addContainer("windowsservercore", ContainerDefinitionOptions.builder()
        .logging(LogDriver.awsLogs(AwsLogDriverProps.builder().streamPrefix("win-iis-on-fargate").build()))
        .portMappings(List.of(PortMapping.builder().containerPort(80).build()))
        .image(ContainerImage.fromRegistry("mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019"))
        .build());
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// Create a Task Definition for the Windows container to start
var taskDefinition = new FargateTaskDefinition(this, "TaskDef", new FargateTaskDefinitionProps {
    RuntimePlatform = new RuntimePlatform {
        OperatingSystemFamily = OperatingSystemFamily.WINDOWS_SERVER_2019_CORE,
        CpuArchitecture = CpuArchitecture.X86_64
    },
    Cpu = 1024,
    MemoryLimitMiB = 2048
});

taskDefinition.AddContainer("windowsservercore", new ContainerDefinitionOptions {
    Logging = LogDriver.AwsLogs(new AwsLogDriverProps { StreamPrefix = "win-iis-on-fargate" }),
    PortMappings = new [] { new PortMapping { ContainerPort = 80 } },
    Image = ContainerImage.FromRegistry("mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019")
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Create a Task Definition for the Windows container to start
taskDefinition := ecs.NewFargateTaskDefinition(this, jsii.String("TaskDef"), &FargateTaskDefinitionProps{
	RuntimePlatform: &RuntimePlatform{
		OperatingSystemFamily: ecs.OperatingSystemFamily_WINDOWS_SERVER_2019_CORE(),
		CpuArchitecture: ecs.CpuArchitecture_X86_64(),
	},
	Cpu: jsii.Number(1024),
	MemoryLimitMiB: jsii.Number(2048),
})

taskDefinition.AddContainer(jsii.String("windowsservercore"), &ContainerDefinitionOptions{
	Logging: ecs.LogDriver_AwsLogs(&AwsLogDriverProps{
		StreamPrefix: jsii.String("win-iis-on-fargate"),
	}),
	PortMappings: []PortMapping{
		&PortMapping{
			ContainerPort: jsii.Number(80),
		},
	},
	Image: ecs.ContainerImage_FromRegistry(jsii.String("mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019")),
})
```

## Properties

- `LINUX`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — LINUX.

- `WINDOWS_SERVER_2004_CORE`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2004_CORE.

- `WINDOWS_SERVER_2016_FULL`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2016_FULL.

- `WINDOWS_SERVER_2019_CORE`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2019_CORE.

- `WINDOWS_SERVER_2019_FULL`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2019_FULL.

- `WINDOWS_SERVER_2022_CORE`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2022_CORE.

- `WINDOWS_SERVER_2022_FULL`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2022_FULL.

- `WINDOWS_SERVER_2025_CORE`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2025_CORE.

- `WINDOWS_SERVER_2025_FULL`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_2025_FULL.

- `WINDOWS_SERVER_20H2_CORE`: [OperatingSystemFamily](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.OperatingSystemFamily.html) (static) — WINDOWS_SERVER_20H2_CORE.

## Methods

- `isLinux(): boolean` — Indicates whether the operating system family is Linux.

- `isWindows(): boolean` — Indicates whether the operating system family is Windows.

- `of(family: string): OperatingSystemFamily // chainable` (static) — Other operating system family.

  **Parameters**

  - `family` — operating system family.
