Interface IAmazonLinuxImageSsmParameterBaseOptions

Base options for amazon linux ssm parameters.

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IAmazonLinuxImageSsmParameterBaseOptions

Syntax (vb)

Public Interface 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;

            UserData userData;

            var amazonLinuxImageSsmParameterBaseOptions = new AmazonLinuxImageSsmParameterBaseOptions {
                AdditionalCacheKey = "additionalCacheKey",
                CachedInContext = false,
                UserData = userData
            };

Synopsis

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.
UserData	Initial user data.

Properties

AdditionalCacheKey

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

string? AdditionalCacheKey { get; }

Property Value

string

Remarks

Default: - no additional cache key

CachedInContext

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

bool? CachedInContext { get; }

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

UserData

Initial user data.

UserData? UserData { get; }

Property Value

UserData

Remarks

Default: - Empty UserData for Linux machines