Package software.amazon.awscdk.services.amplify.alpha

Interface GitHubSourceCodeProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubSourceCodeProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:25.427Z")
@Stability(Experimental)
public interface GitHubSourceCodeProviderProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a GitHub source code provider.

Example:

 App amplifyApp = App.Builder.create(this, "App")
         .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
                 .owner("<user>")
                 .repository("<repo>")
                 .oauthToken(SecretValue.secretsManager("my-github-token"))
                 .build())
         .customResponseHeaders(List.of(CustomResponseHeader.builder()
                 .pattern("*.json")
                 .headers(Map.of(
                         "custom-header-name-1", "custom-header-value-1",
                         "custom-header-name-2", "custom-header-value-2"))
                 .build(), CustomResponseHeader.builder()
                 .pattern("/path/*")
                 .headers(Map.of(
                         "custom-header-name-1", "custom-header-value-2"))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getOauthToken

@Stability(Experimental)
@NotNull
SecretValue getOauthToken()

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

getOwner

@Stability(Experimental)
@NotNull
String getOwner()

(experimental) The user or organization owning the repository.

getRepository

@Stability(Experimental)
@NotNull
String getRepository()

(experimental) The name of the repository.

builder

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

Returns:

a GitHubSourceCodeProviderProps.Builder of GitHubSourceCodeProviderProps