aws-cdk-lib.aws_ec2.AmazonLinux2ImageSsmParameter

class AmazonLinux2ImageSsmParameter

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

Implements IMachineImage

Extends AmazonLinuxImageSsmParameterBase

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

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 amazonLinux2Kernel: ec2.AmazonLinux2Kernel;
declare const userData: ec2.UserData;
const amazonLinux2ImageSsmParameter = new ec2.AmazonLinux2ImageSsmParameter({
  cachedInContext: false,
  cpuType: ec2.AmazonLinuxCpuType.ARM_64,
  edition: ec2.AmazonLinuxEdition.STANDARD,
  kernel: amazonLinux2Kernel,
  storage: ec2.AmazonLinuxStorage.EBS,
  userData: userData,
  virtualization: ec2.AmazonLinuxVirt.HVM,
});

Initializer

new AmazonLinux2ImageSsmParameter(props: AmazonLinux2ImageSsmParameterProps)

Parameters

  • props AmazonLinux2ImageSsmParameterProps

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 2 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: AmazonLinux2ImageSsmParameterProps): string

Parameters

  • props AmazonLinux2ImageSsmParameterProps

Returns

  • string

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

Example values:

"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs"