Class EcsOptimizedImageOptions

Additional configuration properties for EcsOptimizedImage factory functions.

Inheritance

object

EcsOptimizedImageOptions

Implements

IEcsOptimizedImageOptions

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.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EcsOptimizedImageOptions : IEcsOptimizedImageOptions

Syntax (vb)

Public Class EcsOptimizedImageOptions Implements IEcsOptimizedImageOptions

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            var autoScalingGroup = new AutoScalingGroup(this, "ASG", new AutoScalingGroupProps {
                MachineImage = EcsOptimizedImage.AmazonLinux(new EcsOptimizedImageOptions { CachedInContext = true }),
                Vpc = vpc,
                InstanceType = new InstanceType("t2.micro")
            });

Synopsis

Constructors

EcsOptimizedImageOptions()

Additional configuration properties for EcsOptimizedImage factory functions.

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.

Constructors

EcsOptimizedImageOptions()

Additional configuration properties for EcsOptimizedImage factory functions.

public EcsOptimizedImageOptions()

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            var autoScalingGroup = new AutoScalingGroup(this, "ASG", new AutoScalingGroupProps {
                MachineImage = EcsOptimizedImage.AmazonLinux(new EcsOptimizedImageOptions { CachedInContext = true }),
                Vpc = vpc,
                InstanceType = new InstanceType("t2.micro")
            });

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

Implements

IEcsOptimizedImageOptions