Interface IGitHubRepositoryProps

(experimental) Construction properties of GitHubRepository.

Namespace: Amazon.CDK.AWS.Codestar.Alpha

Assembly: Amazon.CDK.AWS.CodeStar.Alpha.dll

Syntax (csharp)

public interface IGitHubRepositoryProps

Syntax (vb)

Public Interface 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", "amzn-s3-demo-bucket"),
                 ContentsKey = "import.zip"
             });

Synopsis

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.

Properties

AccessToken

(experimental) The GitHub user's personal access token for the GitHub repository.

SecretValue AccessToken { get; }

Property Value

SecretValue

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.

IBucketRef ContentsBucket { get; }

Property Value

IBucketRef

Remarks

Stability: Experimental

ContentsKey

(experimental) The S3 object key or file name for the ZIP file.

string ContentsKey { get; }

Property Value

string

Remarks

Stability: Experimental

ContentsS3Version

(experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

string? ContentsS3Version { get; }

Property Value

string

Remarks

Default: - not specified

Stability: Experimental

Description

(experimental) A comment or description about the new repository.

string? Description { get; }

Property Value

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.

bool? EnableIssues { get; }

Property Value

bool?

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.

string Owner { get; }

Property Value

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.

string RepositoryName { get; }

Property Value

string

Remarks

Stability: Experimental

Visibility

(experimental) Indicates whether the GitHub repository is a private repository.

RepositoryVisibility? Visibility { get; }

Property Value

RepositoryVisibility?

Remarks

If so, you choose who can see and commit to this repository.

Default: RepositoryVisibility.PUBLIC

Stability: Experimental