Class GithubCodePipelineBuilder

Extension of @aws-quickstart/eks-blueprints#CodePipeline for integration with cdk-pipelines-github

Hierarchy

CodePipelineBuilder
- GithubCodePipelineBuilder

Index

Constructors

constructor

new GithubCodePipelineBuilder(): GithubCodePipelineBuilder
Returns GithubCodePipelineBuilder
Overrides blueprints.CodePipelineBuilder.constructor
- Defined in packages/stacks/api/src/gh.ts:38

Properties

`Protected`githubProps

githubProps: GithubPipelineProps

Methods

application

application(app: string): CodePipelineBuilder
Parameters
- app: string
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.application
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:149

build

build(
    scope: Construct,
    id: string,
    stackProps?: StackProps,
): GithubCodePipelineStack
Parameters
- scope: Construct
- id: string
- OptionalstackProps: StackProps
Returns GithubCodePipelineStack
Overrides blueprints.CodePipelineBuilder.build
- Defined in packages/stacks/api/src/gh.ts:43

codeBuildPolicies

codeBuildPolicies(policies: PolicyStatement[]): CodePipelineBuilder
For production use cases, make sure all policies are tied to concrete resources.
Parameters
- policies: PolicyStatement[]
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.codeBuildPolicies
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:157

enableCrossAccountKeys

enableCrossAccountKeys(): CodePipelineBuilder
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.enableCrossAccountKeys
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:158

`Protected`formatRepo

formatRepo(owner: string, repoString: string): string
Parameters
- owner: string
- repoString: string
Returns string
- Defined in packages/stacks/api/src/gh.ts:54

githubRepo

githubRepo(...repos: string[]): this
Parameters
- ...repos: string[]
Returns this
- Defined in packages/stacks/api/src/gh.ts:75

githubWave

githubWave(...waves: PipelineWave[]): this
Parameters
- ...waves: PipelineWave[]
Returns this
- Defined in packages/stacks/api/src/gh.ts:70

name

name(name: string): CodePipelineBuilder
Parameters
- name: string
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.name
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:150

owner

owner(owner: string): this
Parameters
- owner: string
Returns this
Overrides blueprints.CodePipelineBuilder.owner
- Defined in packages/stacks/api/src/gh.ts:59

repository

repository(
    repo:
        | GitHubSourceRepository
        | CodeCommitSourceRepository
        | CodeStarConnectionRepository,
): CodePipelineBuilder
Parameters
- repo:
      | GitHubSourceRepository
      | CodeCommitSourceRepository
      | CodeStarConnectionRepository
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.repository
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:159

rootDir

rootDir(value: string): this
Parameters
- value: string
Returns this
- Defined in packages/stacks/api/src/gh.ts:87

stage

stage(...stackStages: StackStage[]): CodePipelineBuilder
Adds standalone pipeline stages (in the order of invocation and elements in the input array)
Parameters
- ...stackStages: StackStage[]
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.stage
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:165

wave

wave(...waves: PipelineWave[]): CodePipelineBuilder
Adds wave(s) in the order specified. All stages in the wave can be executed in parallel, while standalone stages are executed sequentially.
Parameters
- ...waves: PipelineWave[]
Returns CodePipelineBuilder
Inherited from blueprints.CodePipelineBuilder.wave
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/pipelines/code-pipeline.d.ts:171

Class GithubCodePipelineBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GithubCodePipelineBuilder

Properties

ProtectedgithubProps

Methods

application

Parameters

Returns CodePipelineBuilder

build

Parameters

Returns GithubCodePipelineStack

codeBuildPolicies

Parameters

Returns CodePipelineBuilder

enableCrossAccountKeys

Returns CodePipelineBuilder

ProtectedformatRepo

Parameters

Returns string

githubRepo

Parameters

Returns this

githubWave

Parameters

Returns this

name

Parameters

Returns CodePipelineBuilder

owner

Parameters

Returns this

repository

Parameters

Returns CodePipelineBuilder

rootDir

Parameters

Returns this

stage

Parameters

Returns CodePipelineBuilder

wave

Parameters

Returns CodePipelineBuilder

Settings

On This Page

`Protected`githubProps

`Protected`formatRepo