Class AutoScalingGroupOptions

Options for adding an AutoScalingGroup as capacity.

Inheritance

object

AutoScalingGroupOptions

Implements

IAutoScalingGroupOptions

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

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AutoScalingGroupOptions : IAutoScalingGroupOptions

Syntax (vb)

Public Class AutoScalingGroupOptions Implements IAutoScalingGroupOptions

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;
            AutoScalingGroup asg;

            cluster.ConnectAutoScalingGroupCapacity(asg, new AutoScalingGroupOptions { });

Synopsis

Constructors

AutoScalingGroupOptions()

Options for adding an AutoScalingGroup as capacity.

Properties

BootstrapEnabled	Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke `/etc/eks/bootstrap.sh`) and associate it with the EKS cluster.
BootstrapOptions	Allows options for node bootstrapping through EC2 user data.
MachineImageType	Allow options to specify different machine image type.
MapRole	Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.
SpotInterruptHandler	Installs the AWS spot instance interrupt handler on the cluster if it's not already added.

Constructors

AutoScalingGroupOptions()

Options for adding an AutoScalingGroup as capacity.

public AutoScalingGroupOptions()

Remarks

ExampleMetadata: infused

Examples

Cluster cluster;
            AutoScalingGroup asg;

            cluster.ConnectAutoScalingGroupCapacity(asg, new AutoScalingGroupOptions { });

Properties

BootstrapEnabled

Configures the EC2 user-data script for instances in this autoscaling group to bootstrap the node (invoke /etc/eks/bootstrap.sh) and associate it with the EKS cluster.

public bool? BootstrapEnabled { get; set; }

Property Value

bool?

Remarks

If you wish to provide a custom user data script, set this to false and manually invoke autoscalingGroup.addUserData().

Default: true

BootstrapOptions

Allows options for node bootstrapping through EC2 user data.

public IBootstrapOptions? BootstrapOptions { get; set; }

Property Value

IBootstrapOptions

Remarks

Default: - default options

MachineImageType

Allow options to specify different machine image type.

public MachineImageType? MachineImageType { get; set; }

Property Value

MachineImageType?

Remarks

Default: MachineImageType.AMAZON_LINUX_2

MapRole

Will automatically update the aws-auth ConfigMap to map the IAM instance role to RBAC.

public bool? MapRole { get; set; }

Property Value

bool?

Remarks

This cannot be explicitly set to true if the cluster has kubectl disabled.

Default: - true if the cluster has kubectl enabled (which is the default).

SpotInterruptHandler

Installs the AWS spot instance interrupt handler on the cluster if it's not already added.

public bool? SpotInterruptHandler { get; set; }

Property Value

bool?

Remarks

Only relevant if spotPrice is configured on the auto-scaling group.

Default: true

Implements

IAutoScalingGroupOptions