aws-cdk-lib.aws_ec2.AmazonLinux2023ImageSsmParameterProps

interface AmazonLinux2023ImageSsmParameterProps

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

Properties specific to al2023 images.

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(),
});

Properties

NameTypeDescription
cachedInContext?booleanWhether the AMI ID is cached to be stable between deployments.
cpuType?AmazonLinuxCpuTypeCPU Type.
edition?AmazonLinuxEditionWhat edition of Amazon Linux to use.
kernel?AmazonLinux2023KernelWhat kernel version of Amazon Linux to use.
userData?UserDataInitial user data.

cachedInContext?

Type: boolean (optional, default: false)

Whether the AMI ID is cached to be stable between deployments.

By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.

If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

Can not be set to true in environment-agnostic stacks.


cpuType?

Type: AmazonLinuxCpuType (optional, default: AmazonLinuxCpuType.X86_64)

CPU Type.


edition?

Type: AmazonLinuxEdition (optional, default: AmazonLinuxEdition.Standard)

What edition of Amazon Linux to use.


kernel?

Type: AmazonLinux2023Kernel (optional, default: AmazonLinux2023Kernel.DEFAULT)

What kernel version of Amazon Linux to use.


userData?

Type: UserData (optional, default: Empty UserData for Linux machines)

Initial user data.