Class AsgClusterProvider

AsgClusterProvider provisions an EKS cluster with an autoscaling group for self-managed capacity.

Hierarchy (View Summary)

GenericClusterProvider
- AsgClusterProvider

Index

Constructors

Properties

Methods

addAutoScalingGroup addFargateProfile addManagedNodeGroup createCluster getKubectlLayer internalCreateCluster

Constructors

constructor

new AsgClusterProvider(props?: AsgClusterProviderProps): AsgClusterProvider
Parameters
- Optionalprops: AsgClusterProviderProps
Returns AsgClusterProvider
Overrides GenericClusterProvider.constructor
- Defined in lib/cluster-providers/asg-cluster-provider.ts:42

Properties

`Readonly`props

props: GenericClusterProviderProps

Methods

addAutoScalingGroup

addAutoScalingGroup(
cluster: Cluster,
nodeGroup: AutoscalingNodeGroup,
): AutoScalingGroup
Adds an autoscaling group to the cluster.
Parameters
- cluster: Cluster
- nodeGroup: AutoscalingNodeGroup
Returns AutoScalingGroup
Inherited from GenericClusterProvider.addAutoScalingGroup
- Defined in lib/cluster-providers/generic-cluster-provider.ts:358

addFargateProfile

addFargateProfile(
    cluster: Cluster,
    name: string,
    profileOptions: FargateProfileOptions,
): FargateProfile
Adds a fargate profile to the cluster
Parameters
- cluster: Cluster
- name: string
- profileOptions: FargateProfileOptions
Returns FargateProfile
Inherited from GenericClusterProvider.addFargateProfile
- Defined in lib/cluster-providers/generic-cluster-provider.ts:386

addManagedNodeGroup

addManagedNodeGroup(cluster: Cluster, nodeGroup: ManagedNodeGroup): Nodegroup
Adds a managed node group to the cluster.
Parameters
- cluster: Cluster
- nodeGroup: ManagedNodeGroup
Returns Nodegroup
Inherited from GenericClusterProvider.addManagedNodeGroup
- Defined in lib/cluster-providers/generic-cluster-provider.ts:396

createCluster

createCluster(
    scope: Construct,
    vpc: IVpc,
    secretsEncryptionKey?: IKey,
    kubernetesVersion?: KubernetesVersion,
    clusterLogging?: ControlPlaneLogType[],
    ipFamily?: IpFamily,
): ClusterInfo
Parameters
- scope: Construct
- vpc: IVpc
- OptionalsecretsEncryptionKey: IKey
- OptionalkubernetesVersion: KubernetesVersion
- OptionalclusterLogging: ControlPlaneLogType[]
- OptionalipFamily: IpFamily
Returns ClusterInfo
Inherited from GenericClusterProvider.createCluster
- Defined in lib/cluster-providers/generic-cluster-provider.ts:259

`Protected`getKubectlLayer

getKubectlLayer(
scope: Construct,
version: KubernetesVersion,
): undefined | ILayerVersion
Can be overridden to provide a custom kubectl layer.
Parameters
- scope: Construct
- version: KubernetesVersion
Returns undefined | ILayerVersion
Inherited from GenericClusterProvider.getKubectlLayer
- Defined in lib/cluster-providers/generic-cluster-provider.ts:348

`Protected`internalCreateCluster

internalCreateCluster(
    scope: Construct,
    id: string,
    clusterOptions: any,
): Cluster
Template method that may be overridden by subclasses to create a specific cluster flavor (e.g. FargateCluster vs eks.Cluster)
Parameters
- scope: Construct
- id: string
- clusterOptions: any
Returns Cluster
Inherited from GenericClusterProvider.internalCreateCluster
- Defined in lib/cluster-providers/generic-cluster-provider.ts:338