Skip to content
v2.278.0

GitHubConfigurationProperty Struct ​

Configuration for GitHub repository integration.

Defines the repository name, numeric repository ID, owner name, and owner type (user or organization) required for the Agent Space to access and interact with the GitHub repository.

Example ​

ts
// 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 gitHubConfigurationProperty: devopsagent.CfnAssociation.GitHubConfigurationProperty = {
  owner: 'owner',
  ownerType: 'ownerType',
  repoId: 'repoId',
  repoName: 'repoName',

  // the properties below are optional
  releaseManagementAssociationId: 'releaseManagementAssociationId',
};
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_devopsagent as devopsagent

git_hub_configuration_property = devopsagent.CfnAssociation.GitHubConfigurationProperty(
    owner="owner",
    owner_type="ownerType",
    repo_id="repoId",
    repo_name="repoName",

    # the properties below are optional
    release_management_association_id="releaseManagementAssociationId"
)
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.devopsagent.*;

GitHubConfigurationProperty gitHubConfigurationProperty = GitHubConfigurationProperty.builder()
        .owner("owner")
        .ownerType("ownerType")
        .repoId("repoId")
        .repoName("repoName")

        // the properties below are optional
        .releaseManagementAssociationId("releaseManagementAssociationId")
        .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.DevOpsAgent;

var gitHubConfigurationProperty = new GitHubConfigurationProperty {
    Owner = "owner",
    OwnerType = "ownerType",
    RepoId = "repoId",
    RepoName = "repoName",

    // the properties below are optional
    ReleaseManagementAssociationId = "releaseManagementAssociationId"
};
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"

gitHubConfigurationProperty := &GitHubConfigurationProperty{
	Owner: jsii.String("owner"),
	OwnerType: jsii.String("ownerType"),
	RepoId: jsii.String("repoId"),
	RepoName: jsii.String("repoName"),

	// the properties below are optional
	ReleaseManagementAssociationId: jsii.String("releaseManagementAssociationId"),
}

Properties ​

ownerstringownerstrownerStringOwnerstringOwner*string required #
Repository owner.
ownerTypestringowner_typestrownerTypeStringOwnerTypestringOwnerType*string required #
Type of repository owner.
releaseManagementAssociationIdoptionalstringrelease_management_association_idoptionalstrreleaseManagementAssociationIdoptionalStringReleaseManagementAssociationIdoptionalstringReleaseManagementAssociationIdoptional*string #
The ID of the release management association that this repository uses for automated testing.
repoIdstringrepo_idstrrepoIdStringRepoIdstringRepoId*string required #
Associated Github repo ID.
repoNamestringrepo_namestrrepoNameStringRepoNamestringRepoName*string required #
Associated Github repo name.