Class GitHubSourceCodeProviderProps

(experimental) Properties for a GitHub source code provider.

Inheritance

System.Object

GitHubSourceCodeProviderProps

Implements

IGitHubSourceCodeProviderProps

Namespace: Amazon.CDK.AWS.Amplify.Alpha

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

Syntax (csharp)

public class GitHubSourceCodeProviderProps : Object, IGitHubSourceCodeProviderProps

Syntax (vb)

Public Class GitHubSourceCodeProviderProps
    Inherits Object
    Implements IGitHubSourceCodeProviderProps

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

var amplifyApp = new App(this, "MyApp", new AppProps {
    SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
        Owner = "<user>",
        Repository = "<repo>",
        OauthToken = SecretValue.SecretsManager("my-github-token")
    }),
    AutoBranchCreation = new AutoBranchCreation {  // Automatically connect branches that match a pattern set
        Patterns = new [] { "feature/*", "test/*" } },
    AutoBranchDeletion = true
});

Synopsis

Constructors

GitHubSourceCodeProviderProps()

Properties

OauthToken	(experimental) A personal access token with the repo scope.
Owner	(experimental) The user or organization owning the repository.
Repository	(experimental) The name of the repository.

Constructors

GitHubSourceCodeProviderProps()

public GitHubSourceCodeProviderProps()

Properties

OauthToken

(experimental) A personal access token with the repo scope.

public SecretValue OauthToken { get; set; }

Property Value

SecretValue

Remarks

Stability: Experimental

Owner

(experimental) The user or organization owning the repository.

public string Owner { get; set; }

Property Value

System.String

Remarks

Stability: Experimental

Repository

(experimental) The name of the repository.

public string Repository { get; set; }

Property Value

System.String

Remarks

Stability: Experimental

Implements

IGitHubSourceCodeProviderProps