Package software.amazon.awscdk.services.apprunner.alpha

Class GitHubConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apprunner.alpha.GitHubConnection
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:25.617Z") @Stability(Experimental) public class GitHubConnection extends software.amazon.jsii.JsiiObject
(experimental) Represents the App Runner connection that enables the App Runner service to connect to a source repository.

It's required for GitHub code repositories.

Example: 

 Service.Builder.create(this, "Service")
         .source(Source.fromGitHub(GithubRepositoryProps.builder()
                 .repositoryUrl("https://github.com/aws-containers/hello-app-runner")
                 .branch("main")
                 .configurationSource(ConfigurationSourceType.REPOSITORY)
                 .connection(GitHubConnection.fromConnectionArn("CONNECTION_ARN"))
                 .build()))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    GitHubConnection(String arn)
     
    protected
    GitHubConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    GitHubConnection(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static GitHubConnection
    fromConnectionArn(String arn)
    (experimental) Using existing App Runner connection by specifying the connection ARN.
    String
    getConnectionArn()
    (experimental) The ARN of the Connection for App Runner service to connect to the repository.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • GitHubConnection

      protected GitHubConnection(software.amazon.jsii.JsiiObjectRef objRef)

    • GitHubConnection

      protected GitHubConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • GitHubConnection

      @Stability(Experimental) public GitHubConnection(@NotNull String arn)
      Parameters:
      arn - This parameter is required.

  • Method Details

    • fromConnectionArn

      @Stability(Experimental) @NotNull public static GitHubConnection fromConnectionArn(@NotNull String arn)
      (experimental) Using existing App Runner connection by specifying the connection ARN.

      Parameters:
      arn - connection ARN. This parameter is required.
      Returns:
      Connection

    • getConnectionArn

      @Stability(Experimental) @NotNull public String getConnectionArn()
      (experimental) The ARN of the Connection for App Runner service to connect to the repository.