interface AmazonLinuxImageProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.AmazonLinuxImageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#AmazonLinuxImageProps
Java	software.amazon.awscdk.services.ec2.AmazonLinuxImageProps
Python	aws_cdk.aws_ec2.AmazonLinuxImageProps
TypeScript (source)	aws-cdk-lib » aws_ec2 » AmazonLinuxImageProps

Amazon Linux image properties.

Example

declare const vpc: ec2.IVpc;
const lb = new elb.LoadBalancer(this, 'LB', {
  vpc,
  internetFacing: true,
});

// instance to add as the target for load balancer.
const instance = new ec2.Instance(this, 'targetInstance', {
  vpc: vpc,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.MICRO),
  machineImage: new ec2.AmazonLinuxImage({ generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2 }),
});
lb.addTarget(new elb.InstanceTarget(instance));

Properties

Name	Type	Description
additionalCacheKey?	string	Adds an additional discriminator to the cdk.context.json cache key.
cachedInContext?	boolean	Whether the AMI ID is cached to be stable between deployments.
cpuType?	AmazonLinuxCpuType	CPU Type.
edition?	AmazonLinuxEdition	What edition of Amazon Linux to use.
generation?	AmazonLinuxGeneration	What generation of Amazon Linux to use.
kernel?	AmazonLinuxKernel	What kernel version of Amazon Linux to use.
storage?	AmazonLinuxStorage	What storage backed image to use.
userData?	UserData	Initial user data.
virtualization?	AmazonLinuxVirt	Virtualization type.

---

additionalCacheKey?

Type: string (optional, default: no additional cache key)

Adds an additional discriminator to the cdk.context.json cache key.

---

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: X86_64)

CPU Type.

---

edition?

Type: AmazonLinuxEdition (optional, default: Standard)

What edition of Amazon Linux to use.

---

generation?

Type: AmazonLinuxGeneration (optional, default: AmazonLinux)

What generation of Amazon Linux to use.

---

kernel?

Type: AmazonLinuxKernel (optional, default: -)

What kernel version of Amazon Linux to use.

---

storage?

Type: AmazonLinuxStorage (optional, default: GeneralPurpose)

What storage backed image to use.

---

userData?

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

Initial user data.

---

virtualization?

Type: AmazonLinuxVirt (optional, default: HVM)

Virtualization type.