Skip to main content

GithubOidcStack

sdlc-cdk-lib v1.0.0

sdlc-cdk-lib / modules/sdlc-aws-cdk-lib/lib/GithubOidcStack

modules/sdlc-aws-cdk-lib/lib/GithubOidcStack

Classes​

GithubOidcStack​

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:31

Stack for creating GitHub OIDC provider and IAM role for GitHub Actions deployments.

This stack creates:

  • OpenID Connect (OIDC) provider for GitHub Actions
  • IAM role that can be assumed by GitHub Actions from the specified repository
  • Appropriate permissions for CDK deployments

This stack must be deployed manually first before GitHub Actions can assume the role.

Example​

new GithubOidcStack(app, 'GithubOidcStack', {
  githubOrg: 'akfdev-com',
  githubRepo: 'akfdev-cdk-lib',
  githubBranch: 'main', // Optional: restrict to specific branch
});

Extends​

  • unknown

Constructors​

Constructor​

> new GithubOidcStack(scope, id, props): GithubOidcStack

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:36

Parameters​
scope​

Construct

id​

string

props​

GithubOidcStackProps

Returns​

GithubOidcStack

Overrides​

Stack.constructor

Properties​

githubActionsRole​

> readonly githubActionsRole: Role

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:33

oidcProvider​

> readonly oidcProvider: OpenIdConnectProvider

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:32

roleArn​

> readonly roleArn: string

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:34

Interfaces​

GithubOidcStackProps​

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:6

Extends​

  • StackProps

Properties​

githubBranch?​

> readonly optional githubBranch: string

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:9

githubOrg​

> readonly githubOrg: string

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:7

githubRepo​

> readonly githubRepo: string

Defined in: modules/sdlc-aws-cdk-lib/lib/GithubOidcStack.ts:8