GitHubInputProperty Struct
The input required to create a GitHub integration.
| Source | |
|---|---|
| Type last changed |
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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securityagent as securityagent
git_hub_input_property = securityagent.CfnIntegration.GitHubInputProperty(
code="code",
state="state",
# the properties below are optional
installation_id="installationId",
organization_name="organizationName",
target_url="targetUrl"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.securityagent.*;
GitHubInputProperty gitHubInputProperty = GitHubInputProperty.builder()
.code("code")
.state("state")
// the properties below are optional
.installationId("installationId")
.organizationName("organizationName")
.targetUrl("targetUrl")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityAgent;
var gitHubInputProperty = new GitHubInputProperty {
Code = "code",
State = "state",
// the properties below are optional
InstallationId = "installationId",
OrganizationName = "organizationName",
TargetUrl = "targetUrl"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
gitHubInputProperty := &GitHubInputProperty{
Code: jsii.String("code"),
State: jsii.String("state"),
// the properties below are optional
InstallationId: jsii.String("installationId"),
OrganizationName: jsii.String("organizationName"),
TargetUrl: jsii.String("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.