aws-cdk-lib.aws_devopsagent.CfnService.GitHubPatDetailsProperty

GitHubPatDetailsProperty Struct Added in v2.274.0

The token is stored and used as the long-lived credential for GitHub API access.

Source

Generated code

Type last changed

v2.274.0 · 20 Oct 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';
const gitHubPatDetailsProperty: devopsagent.CfnService.GitHubPatDetailsProperty = {
  tokenValue: 'tokenValue',

  // the properties below are optional
  organizationName: 'organizationName',
  targetUrl: 'targetUrl',
};

Properties

organizationNamestringorganization_namestrorganizationNameStringOrganizationNamestringOrganizationName*string#

GitHub organization to scope the service to.

The token must be an active member of the organization and only that organization's repositories are accessible. Omit to register the token's own user account

targetUrlstringtarget_urlstrtargetUrlStringTargetUrlstringTargetUrl*string#

GitHub instance URL.

Omit for github.com. Provide the instance host for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency (e.g. https://github.example.com)

tokenValuestringtoken_valuestrtokenValueStringTokenValuestringTokenValue*stringrequired#

GitHub personal access token (PAT) value.

Accepts classic PATs (ghp_...), fine-grained PATs (github_pat_...), and GitHub Enterprise Server token formats