ResolveSsmParameterAtLaunchImage

class aws_cdk.aws_ec2.ResolveSsmParameterAtLaunchImage(parameter_name, *, cached_in_context=None, os=None, parameter_version=None, user_data=None)

Bases: object

Select the image based on a given SSM parameter at instance launch time.

This Machine Image comes with an imageId as resolve:ssm:parameter-name or resolve:ssm:parameter-name:version format as described in the document:

See:

https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html

The AMI ID would be selected at instance launch time. :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

# user_data: ec2.UserData

resolve_ssm_parameter_at_launch_image = ec2.ResolveSsmParameterAtLaunchImage("parameterName",
    cached_in_context=False,
    os=ec2.OperatingSystemType.LINUX,
    parameter_version="parameterVersion",
    user_data=user_data
)
Parameters:

  • parameter_name (str) –

  • 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

  • os (Optional[OperatingSystemType]) – Operating system. Default: OperatingSystemType.LINUX

  • parameter_version (Optional[str]) – The version of the SSM parameter. Default: no version specified.

  • user_data (Optional[UserData]) – Custom UserData. Default: - UserData appropriate for the OS

Methods

get_image(_)

Return the image to use in the given context.

Parameters:

_ –

Return type:

MachineImageConfig

Attributes

parameter_name

Name of the SSM parameter we’re looking up.