@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-13T01:13:33.007Z")
public interface SsmParameterImageOptions
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"));
Modifier and Type | Interface and Description |
---|---|
static class |
SsmParameterImageOptions.Builder
A builder for
SsmParameterImageOptions |
static class |
SsmParameterImageOptions.Jsii$Proxy
An implementation for
SsmParameterImageOptions |
Modifier and Type | Method and Description |
---|---|
static SsmParameterImageOptions.Builder |
builder() |
default java.lang.Boolean |
getCachedInContext()
Whether the AMI ID is cached to be stable between deployments.
|
default OperatingSystemType |
getOs()
Operating system.
|
default UserData |
getUserData()
Custom UserData.
|
default java.lang.Boolean getCachedInContext()
By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.
If set to true, the AMI ID will be cached in cdk.context.json
and the
same value will be used on future runs. Your instances will not be replaced
but your AMI version will grow old over time. To refresh the AMI lookup,
you will have to evict the value from the cache using the cdk context
command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
more information.
Can not be set to true
in environment-agnostic stacks.
Default: false
default OperatingSystemType getOs()
Default: OperatingSystemType.LINUX
default UserData getUserData()
Default: - UserData appropriate for the OS
static SsmParameterImageOptions.Builder builder()
SsmParameterImageOptions.Builder
of SsmParameterImageOptions