Class ClusterInfo

constructor

• new ClusterInfo(cluster, version, nodeGroups?, autoscalingGroups?, fargateProfiles?): ClusterInfo

• Constructor for ClusterInfo

  Parameters

  • cluster: ICluster
  • version: KubernetesVersion
  • OptionalnodeGroups: Nodegroup[]
  • OptionalautoscalingGroups: AutoScalingGroup[]
  • OptionalfargateProfiles: FargateProfile[]

  Returns ClusterInfo

Optional ReadonlyautoscalingGroups

Readonlycluster

Optional ReadonlyfargateProfiles

Optional ReadonlynodeGroups

Readonlyversion

addAddOnContext

• addAddOnContext(addOn, values): void

• Update addonContext map

  Parameters

  • addOn: string
  • values: Values

  Returns void

addProvisionedAddOn

• addProvisionedAddOn(addOn, construct): void

• Update provisionedAddOns map

  Parameters

  • addOn: string
  • construct: Construct

  Returns void

addScheduledAddOn

• addScheduledAddOn(addOn, promise, ordered): void

• Set the preProvisionedAddOn map with the promise for the construct of the addon being provisioned

  Parameters

  • addOn: string
  • promise: Promise<Construct>
  • ordered: boolean

    if addon depends on previous addons for completion (runs serially)

  Returns void

getAddOnContexts

• getAddOnContexts(): Map<string, Values>

• Returns all addon contexts

  Returns Map<string, Values>

  addonContext: Map<string, Values>

getAllProvisionedAddons

• getAllProvisionedAddons(): Map<string, Construct>

• Returns all provisioned addons

  Returns Map<string, Construct>

  scheduledAddOns: Map<string, cdk.Construct>

getAllScheduledAddons

• getAllScheduledAddons(): Map<string, Promise<Construct>>

• Returns all scheduled addons

  Returns Map<string, Promise<Construct>>

  scheduledAddOns: Map<string, Promise<cdk.Construct>>

getProvisionedAddOn

• getProvisionedAddOn(addOn): undefined | Construct

• Given the addOn name, return the provisioned addOn construct

  Parameters

  • addOn: string

  Returns undefined | Construct

  undefined

getRequiredResource

• getRequiredResource<T>(name): T

• Same as getResource but will fail if the specified resource is not found

  Type Parameters

  • T extends IResource

  Parameters

  • name: string

    of the resource to be returned

  Returns T

  Resource object (fails if not found)

getResource

• getResource<T>(name): undefined | T

• Provides the resource registered under supplied name

  Type Parameters

  • T extends IResource

  Parameters

  • name: string

    of the resource to be returned

  Returns undefined | T

  Resource object or undefined if no resource was found

getResourceContext

• getResourceContext(): ResourceContext

• Provides the resource context object associated with this instance of the EKS Blueprint.

  Returns ResourceContext

  resource context object

getScheduledAddOn

• getScheduledAddOn(addOn): undefined | Promise<Construct>

• Returns the promise for the Addon construct

  Parameters

  • addOn: string

  Returns undefined | Promise<Construct>

  Promise<cdk.Construct>

isOrderedAddOn

• isOrderedAddOn(addOn): boolean

• Indicates if strict ordering is applied to the addon

  Parameters

  • addOn: string

    addOn key

  Returns boolean

setResourceContext

• setResourceContext(resourceContext): void

• Injection method to provide resource context.

  Parameters

  • resourceContext: ResourceContext

  Returns void