AWS CDK Reference

Appearance

v2.273.0

ResolveSsmParameterAtLaunchImage Class ​

Select the image based on a given SSM parameter at instance launch time.

This Machine Image comes with an imageId as resolve:ssm:parameter-name or resolve:ssm:parameter-name:version format as described in the document:

Source
aws-ec2/lib/machine-image/machine-image.ts
Type last changed
v2.209.0 · 5 Aug 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const userData: ec2.UserData;
const resolveSsmParameterAtLaunchImage = new ec2.ResolveSsmParameterAtLaunchImage('parameterName', /* all optional props */ {
  additionalCacheKey: 'additionalCacheKey',
  cachedInContext: false,
  os: ec2.OperatingSystemType.LINUX,
  parameterVersion: 'parameterVersion',
  userData: userData,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# user_data: ec2.UserData

resolve_ssm_parameter_at_launch_image = ec2.ResolveSsmParameterAtLaunchImage("parameterName",
    additional_cache_key="additionalCacheKey",
    cached_in_context=False,
    os=ec2.OperatingSystemType.LINUX,
    parameter_version="parameterVersion",
    user_data=user_data
)
java
// 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;

ResolveSsmParameterAtLaunchImage resolveSsmParameterAtLaunchImage = ResolveSsmParameterAtLaunchImage.Builder.create("parameterName")
        .additionalCacheKey("additionalCacheKey")
        .cachedInContext(false)
        .os(OperatingSystemType.LINUX)
        .parameterVersion("parameterVersion")
        .userData(userData)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

UserData userData;

var resolveSsmParameterAtLaunchImage = new ResolveSsmParameterAtLaunchImage("parameterName", new SsmParameterImageOptions {
    AdditionalCacheKey = "additionalCacheKey",
    CachedInContext = false,
    Os = OperatingSystemType.LINUX,
    ParameterVersion = "parameterVersion",
    UserData = userData
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var userData UserData

resolveSsmParameterAtLaunchImage := awscdk.Aws_ec2.NewResolveSsmParameterAtLaunchImage(jsii.String("parameterName"), &SsmParameterImageOptions{
	AdditionalCacheKey: jsii.String("additionalCacheKey"),
	CachedInContext: jsii.Boolean(false),
	Os: awscdk.*Aws_ec2.OperatingSystemType_LINUX,
	ParameterVersion: jsii.String("parameterVersion"),
	UserData: userData,
})

Initializer ​

ts
new ResolveSsmParameterAtLaunchImage(parameterName: string, props?: SsmParameterImageOptions)
python
ResolveSsmParameterAtLaunchImage(parameter_name: str, props: typing.Optional[SsmParameterImageOptions] = None)
java
new ResolveSsmParameterAtLaunchImage(String parameterName, SsmParameterImageOptions props)
csharp
new ResolveSsmParameterAtLaunchImage(string parameterName, SsmParameterImageOptions? props = null)
go
NewResolveSsmParameterAtLaunchImage(ParameterName *string, Props SsmParameterImageOptions)

Properties ​

parameterNamestringparameter_namestrparameterNameStringParameterNamestringParameterName*stringrequired#
Name of the SSM parameter we're looking up.

Methods ​

getImage(_scope: Construct): MachineImageConfigdef get_image(self, _scope: Construct) -> MachineImageConfigpublic MachineImageConfig getImage(Construct _scope)public MachineImageConfig GetImage(Construct _scope)func GetImage(_scope Construct) MachineImageConfig#
Return the image to use in the given context.