com.cloudsnorkel.cdk.github.runners.Secrets Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk.github.runners Show documentation
CDK construct to create GitHub Actions self-hosted runners. A webhook listens to events and creates ephemeral runners on the fly.
There is a newer version: 0.14.6
Show newest version
package com.cloudsnorkel.cdk.github.runners;

/**
 * (experimental) Secrets required for GitHub runners operation.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-14T02:42:19.539Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = com.cloudsnorkel.cdk.github.runners.$Module.class, fqn = "@cloudsnorkel/cdk-github-runners.Secrets")
public class Secrets extends software.constructs.Construct {

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

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

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

    /**
     * (experimental) Authentication secret for GitHub containing either app details or personal access token.
     * 
     * This secret is used to register runners and
     * cancel jobs when the runner fails to start.
     * 

     * This secret is meant to be edited by the user after being created.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.secretsmanager.Secret getGithub() {
        return software.amazon.jsii.Kernel.get(this, "github", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.Secret.class));
    }

    /**
     * (experimental) GitHub app private key. Not needed when using personal access tokens.
     * 

     * This secret is meant to be edited by the user after being created. It is separate than the main GitHub secret because inserting private keys into JSON is hard.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.secretsmanager.Secret getGithubPrivateKey() {
        return software.amazon.jsii.Kernel.get(this, "githubPrivateKey", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.Secret.class));
    }

    /**
     * (experimental) Setup secret used to authenticate user for our setup wizard.
     * 
     * Should be empty after setup has been completed.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.secretsmanager.Secret getSetup() {
        return software.amazon.jsii.Kernel.get(this, "setup", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.Secret.class));
    }

    /**
     * (experimental) Webhook secret used to confirm events are coming from GitHub and nowhere else.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.secretsmanager.Secret getWebhook() {
        return software.amazon.jsii.Kernel.get(this, "webhook", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.Secret.class));
    }
}