Class GitHubRepositoryProps
(experimental) Construction properties of GitHubRepository
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Codestar.Alpha
Assembly: Amazon.CDK.AWS.CodeStar.Alpha.dll
Syntax (csharp)
public class GitHubRepositoryProps : Object, IGitHubRepositoryProps
Syntax (vb)
Public Class GitHubRepositoryProps
Inherits Object
Implements IGitHubRepositoryProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.Codestar.Alpha;
using Amazon.CDK.AWS.S3;
new GitHubRepository(this, "GitHubRepo", new GitHubRepositoryProps {
Owner = "aws",
RepositoryName = "aws-cdk",
AccessToken = SecretValue.SecretsManager("my-github-token", new SecretsManagerSecretOptions {
JsonField = "token"
}),
ContentsBucket = Bucket.FromBucketName(this, "Bucket", "bucket-name"),
ContentsKey = "import.zip"
});
Synopsis
Constructors
GitHubRepositoryProps() |
Properties
AccessToken | (experimental) The GitHub user's personal access token for the GitHub repository. |
ContentsBucket | (experimental) The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository. |
ContentsKey | (experimental) The S3 object key or file name for the ZIP file. |
ContentsS3Version | (experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. |
Description | (experimental) A comment or description about the new repository. |
EnableIssues | (experimental) Indicates whether to enable issues for the GitHub repository. |
Owner | (experimental) The GitHub user name for the owner of the GitHub repository to be created. |
RepositoryName | (experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation. |
Visibility | (experimental) Indicates whether the GitHub repository is a private repository. |
Constructors
GitHubRepositoryProps()
public GitHubRepositoryProps()
Properties
AccessToken
(experimental) The GitHub user's personal access token for the GitHub repository.
public SecretValue AccessToken { get; set; }
Property Value
Remarks
Stability: Experimental
ContentsBucket
(experimental) The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
public IBucket ContentsBucket { get; set; }
Property Value
Remarks
Stability: Experimental
ContentsKey
(experimental) The S3 object key or file name for the ZIP file.
public string ContentsKey { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
ContentsS3Version
(experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
public string ContentsS3Version { get; set; }
Property Value
System.String
Remarks
Default: - not specified
Stability: Experimental
Description
(experimental) A comment or description about the new repository.
public string Description { get; set; }
Property Value
System.String
Remarks
This description is displayed in GitHub after the repository is created.
Default: - no description
Stability: Experimental
EnableIssues
(experimental) Indicates whether to enable issues for the GitHub repository.
public Nullable<bool> EnableIssues { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
You can use GitHub issues to track information and bugs for your repository.
Default: true
Stability: Experimental
Owner
(experimental) The GitHub user name for the owner of the GitHub repository to be created.
public string Owner { get; set; }
Property Value
System.String
Remarks
If this repository should be owned by a GitHub organization, provide its name
Stability: Experimental
RepositoryName
(experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
public string RepositoryName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
Visibility
(experimental) Indicates whether the GitHub repository is a private repository.
public Nullable<RepositoryVisibility> Visibility { get; set; }
Property Value
System.Nullable<RepositoryVisibility>
Remarks
If so, you choose who can see and commit to this repository.
Default: RepositoryVisibility.PUBLIC
Stability: Experimental