Interface IBottleRocketImageProps

Properties for BottleRocketImage.

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public interface IBottleRocketImageProps

Syntax (vb)

Public Interface IBottleRocketImageProps

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;
using Amazon.CDK.AWS.ECS;

var bottleRocketImageProps = new BottleRocketImageProps {
    Architecture = InstanceArchitecture.ARM_64,
    CachedInContext = false,
    Variant = BottlerocketEcsVariant.AWS_ECS_1
};

Synopsis

Properties

Architecture	The CPU architecture.
CachedInContext	Whether the AMI ID is cached to be stable between deployments.
Variant	The Amazon ECS variant to use.

Properties

Architecture

The CPU architecture.

virtual Nullable<InstanceArchitecture> Architecture { get; }

Property Value

System.Nullable<InstanceArchitecture>

Remarks

Default: - x86_64

CachedInContext

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

virtual Nullable<bool> CachedInContext { get; }

Property Value

System.Nullable<System.Boolean>

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

Variant

The Amazon ECS variant to use.

virtual Nullable<BottlerocketEcsVariant> Variant { get; }

Property Value

System.Nullable<BottlerocketEcsVariant>

Remarks

Only aws-ecs-1 is currently available

Default: - BottlerocketEcsVariant.AWS_ECS_1