Class GitHubSourceCodeProviderProps

(experimental) Properties for a GitHub source code provider.

Inheritance

object

GitHubSourceCodeProviderProps

Implements

IGitHubSourceCodeProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Amplify.Alpha

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

Syntax (csharp)

public class GitHubSourceCodeProviderProps : IGitHubSourceCodeProviderProps

Syntax (vb)

Public Class GitHubSourceCodeProviderProps Implements IGitHubSourceCodeProviderProps

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

var amplifyApp = new App(this, "App", new AppProps {
                 SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
                     Owner = "<user>",
                     Repository = "<repo>",
                     OauthToken = SecretValue.SecretsManager("my-github-token")
                 }),
                 CustomResponseHeaders = new [] { new CustomResponseHeader {
                     Pattern = "*.json",
                     Headers = new Dictionary<string, string> {
                         { "custom-header-name-1", "custom-header-value-1" },
                         { "custom-header-name-2", "custom-header-value-2" }
                     }
                 }, new CustomResponseHeader {
                     Pattern = "/path/*",
                     Headers = new Dictionary<string, string> {
                         { "custom-header-name-1", "custom-header-value-2" }
                     }
                 } }
             });

Synopsis

Constructors

GitHubSourceCodeProviderProps()

(experimental) Properties for a GitHub source code provider.

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()

(experimental) Properties for a GitHub source code provider.

public GitHubSourceCodeProviderProps()

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

var amplifyApp = new App(this, "App", new AppProps {
                 SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
                     Owner = "<user>",
                     Repository = "<repo>",
                     OauthToken = SecretValue.SecretsManager("my-github-token")
                 }),
                 CustomResponseHeaders = new [] { new CustomResponseHeader {
                     Pattern = "*.json",
                     Headers = new Dictionary<string, string> {
                         { "custom-header-name-1", "custom-header-value-1" },
                         { "custom-header-name-2", "custom-header-value-2" }
                     }
                 }, new CustomResponseHeader {
                     Pattern = "/path/*",
                     Headers = new Dictionary<string, string> {
                         { "custom-header-name-1", "custom-header-value-2" }
                     }
                 } }
             });

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

string

Remarks

Stability: Experimental

Repository

(experimental) The name of the repository.

public string Repository { get; set; }

Property Value

string

Remarks

Stability: Experimental

Implements

IGitHubSourceCodeProviderProps