Class CfnGitHubRepository
A CloudFormation AWS::CodeStar::GitHubRepository
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeStar
Assembly: Amazon.CDK.AWS.CodeStar.dll
Syntax (csharp)
public class CfnGitHubRepository : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGitHubRepository
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::CodeStar::GitHubRepository
resource creates a GitHub repository where users can store source code for use with AWS workflows. You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf. For more information about using a GitHub source repository with AWS CodeStar projects, see AWS CodeStar Project Files and Resources .
CloudformationResource: AWS::CodeStar::GitHubRepository
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 cfnGitHubRepository = new CfnGitHubRepository(this, "MyCfnGitHubRepository", 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
Constructors
CfnGitHubRepository(Construct, String, ICfnGitHubRepositoryProps) | Create a new |
CfnGitHubRepository(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGitHubRepository(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Code | Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. |
ConnectionArn |
|
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 AWS CloudFormation stack creation. |
RepositoryOwner | The GitHub user name for the owner of the GitHub repository to be created. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGitHubRepository(Construct, String, ICfnGitHubRepositoryProps)
Create a new AWS::CodeStar::GitHubRepository
.
public CfnGitHubRepository(Construct scope, string id, ICfnGitHubRepositoryProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGitHubRepositoryProps
- resource properties.
CfnGitHubRepository(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGitHubRepository(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGitHubRepository(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGitHubRepository(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Code
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
public virtual object Code { get; set; }
Property Value
System.Object
Remarks
ConnectionArn
AWS::CodeStar::GitHubRepository.ConnectionArn
.
public virtual string ConnectionArn { get; set; }
Property Value
System.String
Remarks
EnableIssues
Indicates whether to enable issues for the GitHub repository.
public virtual object EnableIssues { get; set; }
Property Value
System.Object
Remarks
You can use GitHub issues to track information and bugs for your repository.
IsPrivate
Indicates whether the GitHub repository is a private repository.
public virtual object IsPrivate { get; set; }
Property Value
System.Object
Remarks
If so, you choose who can see and commit to this repository.
RepositoryAccessToken
The GitHub user's personal access token for the GitHub repository.
public virtual string RepositoryAccessToken { get; set; }
Property Value
System.String
Remarks
RepositoryDescription
A comment or description about the new repository.
public virtual string RepositoryDescription { get; set; }
Property Value
System.String
Remarks
This description is displayed in GitHub after the repository is created.
RepositoryName
The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
public virtual string RepositoryName { get; set; }
Property Value
System.String
Remarks
RepositoryOwner
The GitHub user name for the owner of the GitHub repository to be created.
public virtual string RepositoryOwner { get; set; }
Property Value
System.String
Remarks
If this repository should be owned by a GitHub organization, provide its name.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>