Show / Hide Table of Contents

Class AmazonLinux2022ImageSsmParameterProps

Properties specific to al2022 images.

Inheritance
object
AmazonLinux2022ImageSsmParameterProps
Implements
IAmazonLinux2022ImageSsmParameterProps
IAmazonLinuxImageSsmParameterCommonOptions
IAmazonLinuxImageSsmParameterBaseOptions
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AmazonLinux2022ImageSsmParameterProps : IAmazonLinux2022ImageSsmParameterProps, IAmazonLinuxImageSsmParameterCommonOptions, IAmazonLinuxImageSsmParameterBaseOptions
Syntax (vb)
Public Class AmazonLinux2022ImageSsmParameterProps Implements IAmazonLinux2022ImageSsmParameterProps, IAmazonLinuxImageSsmParameterCommonOptions, IAmazonLinuxImageSsmParameterBaseOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;

            AmazonLinux2022Kernel amazonLinux2022Kernel;
            UserData userData;

            var amazonLinux2022ImageSsmParameterProps = new AmazonLinux2022ImageSsmParameterProps {
                AdditionalCacheKey = "additionalCacheKey",
                CachedInContext = false,
                CpuType = AmazonLinuxCpuType.ARM_64,
                Edition = AmazonLinuxEdition.STANDARD,
                Kernel = amazonLinux2022Kernel,
                UserData = userData
            };

Synopsis

Constructors

AmazonLinux2022ImageSsmParameterProps()

Properties specific to al2022 images.

Properties

AdditionalCacheKey

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

CachedInContext

Whether the AMI ID is cached to be stable between deployments.

CpuType

CPU Type.

Edition

What edition of Amazon Linux to use.

Kernel

What kernel version of Amazon Linux to use.

UserData

Initial user data.

Constructors

AmazonLinux2022ImageSsmParameterProps()

Properties specific to al2022 images.

public AmazonLinux2022ImageSsmParameterProps()
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;

            AmazonLinux2022Kernel amazonLinux2022Kernel;
            UserData userData;

            var amazonLinux2022ImageSsmParameterProps = new AmazonLinux2022ImageSsmParameterProps {
                AdditionalCacheKey = "additionalCacheKey",
                CachedInContext = false,
                CpuType = AmazonLinuxCpuType.ARM_64,
                Edition = AmazonLinuxEdition.STANDARD,
                Kernel = amazonLinux2022Kernel,
                UserData = userData
            };

Properties

AdditionalCacheKey

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

public string? AdditionalCacheKey { get; set; }
Property Value

string

Remarks

Default: - no additional cache key

CachedInContext

Whether the AMI ID is cached to be stable between deployments.

public bool? CachedInContext { get; set; }
Property Value

bool?

Remarks

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

CpuType

CPU Type.

public AmazonLinuxCpuType? CpuType { get; set; }
Property Value

AmazonLinuxCpuType?

Remarks

Default: AmazonLinuxCpuType.X86_64

Edition

What edition of Amazon Linux to use.

public AmazonLinuxEdition? Edition { get; set; }
Property Value

AmazonLinuxEdition?

Remarks

Default: AmazonLinuxEdition.Standard

Kernel

What kernel version of Amazon Linux to use.

public AmazonLinux2022Kernel? Kernel { get; set; }
Property Value

AmazonLinux2022Kernel

Remarks

Default: AmazonLinux2022Kernel.DEFAULT

UserData

Initial user data.

public UserData? UserData { get; set; }
Property Value

UserData

Remarks

Default: - Empty UserData for Linux machines

Implements

IAmazonLinux2022ImageSsmParameterProps
IAmazonLinuxImageSsmParameterCommonOptions
IAmazonLinuxImageSsmParameterBaseOptions
Back to top Generated by DocFX