API.md

API Reference

Constructs

BaseGitHubApps

• Implements: IGitHubApps

Initializers

import { BaseGitHubApps } from '@catnekaise/ghrawel'

new BaseGitHubApps(scope: Construct, id: string, baseProps: GitHubAppsProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
baseProps	GitHubAppsProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

baseProps^Required

• Type: GitHubAppsProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
getAppIdForAppName	No description.
grantAccess	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

getAppIdForAppName

public getAppIdForAppName(name?: string): number

name^Optional

• Type: string

---

grantAccess

public grantAccess(principal: IPrincipal): Grant

principal^Required

• Type: aws-cdk-lib.aws_iam.IPrincipal

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { BaseGitHubApps } from '@catnekaise/ghrawel'

BaseGitHubApps.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
secretsPrefix	string	No description.
secretsStorage	GitHubAppSecretsStorage	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

secretsPrefix^Required

public readonly secretsPrefix: string;

• Type: string

---

secretsStorage^Required

public readonly secretsStorage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

ManagedGitHubApps

• Implements: IGitHubApps

Initializers

import { ManagedGitHubApps } from '@catnekaise/ghrawel'

new ManagedGitHubApps(scope: Construct, id: string, props: ManagedGitHubAppsProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	ManagedGitHubAppsProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: ManagedGitHubAppsProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
getAppIdForAppName	No description.
grantAccess	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

getAppIdForAppName

public getAppIdForAppName(name?: string): number

name^Optional

• Type: string

---

grantAccess

public grantAccess(principal: IPrincipal): Grant

principal^Required

• Type: aws-cdk-lib.aws_iam.IPrincipal

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { ManagedGitHubApps } from '@catnekaise/ghrawel'

ManagedGitHubApps.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
secretsPrefix	string	No description.
secretsStorage	GitHubAppSecretsStorage	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

secretsPrefix^Required

public readonly secretsPrefix: string;

• Type: string

---

secretsStorage^Required

public readonly secretsStorage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

SelfManagedGitHubApps

• Implements: IGitHubApps

Initializers

import { SelfManagedGitHubApps } from '@catnekaise/ghrawel'

new SelfManagedGitHubApps(scope: Construct, id: string, props: GitHubAppsProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	GitHubAppsProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: GitHubAppsProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
getAppIdForAppName	No description.
grantAccess	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

getAppIdForAppName

public getAppIdForAppName(name?: string): number

name^Optional

• Type: string

---

grantAccess

public grantAccess(principal: IPrincipal): Grant

principal^Required

• Type: aws-cdk-lib.aws_iam.IPrincipal

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { SelfManagedGitHubApps } from '@catnekaise/ghrawel'

SelfManagedGitHubApps.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
secretsPrefix	string	No description.
secretsStorage	GitHubAppSecretsStorage	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

secretsPrefix^Required

public readonly secretsPrefix: string;

• Type: string

---

secretsStorage^Required

public readonly secretsStorage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

TokenProvider

• Implements: ITokenProvider

This construct may receive some changes before constructor is made public.

Until then use static create method.

Methods

Name	Description
toString	Returns a string representation of this construct.
grantExecute	Use this to grant access to the token provider.
grantExecuteGitHubActionsAbac	use this to grant access to the token provider when the role is assumed via Cognito Identity.
metric	No description.
metricCacheHitCount	No description.
metricCacheMissCount	No description.
metricClientError	No description.
metricCount	No description.
metricServerError	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

grantExecute

public grantExecute(role: IRole, repo: string, owner?: string): Grant

Use this to grant access to the token provider.

role^Required

• Type: aws-cdk-lib.aws_iam.IRole

---

repo^Required

• Type: string

---

owner^Optional

• Type: string

---

grantExecuteGitHubActionsAbac

public grantExecuteGitHubActionsAbac(role: IRole, settings: TokenProviderActionsIdentitySettings): Grant

use this to grant access to the token provider when the role is assumed via Cognito Identity.

role^Required

• Type: aws-cdk-lib.aws_iam.IRole

---

settings^Required

• Type: TokenProviderActionsIdentitySettings

---

metric

public metric(metricName: string, stage: IStage, props?: MetricOptions): Metric

metricName^Required

• Type: string

---

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

metricCacheHitCount

public metricCacheHitCount(stage: IStage, props?: MetricOptions): Metric

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

metricCacheMissCount

public metricCacheMissCount(stage: IStage, props?: MetricOptions): Metric

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

metricClientError

public metricClientError(stage: IStage, props?: MetricOptions): Metric

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

metricCount

public metricCount(stage: IStage, props?: MetricOptions): Metric

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

metricServerError

public metricServerError(stage: IStage, props?: MetricOptions): Metric

stage^Required

• Type: aws-cdk-lib.aws_apigateway.IStage

---

props^Optional

• Type: aws-cdk-lib.aws_cloudwatch.MetricOptions

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
create	No description.

---

isConstruct

import { TokenProvider } from '@catnekaise/ghrawel'

TokenProvider.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

create

import { TokenProvider } from '@catnekaise/ghrawel'

TokenProvider.create(scope: Construct, id: string, settings: TokenProviderSettings)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

settings^Required

• Type: TokenProviderSettings

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
httpMethod	string	No description.
methodArn	string	No description.
methodId	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

---

methodArn^Required

public readonly methodArn: string;

• Type: string

---

methodId^Required

public readonly methodId: string;

• Type: string

---

TokenProviderApi

• Implements: ITokenProviderApi

Initializers

import { TokenProviderApi } from '@catnekaise/ghrawel'

new TokenProviderApi(scope: Construct, id: string, props: TokenProviderApiProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	TokenProviderApiProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: TokenProviderApiProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
newTokenProvider	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

newTokenProvider

public newTokenProvider(name: string, configuration: NewTokenProviderConfiguration): ITokenProvider

name^Required

• Type: string

---

configuration^Required

• Type: NewTokenProviderConfiguration

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { TokenProviderApi } from '@catnekaise/ghrawel'

TokenProviderApi.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
lambdaFunction	aws-cdk-lib.aws_lambda.Function	No description.
restApi	aws-cdk-lib.aws_apigateway.RestApi	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

lambdaFunction^Required

public readonly lambdaFunction: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

restApi^Required

public readonly restApi: RestApi;

• Type: aws-cdk-lib.aws_apigateway.RestApi

---

Structs

GitHubAppPermissions

Initializer

import { GitHubAppPermissions } from '@catnekaise/ghrawel'

const gitHubAppPermissions: GitHubAppPermissions = { ... }

Properties

Name	Type	Description
actions	PermissionLevel	No description.
administration	PermissionLevel	No description.
checks	PermissionLevel	No description.
codespaces	PermissionLevel	No description.
contents	PermissionLevel	No description.
dependabotSecrets	PermissionLevel	No description.
deployments	PermissionLevel	No description.
emailAddresses	PermissionLevel	No description.
environments	PermissionLevel	No description.
followers	PermissionLevel	No description.
gitSshKeys	PermissionLevel	No description.
gpgKeys	PermissionLevel	No description.
interactionLimits	PermissionLevel	No description.
issues	PermissionLevel	No description.
members	PermissionLevel	No description.
metadata	PermissionLevel	No description.
organizationAdministration	PermissionLevel	No description.
organizationAnnouncementBanners	PermissionLevel	No description.
organizationCopilotSeatManagement	PermissionLevel	No description.
organizationCustomOrgRoles	PermissionLevel	No description.
organizationCustomProperties	PermissionLevel	No description.
organizationCustomRoles	PermissionLevel	No description.
organizationEvents	PermissionLevel	No description.
organizationHooks	PermissionLevel	No description.
organizationPackages	PermissionLevel	No description.
organizationPersonalAccessTokenRequests	PermissionLevel	No description.
organizationPersonalAccessTokens	PermissionLevel	No description.
organizationPlan	PermissionLevel	No description.
organizationProjects	PermissionLevel	No description.
organizationSecrets	PermissionLevel	No description.
organizationSelfHostedRunners	PermissionLevel	No description.
organizationUserBlocking	PermissionLevel	No description.
packages	PermissionLevel	No description.
pages	PermissionLevel	No description.
profile	PermissionLevel	No description.
pullRequests	PermissionLevel	No description.
repositoryCustomProperties	PermissionLevel	No description.
repositoryHooks	PermissionLevel	No description.
repositoryProjects	PermissionLevel	No description.
secrets	PermissionLevel	No description.
secretScanningAlerts	PermissionLevel	No description.
securityEvents	PermissionLevel	No description.
singleFile	PermissionLevel	No description.
starring	PermissionLevel	No description.
statuses	PermissionLevel	No description.
teamDiscussions	PermissionLevel	No description.
vulnerabilityAlerts	PermissionLevel	No description.
workflows	PermissionLevel	No description.

---

actions^Optional

public readonly actions: PermissionLevel;

• Type: PermissionLevel

---

administration^Optional

public readonly administration: PermissionLevel;

• Type: PermissionLevel

---

checks^Optional

public readonly checks: PermissionLevel;

• Type: PermissionLevel

---

codespaces^Optional

public readonly codespaces: PermissionLevel;

• Type: PermissionLevel

---

contents^Optional

public readonly contents: PermissionLevel;

• Type: PermissionLevel

---

dependabotSecrets^Optional

public readonly dependabotSecrets: PermissionLevel;

• Type: PermissionLevel

---

deployments^Optional

public readonly deployments: PermissionLevel;

• Type: PermissionLevel

---

emailAddresses^Optional

public readonly emailAddresses: PermissionLevel;

• Type: PermissionLevel

---

environments^Optional

public readonly environments: PermissionLevel;

• Type: PermissionLevel

---

followers^Optional

public readonly followers: PermissionLevel;

• Type: PermissionLevel

---

gitSshKeys^Optional

public readonly gitSshKeys: PermissionLevel;

• Type: PermissionLevel

---

gpgKeys^Optional

public readonly gpgKeys: PermissionLevel;

• Type: PermissionLevel

---

interactionLimits^Optional

public readonly interactionLimits: PermissionLevel;

• Type: PermissionLevel

---

issues^Optional

public readonly issues: PermissionLevel;

• Type: PermissionLevel

---

members^Optional

public readonly members: PermissionLevel;

• Type: PermissionLevel

---

metadata^Optional

public readonly metadata: PermissionLevel;

• Type: PermissionLevel

---

organizationAdministration^Optional

public readonly organizationAdministration: PermissionLevel;

• Type: PermissionLevel

---

organizationAnnouncementBanners^Optional

public readonly organizationAnnouncementBanners: PermissionLevel;

• Type: PermissionLevel

---

organizationCopilotSeatManagement^Optional

public readonly organizationCopilotSeatManagement: PermissionLevel;

• Type: PermissionLevel

---

organizationCustomOrgRoles^Optional

public readonly organizationCustomOrgRoles: PermissionLevel;

• Type: PermissionLevel

---

organizationCustomProperties^Optional

public readonly organizationCustomProperties: PermissionLevel;

• Type: PermissionLevel

---

organizationCustomRoles^Optional

public readonly organizationCustomRoles: PermissionLevel;

• Type: PermissionLevel

---

organizationEvents^Optional

public readonly organizationEvents: PermissionLevel;

• Type: PermissionLevel

---

organizationHooks^Optional

public readonly organizationHooks: PermissionLevel;

• Type: PermissionLevel

---

organizationPackages^Optional

public readonly organizationPackages: PermissionLevel;

• Type: PermissionLevel

---

organizationPersonalAccessTokenRequests^Optional

public readonly organizationPersonalAccessTokenRequests: PermissionLevel;

• Type: PermissionLevel

---

organizationPersonalAccessTokens^Optional

public readonly organizationPersonalAccessTokens: PermissionLevel;

• Type: PermissionLevel

---

organizationPlan^Optional

public readonly organizationPlan: PermissionLevel;

• Type: PermissionLevel

---

organizationProjects^Optional

public readonly organizationProjects: PermissionLevel;

• Type: PermissionLevel

---

organizationSecrets^Optional

public readonly organizationSecrets: PermissionLevel;

• Type: PermissionLevel

---

organizationSelfHostedRunners^Optional

public readonly organizationSelfHostedRunners: PermissionLevel;

• Type: PermissionLevel

---

organizationUserBlocking^Optional

public readonly organizationUserBlocking: PermissionLevel;

• Type: PermissionLevel

---

packages^Optional

public readonly packages: PermissionLevel;

• Type: PermissionLevel

---

pages^Optional

public readonly pages: PermissionLevel;

• Type: PermissionLevel

---

profile^Optional

public readonly profile: PermissionLevel;

• Type: PermissionLevel

---

pullRequests^Optional

public readonly pullRequests: PermissionLevel;

• Type: PermissionLevel

---

repositoryCustomProperties^Optional

public readonly repositoryCustomProperties: PermissionLevel;

• Type: PermissionLevel

---

repositoryHooks^Optional

public readonly repositoryHooks: PermissionLevel;

• Type: PermissionLevel

---

repositoryProjects^Optional

public readonly repositoryProjects: PermissionLevel;

• Type: PermissionLevel

---

secrets^Optional

public readonly secrets: PermissionLevel;

• Type: PermissionLevel

---

secretScanningAlerts^Optional

public readonly secretScanningAlerts: PermissionLevel;

• Type: PermissionLevel

---

securityEvents^Optional

public readonly securityEvents: PermissionLevel;

• Type: PermissionLevel

---

singleFile^Optional

public readonly singleFile: PermissionLevel;

• Type: PermissionLevel

---

starring^Optional

public readonly starring: PermissionLevel;

• Type: PermissionLevel

---

statuses^Optional

public readonly statuses: PermissionLevel;

• Type: PermissionLevel

---

teamDiscussions^Optional

public readonly teamDiscussions: PermissionLevel;

• Type: PermissionLevel

---

vulnerabilityAlerts^Optional

public readonly vulnerabilityAlerts: PermissionLevel;

• Type: PermissionLevel

---

workflows^Optional

public readonly workflows: PermissionLevel;

• Type: PermissionLevel

---

GitHubAppsProps

Initializer

import { GitHubAppsProps } from '@catnekaise/ghrawel'

const gitHubAppsProps: GitHubAppsProps = { ... }

Properties

Name	Type	Description
defaultAppId	number	No description.
storage	GitHubAppSecretsStorage	No description.
additionalApps	GitHubApp[]	No description.
prefix	string	No description.

---

defaultAppId^Required

public readonly defaultAppId: number;

• Type: number

---

storage^Required

public readonly storage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

additionalApps^Optional

public readonly additionalApps: GitHubApp[];

• Type: GitHubApp[]

---

prefix^Optional

public readonly prefix: string;

• Type: string
• Default: /catnekaise/github-apps

---

ManagedGitHubAppsProps

Initializer

import { ManagedGitHubAppsProps } from '@catnekaise/ghrawel'

const managedGitHubAppsProps: ManagedGitHubAppsProps = { ... }

Properties

Name	Type	Description
defaultAppId	number	No description.
storage	GitHubAppSecretsStorage	No description.
additionalApps	GitHubApp[]	No description.
prefix	string	No description.
kmsKey	aws-cdk-lib.aws_kms.IKey	No description.
removalPolicy	aws-cdk-lib.RemovalPolicy	No description.

---

defaultAppId^Required

public readonly defaultAppId: number;

• Type: number

---

storage^Required

public readonly storage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

additionalApps^Optional

public readonly additionalApps: GitHubApp[];

• Type: GitHubApp[]

---

prefix^Optional

public readonly prefix: string;

• Type: string
• Default: /catnekaise/github-apps

---

kmsKey^Optional

public readonly kmsKey: IKey;

• Type: aws-cdk-lib.aws_kms.IKey
• Default: AWS_MANAGED

---

removalPolicy^Optional

public readonly removalPolicy: RemovalPolicy;

• Type: aws-cdk-lib.RemovalPolicy

---

NewTokenProviderConfiguration

Initializer

import { NewTokenProviderConfiguration } from '@catnekaise/ghrawel'

const newTokenProviderConfiguration: NewTokenProviderConfiguration = { ... }

Properties

Name	Type	Description
permissions	GitHubAppPermissions	Permissions.
app	string	No description.
endpoint	TokenProviderEndpoint	No description.
targetRule	TokenProviderTargetRule	No description.

---

permissions^Required

public readonly permissions: GitHubAppPermissions;

• Type: GitHubAppPermissions

Permissions.

---

app^Optional

public readonly app: string;

• Type: string
• Default: default

---

endpoint^Optional

public readonly endpoint: TokenProviderEndpoint;

• Type: TokenProviderEndpoint
• Default: DEFAULT

---

targetRule^Optional

public readonly targetRule: TokenProviderTargetRule;

• Type: TokenProviderTargetRule
• Default: AT_LEAST_ONE

---

TargetRuleSettings

Initializer

import { TargetRuleSettings } from '@catnekaise/ghrawel'

const targetRuleSettings: TargetRuleSettings = { ... }

Properties

Name	Type	Description
mode	RepositorySelectionMode	No description.

---

mode^Required

public readonly mode: RepositorySelectionMode;

• Type: RepositorySelectionMode

---

TokenProviderActionsIdentitySettings

Initializer

import { TokenProviderActionsIdentitySettings } from '@catnekaise/ghrawel'

const tokenProviderActionsIdentitySettings: TokenProviderActionsIdentitySettings = { ... }

Properties

Name	Type	Description
claimsContext	@catnekaise/cdk-iam-utilities.IClaimsContext	No description.
pathStrategy	TokenProviderPathStrategy	No description.

---

claimsContext^Required

public readonly claimsContext: IClaimsContext;

• Type: @catnekaise/cdk-iam-utilities.IClaimsContext

---

pathStrategy^Optional

public readonly pathStrategy: TokenProviderPathStrategy;

• Type: TokenProviderPathStrategy

---

TokenProviderApiProps

Initializer

import { TokenProviderApiProps } from '@catnekaise/ghrawel'

const tokenProviderApiProps: TokenProviderApiProps = { ... }

Properties

Name	Type	Description
apps	IGitHubApps	GitHub Apps configuration.
api	aws-cdk-lib.aws_apigateway.RestApi	Use this to provide the API Gateway RestApi configured to your requirements.
lambda	aws-cdk-lib.aws_lambda.Function	Use this to provide the Lambda Function configured to your requirements.

---

apps^Required

public readonly apps: IGitHubApps;

• Type: IGitHubApps

GitHub Apps configuration.

---

api^Optional

public readonly api: RestApi;

• Type: aws-cdk-lib.aws_apigateway.RestApi

Use this to provide the API Gateway RestApi configured to your requirements.

---

lambda^Optional

public readonly lambda: Function;

• Type: aws-cdk-lib.aws_lambda.Function

Use this to provide the Lambda Function configured to your requirements.

---

TokenProviderConfiguratorIntegrationOptionsContext

Initializer

import { TokenProviderConfiguratorIntegrationOptionsContext } from '@catnekaise/ghrawel'

const tokenProviderConfiguratorIntegrationOptionsContext: TokenProviderConfiguratorIntegrationOptionsContext = { ... }

Properties

Name	Type	Description
appId	number	No description.
appName	string	No description.
endpoint	TokenProviderEndpoint	No description.
name	string	No description.
permissions	GitHubAppPermissions	No description.
targetRule	TargetRuleSettings	No description.

---

appId^Required

public readonly appId: number;

• Type: number

---

appName^Required

public readonly appName: string;

• Type: string

---

endpoint^Required

public readonly endpoint: TokenProviderEndpoint;

• Type: TokenProviderEndpoint

---

name^Required

public readonly name: string;

• Type: string

---

permissions^Required

public readonly permissions: GitHubAppPermissions;

• Type: GitHubAppPermissions

---

targetRule^Required

public readonly targetRule: TargetRuleSettings;

• Type: TargetRuleSettings

---

TokenProviderConfiguratorMethodOptionsContext

Initializer

import { TokenProviderConfiguratorMethodOptionsContext } from '@catnekaise/ghrawel'

const tokenProviderConfiguratorMethodOptionsContext: TokenProviderConfiguratorMethodOptionsContext = { ... }

Properties

Name	Type	Description
endpointType	TokenProviderEndpointType	No description.
errorResponseModel	aws-cdk-lib.aws_apigateway.Model	No description.
operationName	string	No description.
repositorySelectionMode	RepositorySelectionMode	No description.
tokenResponseModel	aws-cdk-lib.aws_apigateway.Model	No description.
requestValidator	aws-cdk-lib.aws_apigateway.IRequestValidator	No description.

---

endpointType^Required

public readonly endpointType: TokenProviderEndpointType;

• Type: TokenProviderEndpointType

---

errorResponseModel^Required

public readonly errorResponseModel: Model;

• Type: aws-cdk-lib.aws_apigateway.Model

---

operationName^Required

public readonly operationName: string;

• Type: string

---

repositorySelectionMode^Required

public readonly repositorySelectionMode: RepositorySelectionMode;

• Type: RepositorySelectionMode

---

tokenResponseModel^Required

public readonly tokenResponseModel: Model;

• Type: aws-cdk-lib.aws_apigateway.Model

---

requestValidator^Optional

public readonly requestValidator: IRequestValidator;

• Type: aws-cdk-lib.aws_apigateway.IRequestValidator

---

TokenProviderLambdaCodeOptions

Use this to build a supported the TokenProvider lambda application when the source is located in a public repository.

Initializer

import { TokenProviderLambdaCodeOptions } from '@catnekaise/ghrawel'

const tokenProviderLambdaCodeOptions: TokenProviderLambdaCodeOptions = { ... }

Properties

Name	Type	Description
architecture	ApplicationArchitecture	Should be equal to the architecture configured for the lambda function.
checkout	string	Value for git checkout after cloning the repository Example: main, origin/feature1, SHA.
platform	string	Value for docker platform Example: linux/amd64.
repository	string	Repository Url Example: https://github.com/catnekaise/example-fork.git.

---

architecture^Optional

public readonly architecture: ApplicationArchitecture;

• Type: ApplicationArchitecture

Should be equal to the architecture configured for the lambda function.

This value is used to build the application in the specified architecture.

---

checkout^Optional

public readonly checkout: string;

• Type: string

Value for git checkout after cloning the repository Example: main, origin/feature1, SHA.

---

platform^Optional

public readonly platform: string;

• Type: string

Value for docker platform Example: linux/amd64.

---

repository^Optional

public readonly repository: string;

• Type: string

Repository Url Example: https://github.com/catnekaise/example-fork.git.

---

TokenProviderMethodOptions

Initializer

import { TokenProviderMethodOptions } from '@catnekaise/ghrawel'

const tokenProviderMethodOptions: TokenProviderMethodOptions = { ... }

Properties

Name	Type	Description
endpointType	TokenProviderEndpointType	No description.
errorResponseModel	aws-cdk-lib.aws_apigateway.Model	No description.
operationName	string	No description.
requestValidator	aws-cdk-lib.aws_apigateway.RequestValidator	No description.
tokenResponseModel	aws-cdk-lib.aws_apigateway.Model	No description.

---

endpointType^Required

public readonly endpointType: TokenProviderEndpointType;

• Type: TokenProviderEndpointType

---

errorResponseModel^Required

public readonly errorResponseModel: Model;

• Type: aws-cdk-lib.aws_apigateway.Model

---

operationName^Required

public readonly operationName: string;

• Type: string

---

requestValidator^Required

public readonly requestValidator: RequestValidator;

• Type: aws-cdk-lib.aws_apigateway.RequestValidator

---

tokenResponseModel^Required

public readonly tokenResponseModel: Model;

• Type: aws-cdk-lib.aws_apigateway.Model

---

TokenProviderSettings

Initializer

import { TokenProviderSettings } from '@catnekaise/ghrawel'

const tokenProviderSettings: TokenProviderSettings = { ... }

Properties

Name	Type	Description
api	aws-cdk-lib.aws_apigateway.IRestApi	No description.
app	string	No description.
appId	number	No description.
configurator	TokenProviderConfigurator	No description.
endpoint	TokenProviderEndpoint	No description.
lambda	aws-cdk-lib.aws_lambda.Function	No description.
methodOptions	TokenProviderMethodOptions	No description.
name	string	No description.
permissions	GitHubAppPermissions	No description.
targetRule	TokenProviderTargetRule	No description.

---

api^Required

public readonly api: IRestApi;

• Type: aws-cdk-lib.aws_apigateway.IRestApi

---

app^Required

public readonly app: string;

• Type: string

---

appId^Required

public readonly appId: number;

• Type: number

---

configurator^Required

public readonly configurator: TokenProviderConfigurator;

• Type: TokenProviderConfigurator

---

endpoint^Required

public readonly endpoint: TokenProviderEndpoint;

• Type: TokenProviderEndpoint

---

lambda^Required

public readonly lambda: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

methodOptions^Required

public readonly methodOptions: TokenProviderMethodOptions;

• Type: TokenProviderMethodOptions

---

name^Required

public readonly name: string;

• Type: string

---

permissions^Required

public readonly permissions: GitHubAppPermissions;

• Type: GitHubAppPermissions

---

targetRule^Required

public readonly targetRule: TokenProviderTargetRule;

• Type: TokenProviderTargetRule

---

Classes

ApplicationArchitecture

Only applicable to TokenProviderLambdaCodeOptions.

Ensure that the lambda function architecture matches.

Properties

Name	Type	Description
name	string	No description.

---

name^Required

public readonly name: string;

• Type: string

---

Constants

Name	Type	Description
ARM_64	ApplicationArchitecture	No description.
X86_64	ApplicationArchitecture	No description.

---

ARM_64^Required

public readonly ARM_64: ApplicationArchitecture;

• Type: ApplicationArchitecture

---

X86_64^Required

public readonly X86_64: ApplicationArchitecture;

• Type: ApplicationArchitecture

---

GitHubApp

Static Functions

Name	Description
create	No description.

---

create

import { GitHubApp } from '@catnekaise/ghrawel'

GitHubApp.create(name: string, appId: number)

name^Required

• Type: string

---

appId^Required

• Type: number

---

Properties

Name	Type	Description
appId	number	No description.
name	string	No description.

---

appId^Required

public readonly appId: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

TokenProviderConfigurator

This class may see some breaking changes but the intent is to stabilize, be made abstract and available as input on TokenProviderConfiguration.

Methods

Name	Description
createApiResource	No description.
createIntegrationOptions	No description.
createMethodOptions	No description.

---

createApiResource

public createApiResource(api: IRestApi, name: string, endpoint: TokenProviderEndpoint): Resource

api^Required

• Type: aws-cdk-lib.aws_apigateway.IRestApi

---

name^Required

• Type: string

---

endpoint^Required

• Type: TokenProviderEndpoint

---

createIntegrationOptions

public createIntegrationOptions(settings: TokenProviderConfiguratorIntegrationOptionsContext): LambdaIntegrationOptions

settings^Required

• Type: TokenProviderConfiguratorIntegrationOptionsContext

---

createMethodOptions

public createMethodOptions(input: TokenProviderConfiguratorMethodOptionsContext): MethodOptions

input^Required

• Type: TokenProviderConfiguratorMethodOptionsContext

---

Static Functions

Name	Description
create	No description.

---

create

import { TokenProviderConfigurator } from '@catnekaise/ghrawel'

TokenProviderConfigurator.create()

Properties

Name	Type	Description
integrationResponses	aws-cdk-lib.aws_apigateway.IntegrationResponse[]	No description.

---

integrationResponses^Required

public readonly integrationResponses: IntegrationResponse[];

• Type: aws-cdk-lib.aws_apigateway.IntegrationResponse[]

---

TokenProviderEndpoint

Static Functions

Name	Description
useDefault	Use this to configure a token provider at /x/<provider-name>/{owner}/{repo}.
useOwner	Use this to configure a token provider at /x/<provider-name>/{owner} or /x/<provider-name>/<owner>.

---

useDefault

import { TokenProviderEndpoint } from '@catnekaise/ghrawel'

TokenProviderEndpoint.useDefault()

Use this to configure a token provider at /x/<provider-name>/{owner}/{repo}.

useOwner

import { TokenProviderEndpoint } from '@catnekaise/ghrawel'

TokenProviderEndpoint.useOwner(owner?: string)

Use this to configure a token provider at /x/<provider-name>/{owner} or /x/<provider-name>/<owner>.

owner^Optional

• Type: string

---

Properties

Name	Type	Description
isOwnerEndpoint	boolean	No description.
type	TokenProviderEndpointType	No description.
owner	string	No description.
repo	string	No description.

---

isOwnerEndpoint^Required

public readonly isOwnerEndpoint: boolean;

• Type: boolean

---

type^Required

public readonly type: TokenProviderEndpointType;

• Type: TokenProviderEndpointType

---

owner^Optional

public readonly owner: string;

• Type: string

---

repo^Optional

public readonly repo: string;

• Type: string

---

TokenProviderLambdaCode

Initializers

import { TokenProviderLambdaCode } from '@catnekaise/ghrawel'

new TokenProviderLambdaCode()

Name	Type	Description

---

Static Functions

Name	Description
defaultGo	No description.
dotnet	No description.

---

defaultGo

import { TokenProviderLambdaCode } from '@catnekaise/ghrawel'

TokenProviderLambdaCode.defaultGo(options?: TokenProviderLambdaCodeOptions)

options^Optional

• Type: TokenProviderLambdaCodeOptions

---

dotnet

import { TokenProviderLambdaCode } from '@catnekaise/ghrawel'

TokenProviderLambdaCode.dotnet(options?: TokenProviderLambdaCodeOptions)

options^Optional

• Type: TokenProviderLambdaCodeOptions

---

TokenProviderPathStrategy

Static Functions

Name	Description
anyRepository	Grants permission to /x/<provider-name>/*.
policyVarRepository	Grants permission to /x/<provider-name>/${aws:PrincipalTag/repository}.
policyVarRepositoryOwner	Grants permission to /x/<provider-name>/${aws:PrincipalTag/repository_owner} or /x/<provider-name>/${aws:PrincipalTag/repository_owner}/<repo>.
selectOwner	Grants permission to /x/<provider-name>/<owner>.
selectRepositories	Grants permission for each specified repo /x/<provider-name>/<owner>/<repo>.

---

anyRepository

import { TokenProviderPathStrategy } from '@catnekaise/ghrawel'

TokenProviderPathStrategy.anyRepository()

Grants permission to /x/<provider-name>/*.

policyVarRepository

import { TokenProviderPathStrategy } from '@catnekaise/ghrawel'

TokenProviderPathStrategy.policyVarRepository()

Grants permission to /x/<provider-name>/${aws:PrincipalTag/repository}.

policyVarRepositoryOwner

import { TokenProviderPathStrategy } from '@catnekaise/ghrawel'

TokenProviderPathStrategy.policyVarRepositoryOwner(repositories: string)

Grants permission to /x/<provider-name>/${aws:PrincipalTag/repository_owner} or /x/<provider-name>/${aws:PrincipalTag/repository_owner}/<repo>.

repositories^Required

• Type: string

---

selectOwner

import { TokenProviderPathStrategy } from '@catnekaise/ghrawel'

TokenProviderPathStrategy.selectOwner(owner: string)

Grants permission to /x/<provider-name>/<owner>.

owner^Required

• Type: string

---

selectRepositories

import { TokenProviderPathStrategy } from '@catnekaise/ghrawel'

TokenProviderPathStrategy.selectRepositories(owner: string, repositories: string)

Grants permission for each specified repo /x/<provider-name>/<owner>/<repo>.

owner^Required

• Type: string

---

repositories^Required

• Type: string

---

Properties

Name	Type	Description
pathTargetsRepositories	boolean	No description.
repositories	string[]	No description.
type	TokenProviderPathStrategyType	No description.
owner	string	No description.
policyVar	TokenProviderPathPolicyVariable	No description.

---

pathTargetsRepositories^Required

public readonly pathTargetsRepositories: boolean;

• Type: boolean

---

repositories^Required

public readonly repositories: string[];

• Type: string[]

---

type^Required

public readonly type: TokenProviderPathStrategyType;

• Type: TokenProviderPathStrategyType

---

owner^Optional

public readonly owner: string;

• Type: string

---

policyVar^Optional

public readonly policyVar: TokenProviderPathPolicyVariable;

• Type: TokenProviderPathPolicyVariable

---

TokenProviderTargetRule

Static Functions

Name	Description
allowOwner	No description.
atLeastOne	No description.

---

allowOwner

import { TokenProviderTargetRule } from '@catnekaise/ghrawel'

TokenProviderTargetRule.allowOwner()

atLeastOne

import { TokenProviderTargetRule } from '@catnekaise/ghrawel'

TokenProviderTargetRule.atLeastOne()

Properties

Name	Type	Description
repositorySelectionMode	RepositorySelectionMode	No description.

---

repositorySelectionMode^Required

public readonly repositorySelectionMode: RepositorySelectionMode;

• Type: RepositorySelectionMode

---

Protocols

IGitHubApps

• Implemented By: BaseGitHubApps, ManagedGitHubApps, SelfManagedGitHubApps, IGitHubApps

Methods

Name	Description
getAppIdForAppName	No description.
grantAccess	No description.

---

getAppIdForAppName

public getAppIdForAppName(name?: string): number

name^Optional

• Type: string

---

grantAccess

public grantAccess(principal: IPrincipal): Grant

principal^Required

• Type: aws-cdk-lib.aws_iam.IPrincipal

---

Properties

Name	Type	Description
secretsPrefix	string	No description.
secretsStorage	GitHubAppSecretsStorage	No description.

---

secretsPrefix^Required

public readonly secretsPrefix: string;

• Type: string

---

secretsStorage^Required

public readonly secretsStorage: GitHubAppSecretsStorage;

• Type: GitHubAppSecretsStorage

---

ITokenProvider

• Implemented By: TokenProvider, ITokenProvider

Methods

Name	Description
grantExecute	Use this to grant access to the token provider.
grantExecuteGitHubActionsAbac	use this to grant access to the token provider when the role is assumed via Cognito Identity.

---

grantExecute

public grantExecute(role: IRole, repo: string, owner?: string): Grant

Use this to grant access to the token provider.

role^Required

• Type: aws-cdk-lib.aws_iam.IRole

---

repo^Required

• Type: string

---

owner^Optional

• Type: string

---

grantExecuteGitHubActionsAbac

public grantExecuteGitHubActionsAbac(role: IRole, settings: TokenProviderActionsIdentitySettings): Grant

use this to grant access to the token provider when the role is assumed via Cognito Identity.

role^Required

• Type: aws-cdk-lib.aws_iam.IRole

---

settings^Required

• Type: TokenProviderActionsIdentitySettings

---

ITokenProviderApi

• Implemented By: TokenProviderApi, ITokenProviderApi

Methods

Name	Description
newTokenProvider	No description.

---

newTokenProvider

public newTokenProvider(name: string, configuration: NewTokenProviderConfiguration): ITokenProvider

name^Required

• Type: string

---

configuration^Required

• Type: NewTokenProviderConfiguration

---

Enums

GitHubAppSecretsStorage

Members

Name	Description
PARAMETER_STORE	No description.
SECRETS_MANAGER	No description.

---

PARAMETER_STORE

---

SECRETS_MANAGER

---

PermissionLevel

Members

Name	Description
READ	No description.
WRITE	No description.
ADMIN	No description.

---

READ

---

WRITE

---

ADMIN

---

RepositorySelectionMode

Members

Name	Description
AT_LEAST_ONE	Allows targeting of any individual or multiple repos, but NOT the organization.
ALLOW_OWNER	Allows targeting of any individual or multiple repos and the organization/user.

---

AT_LEAST_ONE

Allows targeting of any individual or multiple repos, but NOT the organization.

---

ALLOW_OWNER

Allows targeting of any individual or multiple repos and the organization/user.

---

TokenProviderEndpointType

Members

Name	Description
DEFAULT	No description.
DYNAMIC_OWNER	No description.
STATIC_OWNER	No description.

---

DEFAULT

---

DYNAMIC_OWNER

---

STATIC_OWNER

---

TokenProviderPathPolicyVariable

Members

Name	Description
REPOSITORY	No description.
REPOSITORY_OWNER	No description.

---

REPOSITORY

---

REPOSITORY_OWNER

---

TokenProviderPathStrategyType

Members

Name	Description
POLICY_VAR	No description.
ANY_REPOSITORY	No description.
OWNER	No description.
REPOSITORIES	No description.

---

POLICY_VAR

---

ANY_REPOSITORY

---

OWNER

---

REPOSITORIES

---