software.amazon.awscdk.services.ec2

Class GenericSSMParameterImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.GenericSSMParameterImage

All Implemented Interfaces:

IMachineImage

Direct Known Subclasses:

AmazonLinuxImage, WindowsImage

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.341Z")
public class GenericSSMParameterImage
extends software.amazon.jsii.JsiiObject
implements IMachineImage

Select the image based on a given SSM parameter.

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 interface software.amazon.awscdk.services.ec2.IMachineImage

IMachineImage.Jsii$Default, IMachineImage.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSSMParameterImage

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

GenericSSMParameterImage

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

GenericSSMParameterImage

public GenericSSMParameterImage(java.lang.String parameterName,
                                OperatingSystemType os,
                                UserData userData)

Parameters:

parameterName - This parameter is required.

os - This parameter is required.

userData -

GenericSSMParameterImage

public GenericSSMParameterImage(java.lang.String parameterName,
                                OperatingSystemType os)

Parameters:

parameterName - This parameter is required.

os - This parameter is required.

Method Detail

getImage

public MachineImageConfig getImage(Construct scope)

Return the image to use in the given context.

Specified by:

getImage in interface IMachineImage

Parameters:

scope - This parameter is required.

getParameterName

public java.lang.String getParameterName()

Name of the SSM parameter we're looking up.