Show / Hide Table of Contents

Class WindowsImage

Select the latest version of the indicated Windows version.

Inheritance
object
GenericSSMParameterImage
WindowsImage
Implements
IMachineImage
Inherited Members
GenericSSMParameterImage.GetImage(Construct)
GenericSSMParameterImage.ParameterName
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WindowsImage : GenericSSMParameterImage, IMachineImage
Syntax (vb)
Public Class WindowsImage Inherits GenericSSMParameterImage Implements IMachineImage
Remarks

This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.

The AMI ID is selected using the values published to the SSM parameter store.

https://aws.amazon.com/blogs/mt/query-for-the-latest-windows-ami-using-systems-manager-parameter-store/

ExampleMetadata: lit=aws-autoscaling/test/example.images.lit.ts infused

Examples
// Pick a Windows edition to use
             var windows = new WindowsImage(WindowsVersion.WINDOWS_SERVER_2019_ENGLISH_FULL_BASE);

             // Pick the right Amazon Linux edition. All arguments shown are optional
             // and will default to these values when omitted.
             var amznLinux = new AmazonLinuxImage(new AmazonLinuxImageProps {
                 Generation = AmazonLinuxGeneration.AMAZON_LINUX,
                 Edition = AmazonLinuxEdition.STANDARD,
                 Virtualization = AmazonLinuxVirt.HVM,
                 Storage = AmazonLinuxStorage.GENERAL_PURPOSE
             });

             // For other custom (Linux) images, instantiate a `GenericLinuxImage` with
             // a map giving the AMI to in for each region:

             var linux = new GenericLinuxImage(new Dictionary<string, string> {
                 { "us-east-1", "ami-97785bed" },
                 { "eu-west-1", "ami-12345678" }
             });

Synopsis

Constructors

WindowsImage(WindowsVersion, IWindowsImageProps?)

Select the latest version of the indicated Windows version.

Constructors

WindowsImage(WindowsVersion, IWindowsImageProps?)

Select the latest version of the indicated Windows version.

public WindowsImage(WindowsVersion version, IWindowsImageProps? props = null)
Parameters
version WindowsVersion
props IWindowsImageProps
Remarks

This Machine Image automatically updates to the latest version on every deployment. Be aware this will cause your instances to be replaced when a new version of the image becomes available. Do not store stateful information on the instance if you are using this image.

The AMI ID is selected using the values published to the SSM parameter store.

https://aws.amazon.com/blogs/mt/query-for-the-latest-windows-ami-using-systems-manager-parameter-store/

ExampleMetadata: lit=aws-autoscaling/test/example.images.lit.ts infused

Examples
// Pick a Windows edition to use
             var windows = new WindowsImage(WindowsVersion.WINDOWS_SERVER_2019_ENGLISH_FULL_BASE);

             // Pick the right Amazon Linux edition. All arguments shown are optional
             // and will default to these values when omitted.
             var amznLinux = new AmazonLinuxImage(new AmazonLinuxImageProps {
                 Generation = AmazonLinuxGeneration.AMAZON_LINUX,
                 Edition = AmazonLinuxEdition.STANDARD,
                 Virtualization = AmazonLinuxVirt.HVM,
                 Storage = AmazonLinuxStorage.GENERAL_PURPOSE
             });

             // For other custom (Linux) images, instantiate a `GenericLinuxImage` with
             // a map giving the AMI to in for each region:

             var linux = new GenericLinuxImage(new Dictionary<string, string> {
                 { "us-east-1", "ami-97785bed" },
                 { "eu-west-1", "ami-12345678" }
             });

Implements

IMachineImage
Back to top Generated by DocFX