GitHubInputProperty Struct
The input required to create a GitHub integration.
Example
ts
// 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
The OAuth authorization code received from GitHub.
installationIdoptionalstringinstallation_idoptionalstrinstallationIdoptionalStringInstallationIdoptionalstringInstallationIdoptional*string#The installation identifier provided by GitHub Enterprise Server on the install callback.
Required for GitHub Enterprise Server integrations and ignored for GitHub.com.
organizationNameoptionalstringorganization_nameoptionalstrorganizationNameoptionalStringOrganizationNameoptionalstringOrganizationNameoptional*string#The name of the GitHub organization to integrate with.
The CSRF state token for validating the OAuth flow.
targetUrloptionalstringtarget_urloptionalstrtargetUrloptionalStringTargetUrloptionalstringTargetUrloptional*string#The HTTPS URL of a self-hosted GitHub Enterprise Server instance.
Omit this value for GitHub.com.