software.amazon.awscdk.services.apprunner.alpha.GitHubConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apprunner-alpha Show documentation
The CDK Construct Library for AWS::AppRunner
There is a newer version: 2.173.2-alpha.0
package software.amazon.awscdk.services.apprunner.alpha;

/**
 * (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();
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-11-22T02:24:11.365Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.apprunner.alpha.$Module.class, fqn = "@aws-cdk/aws-apprunner-alpha.GitHubConnection")
public class GitHubConnection extends software.amazon.jsii.JsiiObject {

    protected GitHubConnection(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected GitHubConnection(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param arn This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public GitHubConnection(final @org.jetbrains.annotations.NotNull java.lang.String arn) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(arn, "arn is required") });
    }

    /**
     * (experimental) Using existing App Runner connection by specifying the connection ARN.
     * 
     * @return Connection
     * @param arn connection ARN. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public static @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.apprunner.alpha.GitHubConnection fromConnectionArn(final @org.jetbrains.annotations.NotNull java.lang.String arn) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.services.apprunner.alpha.GitHubConnection.class, "fromConnectionArn", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.apprunner.alpha.GitHubConnection.class), new Object[] { java.util.Objects.requireNonNull(arn, "arn is required") });
    }

    /**
     * (experimental) The ARN of the Connection for App Runner service to connect to the repository.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull java.lang.String getConnectionArn() {
        return software.amazon.jsii.Kernel.get(this, "connectionArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
    }
}