aws-cdk-lib.aws_securityagent.CfnIntegration.GitHubInputProperty

GitHubInputProperty Struct Added in v2.274.0

The input required to create a GitHub integration.

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_securityagent as securityagent } from 'aws-cdk-lib';
const gitHubInputProperty: securityagent.CfnIntegration.GitHubInputProperty = {
  code: 'code',
  state: 'state',

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

Properties

codestringcodestrcodeStringCodestringCode*stringrequired#

The OAuth authorization code received from GitHub.

installationIdstringinstallation_idstrinstallationIdStringInstallationIdstringInstallationId*string#

The installation identifier provided by GitHub Enterprise Server on the install callback.

Required for GitHub Enterprise Server integrations and ignored for GitHub.com.

organizationNamestringorganization_namestrorganizationNameStringOrganizationNamestringOrganizationName*string#

The name of the GitHub organization to integrate with.

statestringstatestrstateStringStatestringState*stringrequired#

The CSRF state token for validating the OAuth flow.

targetUrlstringtarget_urlstrtargetUrlStringTargetUrlstringTargetUrl*string#

The HTTPS URL of a self-hosted GitHub Enterprise Server instance.

Omit this value for GitHub.com.