class ResolveSsmParameterAtLaunchImage
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.EC2.ResolveSsmParameterAtLaunchImage |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#ResolveSsmParameterAtLaunchImage |
Java | software.amazon.awscdk.services.ec2.ResolveSsmParameterAtLaunchImage |
Python | aws_cdk.aws_ec2.ResolveSsmParameterAtLaunchImage |
TypeScript (source) | aws-cdk-lib » aws_ec2 » ResolveSsmParameterAtLaunchImage |
Implements
IMachine
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:
See also: [https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
The AMI ID would be selected at instance launch time.](https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
The AMI ID would be selected at instance launch time.)
Example
// 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 */ {
cachedInContext: false,
os: ec2.OperatingSystemType.LINUX,
parameterVersion: 'parameterVersion',
userData: userData,
});
Initializer
new ResolveSsmParameterAtLaunchImage(parameterName: string, props?: SsmParameterImageOptions)
Parameters
- parameterName
string
- props
Ssm
Parameter Image Options
Properties
Name | Type | Description |
---|---|---|
parameter | string | Name of the SSM parameter we're looking up. |
parameterName
Type:
string
Name of the SSM parameter we're looking up.
Methods
Name | Description |
---|---|
get | Return the image to use in the given context. |
Image(_)
getpublic getImage(_: Construct): MachineImageConfig
Parameters
Returns
Return the image to use in the given context.