io.cloudshiftdev.awscdk.services.ec2.LookupMachineImageProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ec2
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* 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"));
* ```
*/
public interface LookupMachineImageProps {
/**
* Additional filters on the AMI.
*
* Default: - No additional filters
*
* [Documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html)
*/
public fun filters(): Map> = unwrap(this).getFilters() ?: emptyMap()
/**
* Name of the image (may contain wildcards).
*/
public fun name(): String
/**
* Owner account IDs or aliases.
*
* Default: - All owners
*/
public fun owners(): List = unwrap(this).getOwners() ?: emptyList()
/**
* Custom userdata for this image.
*
* Default: - Empty user data appropriate for the platform type
*/
public fun userData(): UserData? = unwrap(this).getUserData()?.let(UserData::wrap)
/**
* Look for Windows images.
*
* Default: false
*/
public fun windows(): Boolean? = unwrap(this).getWindows()
/**
* A builder for [LookupMachineImageProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param filters Additional filters on the AMI.
*/
public fun filters(filters: Map>)
/**
* @param name Name of the image (may contain wildcards).
*/
public fun name(name: String)
/**
* @param owners Owner account IDs or aliases.
*/
public fun owners(owners: List)
/**
* @param owners Owner account IDs or aliases.
*/
public fun owners(vararg owners: String)
/**
* @param userData Custom userdata for this image.
*/
public fun userData(userData: UserData)
/**
* @param windows Look for Windows images.
*/
public fun windows(windows: Boolean)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.ec2.LookupMachineImageProps.Builder =
software.amazon.awscdk.services.ec2.LookupMachineImageProps.builder()
/**
* @param filters Additional filters on the AMI.
*/
override fun filters(filters: Map>) {
cdkBuilder.filters(filters)
}
/**
* @param name Name of the image (may contain wildcards).
*/
override fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param owners Owner account IDs or aliases.
*/
override fun owners(owners: List) {
cdkBuilder.owners(owners)
}
/**
* @param owners Owner account IDs or aliases.
*/
override fun owners(vararg owners: String): Unit = owners(owners.toList())
/**
* @param userData Custom userdata for this image.
*/
override fun userData(userData: UserData) {
cdkBuilder.userData(userData.let(UserData.Companion::unwrap))
}
/**
* @param windows Look for Windows images.
*/
override fun windows(windows: Boolean) {
cdkBuilder.windows(windows)
}
public fun build(): software.amazon.awscdk.services.ec2.LookupMachineImageProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ec2.LookupMachineImageProps,
) : CdkObject(cdkObject),
LookupMachineImageProps {
/**
* Additional filters on the AMI.
*
* Default: - No additional filters
*
* [Documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html)
*/
override fun filters(): Map> = unwrap(this).getFilters() ?: emptyMap()
/**
* Name of the image (may contain wildcards).
*/
override fun name(): String = unwrap(this).getName()
/**
* Owner account IDs or aliases.
*
* Default: - All owners
*/
override fun owners(): List = unwrap(this).getOwners() ?: emptyList()
/**
* Custom userdata for this image.
*
* Default: - Empty user data appropriate for the platform type
*/
override fun userData(): UserData? = unwrap(this).getUserData()?.let(UserData::wrap)
/**
* Look for Windows images.
*
* Default: false
*/
override fun windows(): Boolean? = unwrap(this).getWindows()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): LookupMachineImageProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.ec2.LookupMachineImageProps):
LookupMachineImageProps = CdkObjectWrappers.wrap(cdkObject) as? LookupMachineImageProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: LookupMachineImageProps):
software.amazon.awscdk.services.ec2.LookupMachineImageProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.ec2.LookupMachineImageProps
}
}