AmazonLinux2ImageSsmParameter

class aws_cdk.aws_ec2.AmazonLinux2ImageSsmParameter(*, kernel=None, storage=None, virtualization=None, cpu_type=None, edition=None, cached_in_context=None, user_data=None)

Bases: AmazonLinuxImageSsmParameterBase

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# amazon_linux2_kernel: ec2.AmazonLinux2Kernel
# user_data: ec2.UserData

amazon_linux2_image_ssm_parameter = ec2.AmazonLinux2ImageSsmParameter(
    cached_in_context=False,
    cpu_type=ec2.AmazonLinuxCpuType.ARM_64,
    edition=ec2.AmazonLinuxEdition.STANDARD,
    kernel=amazon_linux2_kernel,
    storage=ec2.AmazonLinuxStorage.EBS,
    user_data=user_data,
    virtualization=ec2.AmazonLinuxVirt.HVM
)
Parameters:

  • kernel (Optional[AmazonLinux2Kernel]) – What kernel version of Amazon Linux to use. Default: -

  • storage (Optional[AmazonLinuxStorage]) – What storage backed image to use. Default: GeneralPurpose

  • virtualization (Optional[AmazonLinuxVirt]) – Virtualization type. Default: HVM

  • cpu_type (Optional[AmazonLinuxCpuType]) – CPU Type. Default: AmazonLinuxCpuType.X86_64

  • edition (Optional[AmazonLinuxEdition]) – What edition of Amazon Linux to use. Default: AmazonLinuxEdition.Standard

  • cached_in_context (Optional[bool]) – 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. Default: false

  • user_data (Optional[UserData]) – Initial user data. Default: - Empty UserData for Linux machines

Methods

get_image(scope)

Return the image to use in the given context.

Parameters:

scope (Construct) –

Return type:

MachineImageConfig

Static Methods

classmethod ssm_parameter_name(*, kernel=None, storage=None, virtualization=None, cpu_type=None, edition=None, cached_in_context=None, user_data=None)

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"
Parameters:

  • kernel (Optional[AmazonLinux2Kernel]) – What kernel version of Amazon Linux to use. Default: -

  • storage (Optional[AmazonLinuxStorage]) – What storage backed image to use. Default: GeneralPurpose

  • virtualization (Optional[AmazonLinuxVirt]) – Virtualization type. Default: HVM

  • cpu_type (Optional[AmazonLinuxCpuType]) – CPU Type. Default: AmazonLinuxCpuType.X86_64

  • edition (Optional[AmazonLinuxEdition]) – What edition of Amazon Linux to use. Default: AmazonLinuxEdition.Standard

  • cached_in_context (Optional[bool]) – 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. Default: false

  • user_data (Optional[UserData]) – Initial user data. Default: - Empty UserData for Linux machines

Return type:

str