Package software.amazon.awscdk.services.ec2

Class GenericSSMParameterImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.GenericSSMParameterImage

All Implemented Interfaces:

IMachineImage, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AmazonLinuxImage, WindowsImage

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:18.160Z")
@Stability(Stable)
public class GenericSSMParameterImage
extends software.amazon.jsii.JsiiObject
implements IMachineImage

Select the image based on a given SSM parameter at deployment time of the CloudFormation Stack.

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.

Example:

 // 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;
 GenericSSMParameterImage genericSSMParameterImage = new GenericSSMParameterImage("parameterName", OperatingSystemType.LINUX, userData);
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IMachineImage

IMachineImage.Jsii$Default, IMachineImage.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	GenericSSMParameterImage(String parameterName, OperatingSystemType os)
	GenericSSMParameterImage(String parameterName, OperatingSystemType os, UserData userData)
protected	GenericSSMParameterImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GenericSSMParameterImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
MachineImageConfig	getImage(software.constructs.Construct scope)	Return the image to use in the given context.
String	getParameterName()	Name of the SSM parameter we're looking up.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GenericSSMParameterImage

protected GenericSSMParameterImage(software.amazon.jsii.JsiiObjectRef objRef)

GenericSSMParameterImage

protected GenericSSMParameterImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GenericSSMParameterImage

@Stability(Stable)
public GenericSSMParameterImage(@NotNull
 String parameterName,
 @NotNull
 OperatingSystemType os,
 @Nullable
 UserData userData)

Parameters:

parameterName - This parameter is required.

os - This parameter is required.

userData -

GenericSSMParameterImage

@Stability(Stable)
public GenericSSMParameterImage(@NotNull
 String parameterName,
 @NotNull
 OperatingSystemType os)

Parameters:

parameterName - This parameter is required.

os - This parameter is required.

Method Details

getImage

@Stability(Stable)
@NotNull
public MachineImageConfig getImage(@NotNull
 software.constructs.Construct scope)

Return the image to use in the given context.

Specified by:

getImage in interface IMachineImage

Parameters:

scope - This parameter is required.

getParameterName

@Stability(Stable)
@NotNull
public String getParameterName()

Name of the SSM parameter we're looking up.