com.cloudsnorkel.cdk.github.runners.StaticRunnerImage Maven / Gradle / Ivy
Show all versions of cdk.github.runners Show documentation
package com.cloudsnorkel.cdk.github.runners;
/**
* (experimental) Helper class with methods to use static images that are built outside the context of this project.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.73.0 (build 6faeda3)", date = "2023-01-17T21:04:03.065Z")
@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.StaticRunnerImage")
public class StaticRunnerImage extends software.amazon.jsii.JsiiObject {
protected StaticRunnerImage(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected StaticRunnerImage(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public StaticRunnerImage() {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
}
/**
* (experimental) Create a builder from an existing Docker Hub image.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* We create a CodeBuild image builder behind the scenes to copy the image over to ECR. This helps avoid Docker Hub rate limits and prevent failures.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param image Docker Hub image with optional tag. This parameter is required.
* @param architecture image architecture.
* @param os image OS.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromDockerHub(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String image, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Architecture architecture, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Os os) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromDockerHub", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(image, "image is required"), architecture, os });
}
/**
* (experimental) Create a builder from an existing Docker Hub image.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* We create a CodeBuild image builder behind the scenes to copy the image over to ECR. This helps avoid Docker Hub rate limits and prevent failures.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param image Docker Hub image with optional tag. This parameter is required.
* @param architecture image architecture.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromDockerHub(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String image, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Architecture architecture) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromDockerHub", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(image, "image is required"), architecture });
}
/**
* (experimental) Create a builder from an existing Docker Hub image.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* We create a CodeBuild image builder behind the scenes to copy the image over to ECR. This helps avoid Docker Hub rate limits and prevent failures.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param image Docker Hub image with optional tag. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromDockerHub(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull java.lang.String image) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromDockerHub", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(image, "image is required") });
}
/**
* (experimental) Create a builder (that doesn't actually build anything) from an existing image in an existing repository.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* @param repository ECR repository. This parameter is required.
* @param tag image tag.
* @param architecture image architecture.
* @param os image OS.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromEcrRepository(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository, final @org.jetbrains.annotations.Nullable java.lang.String tag, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Architecture architecture, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Os os) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromEcrRepository", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required"), tag, architecture, os });
}
/**
* (experimental) Create a builder (that doesn't actually build anything) from an existing image in an existing repository.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* @param repository ECR repository. This parameter is required.
* @param tag image tag.
* @param architecture image architecture.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromEcrRepository(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository, final @org.jetbrains.annotations.Nullable java.lang.String tag, final @org.jetbrains.annotations.Nullable com.cloudsnorkel.cdk.github.runners.Architecture architecture) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromEcrRepository", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required"), tag, architecture });
}
/**
* (experimental) Create a builder (that doesn't actually build anything) from an existing image in an existing repository.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* @param repository ECR repository. This parameter is required.
* @param tag image tag.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromEcrRepository(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository, final @org.jetbrains.annotations.Nullable java.lang.String tag) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromEcrRepository", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required"), tag });
}
/**
* (experimental) Create a builder (that doesn't actually build anything) from an existing image in an existing repository.
*
* The image must already have GitHub Actions runner installed. You are responsible to update it and remove it when done.
*
* @param repository ECR repository. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.IImageBuilder fromEcrRepository(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ecr.IRepository repository) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.cloudsnorkel.cdk.github.runners.StaticRunnerImage.class, "fromEcrRepository", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.IImageBuilder.class), new Object[] { java.util.Objects.requireNonNull(repository, "repository is required") });
}
}