Package software.amazon.awscdk.pipelines

Class GitHubSourceOptions.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.pipelines.GitHubSourceOptions.Jsii$Proxy
All Implemented Interfaces:
GitHubSourceOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GitHubSourceOptions
@Stability(Stable) @Internal public static final class GitHubSourceOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GitHubSourceOptions
An implementation for GitHubSourceOptions

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GitHubSourceOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GitHubSourceOptions.Builder.

  • Method Details

    • getActionName

      public final String getActionName()
      Description copied from interface: GitHubSourceOptions
      The action name used for this source in the CodePipeline.

      Default: - The repository string

      Specified by:
      getActionName in interface GitHubSourceOptions

    • getAuthentication

      public final SecretValue getAuthentication()
      Description copied from interface: GitHubSourceOptions
      A GitHub OAuth token to use for authentication.

      It is recommended to use a Secrets Manager Secret to obtain the token: 

       SecretValue oauth = SecretValue.secretsManager("my-github-token");

      The GitHub Personal Access Token should have these scopes:

      • repo - to read the repository
      • admin:repo_hook - if you plan to use webhooks (true by default)

      Default: - SecretValue.secretsManager('github-token')

      Specified by:
      getAuthentication in interface GitHubSourceOptions
      See Also:

    • getTrigger

      public final GitHubTrigger getTrigger()
      Description copied from interface: GitHubSourceOptions
      How AWS CodePipeline should be triggered.

      With the default value "WEBHOOK", a webhook is created in GitHub that triggers the action. With "POLL", CodePipeline periodically checks the source for changes. With "None", the action is not triggered through changes in the source.

      To use WEBHOOK, your GitHub Personal Access Token should have admin:repo_hook scope (in addition to the regular repo scope).

      Default: GitHubTrigger.WEBHOOK

      Specified by:
      getTrigger in interface GitHubSourceOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object