aws-cdk-lib.aws_ec2.AmazonLinuxImageSsmParameterCommonOptions

interface AmazonLinuxImageSsmParameterCommonOptions

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

Common options across all generations.

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 amazonLinuxImageSsmParameterCommonOptions: ec2.AmazonLinuxImageSsmParameterCommonOptions = {
  cachedInContext: false,
  cpuType: ec2.AmazonLinuxCpuType.ARM_64,
  edition: ec2.AmazonLinuxEdition.STANDARD,
  userData: userData,
};

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.
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.


userData?

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

Initial user data.