Class BedrockBuilder

Blueprint builder implements a builder pattern that improves readability (no bloated constructors) and allows creating a blueprint in an abstract state that can be applied to various instantiations in accounts and regions.

Hierarchy (View Summary)

BlueprintBuilder
- BedrockBuilder

Index

Constructors

constructor

new BedrockBuilder(): BedrockBuilder
Returns BedrockBuilder
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?: string): this
Parameters
- Optionalaccount: string
Returns this
Inherited from BlueprintBuilder.account
- Defined in lib/stacks/eks-blueprint-construct.ts:136

addBedrockTeam

addBedrockTeam(props: BedrockTeamProps): this
Parameters
- props: BedrockTeamProps
Returns this
- Defined in lib/builders/bedrock-builder.ts:14

addOns

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

build

build(scope: Construct, id: string, stackProps?: 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: Construct,
    id: string,
    stackProps?: 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?: string, account?: string): BlueprintBuilder
Parameters
- Optionalregion: string
- Optionalaccount: string
Returns BlueprintBuilder
Inherited from BlueprintBuilder.clone
- Defined in lib/stacks/eks-blueprint-stack.ts:18

clusterProvider

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

compatibilityMode

compatibilityMode(compatibilityMode: boolean): 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: ControlPlaneLogType[]): this
Parameters
- ...types: ControlPlaneLogType[]
Returns this
Inherited from BlueprintBuilder.enableControlPlaneLogTypes
- Defined in lib/stacks/eks-blueprint-construct.ts:159

enableGitOps

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

id

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

ipFamily

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: string): this
Parameters
- name: string
Returns this
Inherited from BlueprintBuilder.name
- Defined in lib/stacks/eks-blueprint-construct.ts:131

region

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

resourceProvider

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

teams

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

useDefaultSecretEncryption

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

version

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

withBlueprintProps

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

withEnv

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

`Static`builder

builder(): BedrockBuilder
This method helps you prepare a blueprint for setting up EKS cluster with usage tracking addon

Returns BedrockBuilder
- Defined in lib/builders/bedrock-builder.ts:22

Class BedrockBuilder

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BedrockBuilder

Properties

env

props

Methods

account

Parameters

Returns this

addBedrockTeam

Parameters

Returns this

addOns

Parameters

Returns this

build

Parameters

Returns EksBlueprint

buildAsync

Parameters

Returns Promise<EksBlueprint>

clone

Parameters

Returns BlueprintBuilder

clusterProvider

Parameters

Returns BedrockBuilder

compatibilityMode

Parameters

Returns BlueprintBuilder

enableControlPlaneLogTypes

Parameters

Returns this

enableGitOps

Parameters

Returns this

id

Parameters

Returns this

ipFamily

Parameters

Returns this

name

Parameters

Returns this

region

Parameters

Returns this

resourceProvider

Parameters

Returns this

teams

Parameters

Returns this

useDefaultSecretEncryption

Parameters

Returns this

version

Parameters

Returns this

withBlueprintProps

Parameters

Returns this

withEnv

Parameters

Returns this

Staticbuilder

Returns BedrockBuilder

Settings

On This Page

`Static`builder