# API Reference ## Constructs ### BaseGitHubApps - *Implements:* IGitHubApps #### Initializers ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `getAppIdForAppName` ```typescript public getAppIdForAppName(name?: string): number ``` ###### `name`^Optional - *Type:* string --- ##### `grantAccess` ```typescript 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`~~ ```typescript 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `secretsPrefix`^Required ```typescript public readonly secretsPrefix: string; ``` - *Type:* string --- ##### `secretsStorage`^Required ```typescript public readonly secretsStorage: GitHubAppSecretsStorage; ``` - *Type:* GitHubAppSecretsStorage --- ### ManagedGitHubApps - *Implements:* IGitHubApps #### Initializers ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `getAppIdForAppName` ```typescript public getAppIdForAppName(name?: string): number ``` ###### `name`^Optional - *Type:* string --- ##### `grantAccess` ```typescript 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`~~ ```typescript 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `secretsPrefix`^Required ```typescript public readonly secretsPrefix: string; ``` - *Type:* string --- ##### `secretsStorage`^Required ```typescript public readonly secretsStorage: GitHubAppSecretsStorage; ``` - *Type:* GitHubAppSecretsStorage --- ### SelfManagedGitHubApps - *Implements:* IGitHubApps #### Initializers ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `getAppIdForAppName` ```typescript public getAppIdForAppName(name?: string): number ``` ###### `name`^Optional - *Type:* string --- ##### `grantAccess` ```typescript 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`~~ ```typescript 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `secretsPrefix`^Required ```typescript public readonly secretsPrefix: string; ``` - *Type:* string --- ##### `secretsStorage`^Required ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `grantExecute` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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`~~ ```typescript import { TokenProvider } from '@catnekaise/ghrawel' TokenProvider.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `create` ```typescript 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `httpMethod`^Required ```typescript public readonly httpMethod: string; ``` - *Type:* string --- ##### `methodArn`^Required ```typescript public readonly methodArn: string; ``` - *Type:* string --- ##### `methodId`^Required ```typescript public readonly methodId: string; ``` - *Type:* string --- ### TokenProviderApi - *Implements:* ITokenProviderApi #### Initializers ```typescript 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `newTokenProvider` ```typescript 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`~~ ```typescript 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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ##### `restApi`^Required ```typescript public readonly restApi: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi --- ## Structs ### GitHubAppPermissions #### Initializer ```typescript 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 ```typescript public readonly actions: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `administration`^Optional ```typescript public readonly administration: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `checks`^Optional ```typescript public readonly checks: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `codespaces`^Optional ```typescript public readonly codespaces: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `contents`^Optional ```typescript public readonly contents: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `dependabotSecrets`^Optional ```typescript public readonly dependabotSecrets: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `deployments`^Optional ```typescript public readonly deployments: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `emailAddresses`^Optional ```typescript public readonly emailAddresses: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `environments`^Optional ```typescript public readonly environments: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `followers`^Optional ```typescript public readonly followers: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `gitSshKeys`^Optional ```typescript public readonly gitSshKeys: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `gpgKeys`^Optional ```typescript public readonly gpgKeys: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `interactionLimits`^Optional ```typescript public readonly interactionLimits: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `issues`^Optional ```typescript public readonly issues: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `members`^Optional ```typescript public readonly members: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `metadata`^Optional ```typescript public readonly metadata: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationAdministration`^Optional ```typescript public readonly organizationAdministration: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationAnnouncementBanners`^Optional ```typescript public readonly organizationAnnouncementBanners: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationCopilotSeatManagement`^Optional ```typescript public readonly organizationCopilotSeatManagement: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationCustomOrgRoles`^Optional ```typescript public readonly organizationCustomOrgRoles: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationCustomProperties`^Optional ```typescript public readonly organizationCustomProperties: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationCustomRoles`^Optional ```typescript public readonly organizationCustomRoles: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationEvents`^Optional ```typescript public readonly organizationEvents: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationHooks`^Optional ```typescript public readonly organizationHooks: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationPackages`^Optional ```typescript public readonly organizationPackages: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationPersonalAccessTokenRequests`^Optional ```typescript public readonly organizationPersonalAccessTokenRequests: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationPersonalAccessTokens`^Optional ```typescript public readonly organizationPersonalAccessTokens: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationPlan`^Optional ```typescript public readonly organizationPlan: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationProjects`^Optional ```typescript public readonly organizationProjects: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationSecrets`^Optional ```typescript public readonly organizationSecrets: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationSelfHostedRunners`^Optional ```typescript public readonly organizationSelfHostedRunners: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `organizationUserBlocking`^Optional ```typescript public readonly organizationUserBlocking: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `packages`^Optional ```typescript public readonly packages: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `pages`^Optional ```typescript public readonly pages: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `profile`^Optional ```typescript public readonly profile: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `pullRequests`^Optional ```typescript public readonly pullRequests: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `repositoryCustomProperties`^Optional ```typescript public readonly repositoryCustomProperties: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `repositoryHooks`^Optional ```typescript public readonly repositoryHooks: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `repositoryProjects`^Optional ```typescript public readonly repositoryProjects: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `secrets`^Optional ```typescript public readonly secrets: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `secretScanningAlerts`^Optional ```typescript public readonly secretScanningAlerts: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `securityEvents`^Optional ```typescript public readonly securityEvents: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `singleFile`^Optional ```typescript public readonly singleFile: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `starring`^Optional ```typescript public readonly starring: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `statuses`^Optional ```typescript public readonly statuses: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `teamDiscussions`^Optional ```typescript public readonly teamDiscussions: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `vulnerabilityAlerts`^Optional ```typescript public readonly vulnerabilityAlerts: PermissionLevel; ``` - *Type:* PermissionLevel --- ##### `workflows`^Optional ```typescript public readonly workflows: PermissionLevel; ``` - *Type:* PermissionLevel --- ### GitHubAppsProps #### Initializer ```typescript 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 ```typescript public readonly defaultAppId: number; ``` - *Type:* number --- ##### `storage`^Required ```typescript public readonly storage: GitHubAppSecretsStorage; ``` - *Type:* GitHubAppSecretsStorage --- ##### `additionalApps`^Optional ```typescript public readonly additionalApps: GitHubApp[]; ``` - *Type:* GitHubApp[] --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string - *Default:* /catnekaise/github-apps --- ### ManagedGitHubAppsProps #### Initializer ```typescript 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 ```typescript public readonly defaultAppId: number; ``` - *Type:* number --- ##### `storage`^Required ```typescript public readonly storage: GitHubAppSecretsStorage; ``` - *Type:* GitHubAppSecretsStorage --- ##### `additionalApps`^Optional ```typescript public readonly additionalApps: GitHubApp[]; ``` - *Type:* GitHubApp[] --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string - *Default:* /catnekaise/github-apps --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* AWS_MANAGED --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy --- ### NewTokenProviderConfiguration #### Initializer ```typescript 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 ```typescript public readonly permissions: GitHubAppPermissions; ``` - *Type:* GitHubAppPermissions Permissions. --- ##### `app`^Optional ```typescript public readonly app: string; ``` - *Type:* string - *Default:* default --- ##### `endpoint`^Optional ```typescript public readonly endpoint: TokenProviderEndpoint; ``` - *Type:* TokenProviderEndpoint - *Default:* DEFAULT --- ##### `targetRule`^Optional ```typescript public readonly targetRule: TokenProviderTargetRule; ``` - *Type:* TokenProviderTargetRule - *Default:* AT_LEAST_ONE --- ### TargetRuleSettings #### Initializer ```typescript import { TargetRuleSettings } from '@catnekaise/ghrawel' const targetRuleSettings: TargetRuleSettings = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | mode | RepositorySelectionMode | *No description.* | --- ##### `mode`^Required ```typescript public readonly mode: RepositorySelectionMode; ``` - *Type:* RepositorySelectionMode --- ### TokenProviderActionsIdentitySettings #### Initializer ```typescript 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 ```typescript public readonly claimsContext: IClaimsContext; ``` - *Type:* @catnekaise/cdk-iam-utilities.IClaimsContext --- ##### `pathStrategy`^Optional ```typescript public readonly pathStrategy: TokenProviderPathStrategy; ``` - *Type:* TokenProviderPathStrategy --- ### TokenProviderApiProps #### Initializer ```typescript 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 ```typescript public readonly apps: IGitHubApps; ``` - *Type:* IGitHubApps GitHub Apps configuration. --- ##### `api`^Optional ```typescript 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 ```typescript public readonly lambda: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Use this to provide the Lambda Function configured to your requirements. --- ### TokenProviderConfiguratorIntegrationOptionsContext #### Initializer ```typescript 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 ```typescript public readonly appId: number; ``` - *Type:* number --- ##### `appName`^Required ```typescript public readonly appName: string; ``` - *Type:* string --- ##### `endpoint`^Required ```typescript public readonly endpoint: TokenProviderEndpoint; ``` - *Type:* TokenProviderEndpoint --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `permissions`^Required ```typescript public readonly permissions: GitHubAppPermissions; ``` - *Type:* GitHubAppPermissions --- ##### `targetRule`^Required ```typescript public readonly targetRule: TargetRuleSettings; ``` - *Type:* TargetRuleSettings --- ### TokenProviderConfiguratorMethodOptionsContext #### Initializer ```typescript 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 ```typescript public readonly endpointType: TokenProviderEndpointType; ``` - *Type:* TokenProviderEndpointType --- ##### `errorResponseModel`^Required ```typescript public readonly errorResponseModel: Model; ``` - *Type:* aws-cdk-lib.aws_apigateway.Model --- ##### `operationName`^Required ```typescript public readonly operationName: string; ``` - *Type:* string --- ##### `repositorySelectionMode`^Required ```typescript public readonly repositorySelectionMode: RepositorySelectionMode; ``` - *Type:* RepositorySelectionMode --- ##### `tokenResponseModel`^Required ```typescript public readonly tokenResponseModel: Model; ``` - *Type:* aws-cdk-lib.aws_apigateway.Model --- ##### `requestValidator`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly checkout: string; ``` - *Type:* string Value for `git checkout` after cloning the repository Example: main, origin/feature1, SHA. --- ##### `platform`^Optional ```typescript public readonly platform: string; ``` - *Type:* string Value for docker platform Example: linux/amd64. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string Repository Url Example: https://github.com/catnekaise/example-fork.git. --- ### TokenProviderMethodOptions #### Initializer ```typescript 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 ```typescript public readonly endpointType: TokenProviderEndpointType; ``` - *Type:* TokenProviderEndpointType --- ##### `errorResponseModel`^Required ```typescript public readonly errorResponseModel: Model; ``` - *Type:* aws-cdk-lib.aws_apigateway.Model --- ##### `operationName`^Required ```typescript public readonly operationName: string; ``` - *Type:* string --- ##### `requestValidator`^Required ```typescript public readonly requestValidator: RequestValidator; ``` - *Type:* aws-cdk-lib.aws_apigateway.RequestValidator --- ##### `tokenResponseModel`^Required ```typescript public readonly tokenResponseModel: Model; ``` - *Type:* aws-cdk-lib.aws_apigateway.Model --- ### TokenProviderSettings #### Initializer ```typescript 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 ```typescript public readonly api: IRestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.IRestApi --- ##### `app`^Required ```typescript public readonly app: string; ``` - *Type:* string --- ##### `appId`^Required ```typescript public readonly appId: number; ``` - *Type:* number --- ##### `configurator`^Required ```typescript public readonly configurator: TokenProviderConfigurator; ``` - *Type:* TokenProviderConfigurator --- ##### `endpoint`^Required ```typescript public readonly endpoint: TokenProviderEndpoint; ``` - *Type:* TokenProviderEndpoint --- ##### `lambda`^Required ```typescript public readonly lambda: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ##### `methodOptions`^Required ```typescript public readonly methodOptions: TokenProviderMethodOptions; ``` - *Type:* TokenProviderMethodOptions --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `permissions`^Required ```typescript public readonly permissions: GitHubAppPermissions; ``` - *Type:* GitHubAppPermissions --- ##### `targetRule`^Required ```typescript 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 ```typescript public readonly name: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ARM_64 | ApplicationArchitecture | *No description.* | | X86_64 | ApplicationArchitecture | *No description.* | --- ##### `ARM_64`^Required ```typescript public readonly ARM_64: ApplicationArchitecture; ``` - *Type:* ApplicationArchitecture --- ##### `X86_64`^Required ```typescript public readonly X86_64: ApplicationArchitecture; ``` - *Type:* ApplicationArchitecture --- ### GitHubApp #### Static Functions | **Name** | **Description** | | --- | --- | | create | *No description.* | --- ##### `create` ```typescript 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 ```typescript public readonly appId: number; ``` - *Type:* number --- ##### `name`^Required ```typescript 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` ```typescript 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` ```typescript public createIntegrationOptions(settings: TokenProviderConfiguratorIntegrationOptionsContext): LambdaIntegrationOptions ``` ###### `settings`^Required - *Type:* TokenProviderConfiguratorIntegrationOptionsContext --- ##### `createMethodOptions` ```typescript public createMethodOptions(input: TokenProviderConfiguratorMethodOptionsContext): MethodOptions ``` ###### `input`^Required - *Type:* TokenProviderConfiguratorMethodOptionsContext --- #### Static Functions | **Name** | **Description** | | --- | --- | | create | *No description.* | --- ##### `create` ```typescript import { TokenProviderConfigurator } from '@catnekaise/ghrawel' TokenProviderConfigurator.create() ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | integrationResponses | aws-cdk-lib.aws_apigateway.IntegrationResponse[] | *No description.* | --- ##### `integrationResponses`^Required ```typescript 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//{owner}/{repo}`. | | useOwner | Use this to configure a token provider at `/x//{owner}` or `/x//`. | --- ##### `useDefault` ```typescript import { TokenProviderEndpoint } from '@catnekaise/ghrawel' TokenProviderEndpoint.useDefault() ``` Use this to configure a token provider at `/x//{owner}/{repo}`. ##### `useOwner` ```typescript import { TokenProviderEndpoint } from '@catnekaise/ghrawel' TokenProviderEndpoint.useOwner(owner?: string) ``` Use this to configure a token provider at `/x//{owner}` or `/x//`. ###### `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 ```typescript public readonly isOwnerEndpoint: boolean; ``` - *Type:* boolean --- ##### `type`^Required ```typescript public readonly type: TokenProviderEndpointType; ``` - *Type:* TokenProviderEndpointType --- ##### `owner`^Optional ```typescript public readonly owner: string; ``` - *Type:* string --- ##### `repo`^Optional ```typescript public readonly repo: string; ``` - *Type:* string --- ### TokenProviderLambdaCode #### Initializers ```typescript import { TokenProviderLambdaCode } from '@catnekaise/ghrawel' new TokenProviderLambdaCode() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | defaultGo | *No description.* | | dotnet | *No description.* | --- ##### `defaultGo` ```typescript import { TokenProviderLambdaCode } from '@catnekaise/ghrawel' TokenProviderLambdaCode.defaultGo(options?: TokenProviderLambdaCodeOptions) ``` ###### `options`^Optional - *Type:* TokenProviderLambdaCodeOptions --- ##### `dotnet` ```typescript import { TokenProviderLambdaCode } from '@catnekaise/ghrawel' TokenProviderLambdaCode.dotnet(options?: TokenProviderLambdaCodeOptions) ``` ###### `options`^Optional - *Type:* TokenProviderLambdaCodeOptions --- ### TokenProviderPathStrategy #### Static Functions | **Name** | **Description** | | --- | --- | | anyRepository | Grants permission to `/x//*`. | | policyVarRepository | Grants permission to `/x//${aws:PrincipalTag/repository}`. | | policyVarRepositoryOwner | Grants permission to `/x//${aws:PrincipalTag/repository_owner}` or `/x//${aws:PrincipalTag/repository_owner}/`. | | selectOwner | Grants permission to `/x//`. | | selectRepositories | Grants permission for each specified repo `/x///`. | --- ##### `anyRepository` ```typescript import { TokenProviderPathStrategy } from '@catnekaise/ghrawel' TokenProviderPathStrategy.anyRepository() ``` Grants permission to `/x//*`. ##### `policyVarRepository` ```typescript import { TokenProviderPathStrategy } from '@catnekaise/ghrawel' TokenProviderPathStrategy.policyVarRepository() ``` Grants permission to `/x//${aws:PrincipalTag/repository}`. ##### `policyVarRepositoryOwner` ```typescript import { TokenProviderPathStrategy } from '@catnekaise/ghrawel' TokenProviderPathStrategy.policyVarRepositoryOwner(repositories: string) ``` Grants permission to `/x//${aws:PrincipalTag/repository_owner}` or `/x//${aws:PrincipalTag/repository_owner}/`. ###### `repositories`^Required - *Type:* string --- ##### `selectOwner` ```typescript import { TokenProviderPathStrategy } from '@catnekaise/ghrawel' TokenProviderPathStrategy.selectOwner(owner: string) ``` Grants permission to `/x//`. ###### `owner`^Required - *Type:* string --- ##### `selectRepositories` ```typescript import { TokenProviderPathStrategy } from '@catnekaise/ghrawel' TokenProviderPathStrategy.selectRepositories(owner: string, repositories: string) ``` Grants permission for each specified repo `/x///`. ###### `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 ```typescript public readonly pathTargetsRepositories: boolean; ``` - *Type:* boolean --- ##### `repositories`^Required ```typescript public readonly repositories: string[]; ``` - *Type:* string[] --- ##### `type`^Required ```typescript public readonly type: TokenProviderPathStrategyType; ``` - *Type:* TokenProviderPathStrategyType --- ##### `owner`^Optional ```typescript public readonly owner: string; ``` - *Type:* string --- ##### `policyVar`^Optional ```typescript public readonly policyVar: TokenProviderPathPolicyVariable; ``` - *Type:* TokenProviderPathPolicyVariable --- ### TokenProviderTargetRule #### Static Functions | **Name** | **Description** | | --- | --- | | allowOwner | *No description.* | | atLeastOne | *No description.* | --- ##### `allowOwner` ```typescript import { TokenProviderTargetRule } from '@catnekaise/ghrawel' TokenProviderTargetRule.allowOwner() ``` ##### `atLeastOne` ```typescript import { TokenProviderTargetRule } from '@catnekaise/ghrawel' TokenProviderTargetRule.atLeastOne() ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repositorySelectionMode | RepositorySelectionMode | *No description.* | --- ##### `repositorySelectionMode`^Required ```typescript public readonly repositorySelectionMode: RepositorySelectionMode; ``` - *Type:* RepositorySelectionMode --- ## Protocols ### IGitHubApps - *Implemented By:* BaseGitHubApps, ManagedGitHubApps, SelfManagedGitHubApps, IGitHubApps #### Methods | **Name** | **Description** | | --- | --- | | getAppIdForAppName | *No description.* | | grantAccess | *No description.* | --- ##### `getAppIdForAppName` ```typescript public getAppIdForAppName(name?: string): number ``` ###### `name`^Optional - *Type:* string --- ##### `grantAccess` ```typescript 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 ```typescript public readonly secretsPrefix: string; ``` - *Type:* string --- ##### `secretsStorage`^Required ```typescript 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` ```typescript 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` ```typescript 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` ```typescript 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` ---