software.amazon.awscdk.services.amplify

Interface GitHubSourceCodeProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubSourceCodeProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.125Z")
 @Stability(value=Experimental)
public interface GitHubSourceCodeProviderProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a GitHub source code provider.

Example:

 App amplifyApp = App.Builder.create(this, "MyApp")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(SecretValue.secretsManager("my-github-token"))
                 .build())
         .autoBranchCreation(AutoBranchCreation.builder() // Automatically connect branches that match a pattern set
                 .patterns(List.of("feature/*", "test/*")).build())
         .autoBranchDeletion(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GitHubSourceCodeProviderProps.Builder A builder for GitHubSourceCodeProviderProps
static class	GitHubSourceCodeProviderProps.Jsii$Proxy An implementation for GitHubSourceCodeProviderProps

Method Summary

Modifier and Type	Method and Description
static GitHubSourceCodeProviderProps.Builder	builder()
SecretValue	getOauthToken() (experimental) A personal access token with the `repo` scope.
String	getOwner() (experimental) The user or organization owning the repository.
String	getRepository() (experimental) The name of the repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOauthToken

@Stability(value=Experimental)
 @NotNull
SecretValue getOauthToken()

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

getOwner

@Stability(value=Experimental)
 @NotNull
String getOwner()

(experimental) The user or organization owning the repository.

getRepository

@Stability(value=Experimental)
 @NotNull
String getRepository()

(experimental) The name of the repository.

builder

@Stability(value=Experimental)
static GitHubSourceCodeProviderProps.Builder builder()

Returns:

a GitHubSourceCodeProviderProps.Builder of GitHubSourceCodeProviderProps