software.amazon.awscdk.services.ec2

Interface LookupMachineImageProps

All Known Implementing Classes:

LookupMachineImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.442Z")
public interface LookupMachineImageProps

Properties for looking up an image.

Example:

 // Pick the right Amazon Linux edition. All arguments shown are optional
 // and will default to these values when omitted.
 IMachineImage amznLinux = MachineImage.latestAmazonLinux(AmazonLinuxImageProps.builder()
         .generation(AmazonLinuxGeneration.AMAZON_LINUX)
         .edition(AmazonLinuxEdition.STANDARD)
         .virtualization(AmazonLinuxVirt.HVM)
         .storage(AmazonLinuxStorage.GENERAL_PURPOSE)
         .cpuType(AmazonLinuxCpuType.X86_64)
         .build());
 // Pick a Windows edition to use
 IMachineImage windows = MachineImage.latestWindows(WindowsVersion.WINDOWS_SERVER_2019_ENGLISH_FULL_BASE);
 // Read AMI id from SSM parameter store
 IMachineImage ssm = MachineImage.fromSsmParameter("/my/ami", SsmParameterImageOptions.builder().os(OperatingSystemType.LINUX).build());
 // Look up the most recent image matching a set of AMI filters.
 // In this case, look up the NAT instance AMI, by using a wildcard
 // in the 'name' field:
 IMachineImage natAmi = MachineImage.lookup(LookupMachineImageProps.builder()
         .name("amzn-ami-vpc-nat-*")
         .owners(List.of("amazon"))
         .build());
 // For other custom (Linux) images, instantiate a `GenericLinuxImage` with
 // a map giving the AMI to in for each region:
 IMachineImage linux = MachineImage.genericLinux(Map.of(
         "us-east-1", "ami-97785bed",
         "eu-west-1", "ami-12345678"));
 // For other custom (Windows) images, instantiate a `GenericWindowsImage` with
 // a map giving the AMI to in for each region:
 IMachineImage genericWindows = MachineImage.genericWindows(Map.of(
         "us-east-1", "ami-97785bed",
         "eu-west-1", "ami-12345678"));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LookupMachineImageProps.Builder A builder for LookupMachineImageProps
static class	LookupMachineImageProps.Jsii$Proxy An implementation for LookupMachineImageProps

Method Summary

Modifier and Type	Method and Description
static LookupMachineImageProps.Builder	builder()
default java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getFilters() Additional filters on the AMI.
java.lang.String	getName() Name of the image (may contain wildcards).
default java.util.List<java.lang.String>	getOwners() Owner account IDs or aliases.
default UserData	getUserData() Custom userdata for this image.
default java.lang.Boolean	getWindows() Look for Windows images.

Method Detail

getName

java.lang.String getName()

Name of the image (may contain wildcards).

getFilters

default java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilters()

Additional filters on the AMI.

Default: - No additional filters

See Also:

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html

getOwners

default java.util.List<java.lang.String> getOwners()

Owner account IDs or aliases.

Default: - All owners

getUserData

default UserData getUserData()

Custom userdata for this image.

Default: - Empty user data appropriate for the platform type

getWindows

default java.lang.Boolean getWindows()

Look for Windows images.

Default: false

builder

static LookupMachineImageProps.Builder builder()

Returns:

a LookupMachineImageProps.Builder of LookupMachineImageProps