Class WindowsBuilder

This builder class helps you prepare a blueprint for setting up windows nodes with EKS cluster. The WindowsBuilder creates the following:

An EKS Cluster` with passed k8s version and cluster tags.
A non-windows nodegroup for standard software.
A windows nodegroup to schedule windows workloads

Hierarchy (view full)

BlueprintBuilder
- WindowsBuilder

Constructors

constructor

new WindowsBuilder(): WindowsBuilder
Returns WindowsBuilder
Inherited from BlueprintBuilder.constructor
- Defined in lib/stacks/eks-blueprint-stack.ts:13

Properties

env

env: {
account?: string;
region?: string;
}

props

props: Partial<EksBlueprintProps>

Methods

account

account(account?): this
Parameters
- Optionalaccount: string
Returns this
Inherited from BlueprintBuilder.account
- Defined in lib/stacks/eks-blueprint-construct.ts:136

addOns

addOns(...addOns): this
Parameters
- Rest...addOns: ClusterAddOn[]
Returns this
Inherited from BlueprintBuilder.addOns
- Defined in lib/stacks/eks-blueprint-construct.ts:178

build

build(scope, id, stackProps?): EksBlueprint
Parameters
- scope: Construct
- id: string
- OptionalstackProps: StackProps
Returns EksBlueprint
Inherited from BlueprintBuilder.build
- Defined in lib/stacks/eks-blueprint-stack.ts:22

buildAsync

buildAsync(scope, id, stackProps?): Promise<EksBlueprint>
Parameters
- scope: Construct
- id: string
- OptionalstackProps: StackProps
Returns Promise<EksBlueprint>
Inherited from BlueprintBuilder.buildAsync
- Defined in lib/stacks/eks-blueprint-stack.ts:37

clone

clone(region?, account?): BlueprintBuilder
Parameters
- Optionalregion: string
- Optionalaccount: string
Returns BlueprintBuilder
Inherited from BlueprintBuilder.clone
- Defined in lib/stacks/eks-blueprint-stack.ts:18

clusterProvider

clusterProvider(clusterProvider): WindowsBuilder
Parameters
- clusterProvider: ClusterProvider
Returns WindowsBuilder
Inherited from BlueprintBuilder.clusterProvider
- Defined in lib/stacks/eks-blueprint-construct.ts:183

compatibilityMode

compatibilityMode(compatibilityMode): BlueprintBuilder
Sets compatibility mode
Parameters
- compatibilityMode: boolean
  if true will attach blueprints resources directly to the stack.
Returns BlueprintBuilder
Inherited from BlueprintBuilder.compatibilityMode
- Defined in lib/stacks/eks-blueprint-stack.ts:32

enableControlPlaneLogTypes

enableControlPlaneLogTypes(...types): this
Parameters
- Rest...types: ControlPlaneLogType[]
Returns this
Inherited from BlueprintBuilder.enableControlPlaneLogTypes
- Defined in lib/stacks/eks-blueprint-construct.ts:159

enableGitOps

enableGitOps(mode?): this
Parameters
- Optionalmode: GitOpsMode
Returns this
Inherited from BlueprintBuilder.enableGitOps
- Defined in lib/stacks/eks-blueprint-construct.ts:164

enableKarpenter

enableKarpenter(): WindowsBuilder
Returns WindowsBuilder
- Defined in lib/builders/windows-builder.ts:171

id

id(id): this
Parameters
- id: string
Returns this
Inherited from BlueprintBuilder.id
- Defined in lib/stacks/eks-blueprint-construct.ts:188

ipFamily

ipFamily(ipFamily?): this
Adding ipFamily method to support IPv6 clusters. By default, it uses IPv4 as the value.
Parameters
- ipFamily: IpFamily = eks.IpFamily.IP_V4
Returns this
Inherited from BlueprintBuilder.ipFamily
- Defined in lib/stacks/eks-blueprint-construct.ts:154

name

name(name): this
Parameters
- name: string
Returns this
Inherited from BlueprintBuilder.name
- Defined in lib/stacks/eks-blueprint-construct.ts:131

region

region(region?): this
Parameters
- Optionalregion: string
Returns this
Inherited from BlueprintBuilder.region
- Defined in lib/stacks/eks-blueprint-construct.ts:141

resourceProvider

resourceProvider(name, provider): this
Parameters
- name: string
- provider: ResourceProvider<IConstruct>
Returns this
Inherited from BlueprintBuilder.resourceProvider
- Defined in lib/stacks/eks-blueprint-construct.ts:198

teams

teams(...teams): this
Parameters
- Rest...teams: Team[]
Returns this
Inherited from BlueprintBuilder.teams
- Defined in lib/stacks/eks-blueprint-construct.ts:193

useDefaultSecretEncryption

useDefaultSecretEncryption(useDefault): this
Parameters
- useDefault: boolean
Returns this
Inherited from BlueprintBuilder.useDefaultSecretEncryption
- Defined in lib/stacks/eks-blueprint-construct.ts:203

version

version(version): this
Parameters
- version: KubernetesVersion | "auto"
Returns this
Inherited from BlueprintBuilder.version
- Defined in lib/stacks/eks-blueprint-construct.ts:146

withBlueprintProps

withBlueprintProps(props): this
Parameters
- props: Partial<EksBlueprintProps>
Returns this
Inherited from BlueprintBuilder.withBlueprintProps
- Defined in lib/stacks/eks-blueprint-construct.ts:169

withEnv

withEnv(env): this
Parameters
- env: Environment
Returns this
Inherited from BlueprintBuilder.withEnv
- Defined in lib/stacks/eks-blueprint-construct.ts:208

withKarpenterProps

withKarpenterProps(props): this
Parameters
- props: KarpenterAddOnProps
Returns this
- Defined in lib/builders/windows-builder.ts:177

`Static`builder

builder(options): WindowsBuilder
This method helps you prepare a blueprint for setting up windows nodes with usage tracking addon
Parameters
- options: WindowsOptions
Returns WindowsBuilder
- Defined in lib/builders/windows-builder.ts:138