AWS CDK Reference

Appearance

v2.274.0

GenericWindowsImage Class ​

Construct a Windows machine image from an AMI map.

Allows you to create a generic Windows EC2 , manually specify an AMI map.

Source
aws-ec2/lib/machine-image/machine-image.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const userData: ec2.UserData;
const genericWindowsImage = new ec2.GenericWindowsImage({
  amiMapKey: 'amiMap',
}, /* all optional props */ {
  userData: userData,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# user_data: ec2.UserData

generic_windows_image = ec2.GenericWindowsImage({
    "ami_map_key": "amiMap"
},
    user_data=user_data
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

UserData userData;

GenericWindowsImage genericWindowsImage = GenericWindowsImage.Builder.create(Map.of(
        "amiMapKey", "amiMap"))
.userData(userData)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

UserData userData;

var genericWindowsImage = new GenericWindowsImage(new Dictionary<string, string> {
    { "amiMapKey", "amiMap" }
}, new GenericWindowsImageProps {
    UserData = userData
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var userData UserData

genericWindowsImage := awscdk.Aws_ec2.NewGenericWindowsImage(map[string]*string{
	"amiMapKey": jsii.String("amiMap"),
}, &GenericWindowsImageProps{
	UserData: userData,
})

Initializer ​

ts
new GenericWindowsImage(amiMap: { [key: string]: string }, props?: GenericWindowsImageProps)
python
GenericWindowsImage(ami_map: typing.Mapping[str, str], props: typing.Optional[GenericWindowsImageProps] = None)
java
new GenericWindowsImage(Map<String, String> amiMap, GenericWindowsImageProps props)
csharp
new GenericWindowsImage(IDictionary<string, string> amiMap, GenericWindowsImageProps? props = null)
go
NewGenericWindowsImage(AmiMap *map[string]*string, Props GenericWindowsImageProps)

Methods ​

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 image to use in the given context.