AmazonLinuxImageSsmParameterBaseProps

class aws_cdk.aws_ec2.AmazonLinuxImageSsmParameterBaseProps(*, cached_in_context=None, user_data=None, parameter_name)

Bases: AmazonLinuxImageSsmParameterBaseOptions

Base properties for an Amazon Linux SSM Parameter.

Parameters:

  • 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

  • parameter_name (str) – The name of the SSM parameter that contains the AMI value.

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

amazon_linux_image_ssm_parameter_base_props = ec2.AmazonLinuxImageSsmParameterBaseProps(
    parameter_name="parameterName",

    # the properties below are optional
    cached_in_context=False,
    user_data=user_data
)

Attributes

cached_in_context

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

parameter_name

The name of the SSM parameter that contains the AMI value.

user_data

Initial user data.

Default:

  • Empty UserData for Linux machines