Show / Hide Table of Contents

Interface ICfnGitHubRepositoryProps

Properties for defining a CfnGitHubRepository.

Namespace: Amazon.CDK.AWS.Codestar

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnGitHubRepositoryProps

Syntax (vb)

Public Interface ICfnGitHubRepositoryProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Codestar;

             var cfnGitHubRepositoryProps = new CfnGitHubRepositoryProps {
                 RepositoryName = "repositoryName",
                 RepositoryOwner = "repositoryOwner",

                 // the properties below are optional
                 Code = new CodeProperty {
                     S3 = new S3Property {
                         Bucket = "bucket",
                         Key = "key",

                         // the properties below are optional
                         ObjectVersion = "objectVersion"
                     }
                 },
                 ConnectionArn = "connectionArn",
                 EnableIssues = false,
                 IsPrivate = false,
                 RepositoryAccessToken = "repositoryAccessToken",
                 RepositoryDescription = "repositoryDescription"
             };

Synopsis

Properties

Code	Information about code to be committed to a repository after it is created in an CloudFormation stack.
ConnectionArn	Properties for defining a `CfnGitHubRepository`.
EnableIssues	Indicates whether to enable issues for the GitHub repository.
IsPrivate	Indicates whether the GitHub repository is a private repository.
RepositoryAccessToken	The GitHub user's personal access token for the GitHub repository.
RepositoryDescription	A comment or description about the new repository.
RepositoryName	The name of the repository you want to create in GitHub with CloudFormation stack creation.
RepositoryOwner	The GitHub user name for the owner of the GitHub repository to be created.

Properties

Code

Information about code to be committed to a repository after it is created in an CloudFormation stack.

object? Code { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code

Type union: either IResolvable or CfnGitHubRepository.ICodeProperty

ConnectionArn

Properties for defining a CfnGitHubRepository.

string? ConnectionArn { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-connectionarn

EnableIssues

Indicates whether to enable issues for the GitHub repository.

object? EnableIssues { get; }

Property Value

Remarks

You can use GitHub issues to track information and bugs for your repository.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues

Type union: either bool or IResolvable

IsPrivate

Indicates whether the GitHub repository is a private repository.

object? IsPrivate { get; }

Property Value

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate

Type union: either bool or IResolvable

RepositoryAccessToken

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

string? RepositoryAccessToken { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken

RepositoryDescription

A comment or description about the new repository.

string? RepositoryDescription { get; }

Property Value

Remarks

This description is displayed in GitHub after the repository is created.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription

RepositoryName

The name of the repository you want to create in GitHub with CloudFormation stack creation.

string RepositoryName { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname

RepositoryOwner

The GitHub user name for the owner of the GitHub repository to be created.

string RepositoryOwner { get; }

Property Value

Remarks

If this repository should be owned by a GitHub organization, provide its name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner