AWS CDK Reference

Appearance

v2.274.0

EcsOptimizedImage Class ​

Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM.

Source
aws-ecs/lib/amis.ts
Type last changed
v2.96.0 · 13 Sep 2023

Example ​

ts
declare const vpc: ec2.Vpc;

const cluster = new ecs.Cluster(this, 'Cluster', {
  vpc,
});

// Either add default capacity
cluster.addCapacity('DefaultAutoScalingGroupCapacity', {
  instanceType: new ec2.InstanceType("t2.xlarge"),
});

// Or add customized capacity. Be sure to start the Amazon ECS-optimized AMI.
const autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {
  vpc,
  instanceType: new ec2.InstanceType('t2.xlarge'),
  machineImage: ecs.EcsOptimizedImage.amazonLinux(),
  // Or use Amazon ECS-Optimized Amazon Linux 2 AMI
  // machineImage: EcsOptimizedImage.amazonLinux2(),
  desiredCapacity: 3,
  // ... other options here ...
});

const capacityProvider = new ecs.AsgCapacityProvider(this, 'AsgCapacityProvider', {
  autoScalingGroup,
});
cluster.addAsgCapacityProvider(capacityProvider);

Methods ​

amazonLinux(options?: EcsOptimizedImageOptions): EcsOptimizedImage // chainable@staticmethod def amazon_linux(options: typing.Optional[EcsOptimizedImageOptions] = None) -> EcsOptimizedImagepublic static EcsOptimizedImage amazonLinux(EcsOptimizedImageOptions options)public static EcsOptimizedImage AmazonLinux(EcsOptimizedImageOptions? options = null)func AmazonLinux(Options EcsOptimizedImageOptions) EcsOptimizedImagestatic#
Construct an Amazon Linux AMI image from the latest ECS Optimized AMI published in SSM.
amazonLinux2(hardwareType?: AmiHardwareType, options?: EcsOptimizedImageOptions): EcsOptimizedImage // chainable@staticmethod def amazon_linux2(hardware_type: typing.Optional[AmiHardwareType] = None, options: typing.Optional[EcsOptimizedImageOptions] = None) -> EcsOptimizedImagepublic static EcsOptimizedImage amazonLinux2(AmiHardwareType hardwareType, EcsOptimizedImageOptions options)public static EcsOptimizedImage AmazonLinux2(AmiHardwareType? hardwareType = null, EcsOptimizedImageOptions? options = null)func AmazonLinux2(HardwareType AmiHardwareType, Options EcsOptimizedImageOptions) EcsOptimizedImagestatic#
Construct an Amazon Linux 2 image from the latest ECS Optimized AMI published in SSM.
1 parameter

Parameters

  • hardwareTypehardware_typehardwareTypehardwareTypeHardwareType — ECS-optimized AMI variant to use.
amazonLinux2023(hardwareType?: AmiHardwareType, options?: EcsOptimizedImageOptions): EcsOptimizedImage // chainable@staticmethod def amazon_linux2023(hardware_type: typing.Optional[AmiHardwareType] = None, options: typing.Optional[EcsOptimizedImageOptions] = None) -> EcsOptimizedImagepublic static EcsOptimizedImage amazonLinux2023(AmiHardwareType hardwareType, EcsOptimizedImageOptions options)public static EcsOptimizedImage AmazonLinux2023(AmiHardwareType? hardwareType = null, EcsOptimizedImageOptions? options = null)func AmazonLinux2023(HardwareType AmiHardwareType, Options EcsOptimizedImageOptions) EcsOptimizedImagestatic#
Construct an Amazon Linux 2023 image from the latest ECS Optimized AMI published in SSM.
1 parameter

Parameters

  • hardwareTypehardware_typehardwareTypehardwareTypeHardwareType — ECS-optimized AMI variant to use.
getImage(scope: Construct): MachineImageConfigdef get_image(self, scope: Construct) -> MachineImageConfigpublic MachineImageConfig getImage(Construct scope)public MachineImageConfig GetImage(Construct scope)func GetImage(Scope Construct) MachineImageConfig#
Return the correct image.
windows(windowsVersion: WindowsOptimizedVersion, options?: EcsOptimizedImageOptions): EcsOptimizedImage // chainable@staticmethod def windows(windows_version: WindowsOptimizedVersion, options: typing.Optional[EcsOptimizedImageOptions] = None) -> EcsOptimizedImagepublic static EcsOptimizedImage windows(WindowsOptimizedVersion windowsVersion, EcsOptimizedImageOptions options)public static EcsOptimizedImage Windows(WindowsOptimizedVersion windowsVersion, EcsOptimizedImageOptions? options = null)func Windows(WindowsVersion WindowsOptimizedVersion, Options EcsOptimizedImageOptions) EcsOptimizedImagestatic#
Construct a Windows image from the latest ECS Optimized AMI published in SSM.
1 parameter

Parameters

  • windowsVersionwindows_versionwindowsVersionwindowsVersionWindowsVersion — Windows Version to use.