aws-cdk-lib.aws_ec2.AmazonLinux2023ImageSsmParameter

class AmazonLinux2023ImageSsmParameter

LanguageType name
.NETAmazon.CDK.AWS.EC2.AmazonLinux2023ImageSsmParameter
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#AmazonLinux2023ImageSsmParameter
Javasoftware.amazon.awscdk.services.ec2.AmazonLinux2023ImageSsmParameter
Pythonaws_cdk.aws_ec2.AmazonLinux2023ImageSsmParameter
TypeScript (source)aws-cdk-lib » aws_ec2 » AmazonLinux2023ImageSsmParameter

Implements IMachineImage

Extends AmazonLinuxImageSsmParameterBase

A SSM Parameter that contains the AMI ID for Amazon Linux 2023.

Example

declare const vpc: ec2.Vpc;

new ec2.Instance(this, 'LatestAl2023', {
  vpc,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.C7G, ec2.InstanceSize.LARGE),
  machineImage: ec2.MachineImage.latestAmazonLinux2023({
    cachedInContext: true, // default is false
  }),
});

// or
new ec2.Instance(this, 'LatestAl2023', {
  vpc,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.C7G, ec2.InstanceSize.LARGE),
  // context cache is turned on by default
  machineImage: new ec2.AmazonLinux2023ImageSsmParameter(),
});

Initializer

new AmazonLinux2023ImageSsmParameter(props?: AmazonLinux2023ImageSsmParameterProps)

Parameters

  • props AmazonLinux2023ImageSsmParameterProps

Methods

NameDescription
getImage(scope)Return the image to use in the given context.
static ssmParameterName(props)Generates a SSM Parameter name for a specific amazon linux 2022 AMI.

getImage(scope)

public getImage(scope: Construct): MachineImageConfig

Parameters

  • scope Construct

Returns

  • MachineImageConfig

Return the image to use in the given context.


static ssmParameterName(props)

public static ssmParameterName(props: AmazonLinux2023ImageSsmParameterProps): string

Parameters

  • props AmazonLinux2023ImageSsmParameterProps

Returns

  • string

Generates a SSM Parameter name for a specific amazon linux 2022 AMI.

Example values:

"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64",