Package software.amazon.awscdk.services.amplify

Interface SourceCodeProviderConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourceCodeProviderConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.163Z")
@Stability(Experimental)
public interface SourceCodeProviderConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration for the source code provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 import software.amazon.awscdk.core.*;
 SecretValue secretValue;
 SourceCodeProviderConfig sourceCodeProviderConfig = SourceCodeProviderConfig.builder()
         .repository("repository")
         // the properties below are optional
         .accessToken(secretValue)
         .oauthToken(secretValue)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceCodeProviderConfig.Builder	builder()
default SecretValue	getAccessToken()	(experimental) Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
default SecretValue	getOauthToken()	(experimental) OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
String	getRepository()	(experimental) The repository for the application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepository

@Stability(Experimental)
@NotNull
String getRepository()

(experimental) The repository for the application. Must use the HTTPS protocol.

For example, https://github.com/aws/aws-cdk.

getAccessToken

@Stability(Experimental)
@Nullable
default SecretValue getAccessToken()

(experimental) Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

Token is not stored.

Either accessToken or oauthToken must be specified if repository is sepcified.

Default: - do not use a token

getOauthToken

@Stability(Experimental)
@Nullable
default SecretValue getOauthToken()

(experimental) OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

OAuth token is not stored.

Either accessToken or oauthToken must be specified if repository is specified.

Default: - do not use a token

builder

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

Returns:

a SourceCodeProviderConfig.Builder of SourceCodeProviderConfig