com.cloudsnorkel.cdk.github.runners.IConfigurableRunnerImageBuilder Maven / Gradle / Ivy
Show all versions of cdk.github.runners Show documentation
package com.cloudsnorkel.cdk.github.runners;
/**
* (experimental) Interface for constructs that build an image that can be used in {@link IRunnerProvider }.
*
* The image can be configured by adding or removing components. The image builder can be configured by adding grants or allowing connections.
*
* An image can be a Docker image or AMI.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-14T02:42:19.449Z")
@software.amazon.jsii.Jsii(module = com.cloudsnorkel.cdk.github.runners.$Module.class, fqn = "@cloudsnorkel/cdk-github-runners.IConfigurableRunnerImageBuilder")
@software.amazon.jsii.Jsii.Proxy(IConfigurableRunnerImageBuilder.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IConfigurableRunnerImageBuilder extends software.amazon.jsii.JsiiSerializable, com.cloudsnorkel.cdk.github.runners.IRunnerImageBuilder, software.amazon.awscdk.services.ec2.IConnectable, software.amazon.awscdk.services.iam.IGrantable {
/**
* (experimental) Add a component to the image builder.
*
* The component will be added to the end of the list of components.
*
* @param component component to add. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
void addComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component);
/**
* (experimental) Remove a component from the image builder.
*
* Removal is done by component name. Multiple components with the same name will all be removed.
*
* @param component component to remove. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
void removeComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements com.cloudsnorkel.cdk.github.runners.IConfigurableRunnerImageBuilder.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* The network connections associated with this resource.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ec2.Connections getConnections() {
return software.amazon.jsii.Kernel.get(this, "connections", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ec2.Connections.class));
}
/**
* The principal to grant permissions to.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iam.IPrincipal getGrantPrincipal() {
return software.amazon.jsii.Kernel.get(this, "grantPrincipal", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IPrincipal.class));
}
/**
* (experimental) Build and return an AMI with GitHub Runner installed in it.
*
* Anything that ends up with a launch template pointing to an AMI that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing AMI and nothing else.
*
* The AMI can be further updated over time manually or using a schedule as long as it is always written to the same launch template.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerAmi bindAmi() {
return software.amazon.jsii.Kernel.call(this, "bindAmi", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerAmi.class));
}
/**
* (experimental) Build and return a Docker image with GitHub Runner installed in it.
*
* Anything that ends up with an ECR repository containing a Docker image that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing image and nothing else.
*
* It's important that the specified image tag be available at the time the repository is available. Providers usually assume the image is ready and will fail if it's not.
*
* The image can be further updated over time manually or using a schedule as long as it is always written to the same tag.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImage bindDockerImage() {
return software.amazon.jsii.Kernel.call(this, "bindDockerImage", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerImage.class));
}
/**
* (experimental) Add a component to the image builder.
*
* The component will be added to the end of the list of components.
*
* @param component component to add. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final void addComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component) {
software.amazon.jsii.Kernel.call(this, "addComponent", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(component, "component is required") });
}
/**
* (experimental) Remove a component from the image builder.
*
* Removal is done by component name. Multiple components with the same name will all be removed.
*
* @param component component to remove. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final void removeComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component) {
software.amazon.jsii.Kernel.call(this, "removeComponent", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(component, "component is required") });
}
}
/**
* Internal default implementation for {@link IConfigurableRunnerImageBuilder}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IConfigurableRunnerImageBuilder, com.cloudsnorkel.cdk.github.runners.IRunnerImageBuilder.Jsii$Default, software.amazon.awscdk.services.ec2.IConnectable.Jsii$Default, software.amazon.awscdk.services.iam.IGrantable.Jsii$Default {
/**
* The network connections associated with this resource.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.ec2.Connections getConnections() {
return software.amazon.jsii.Kernel.get(this, "connections", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.ec2.Connections.class));
}
/**
* The principal to grant permissions to.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.iam.IPrincipal getGrantPrincipal() {
return software.amazon.jsii.Kernel.get(this, "grantPrincipal", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IPrincipal.class));
}
/**
* (experimental) Build and return an AMI with GitHub Runner installed in it.
*
* Anything that ends up with a launch template pointing to an AMI that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing AMI and nothing else.
*
* The AMI can be further updated over time manually or using a schedule as long as it is always written to the same launch template.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerAmi bindAmi() {
return software.amazon.jsii.Kernel.call(this, "bindAmi", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerAmi.class));
}
/**
* (experimental) Build and return a Docker image with GitHub Runner installed in it.
*
* Anything that ends up with an ECR repository containing a Docker image that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing image and nothing else.
*
* It's important that the specified image tag be available at the time the repository is available. Providers usually assume the image is ready and will fail if it's not.
*
* The image can be further updated over time manually or using a schedule as long as it is always written to the same tag.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImage bindDockerImage() {
return software.amazon.jsii.Kernel.call(this, "bindDockerImage", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerImage.class));
}
/**
* (experimental) Add a component to the image builder.
*
* The component will be added to the end of the list of components.
*
* @param component component to add. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default void addComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component) {
software.amazon.jsii.Kernel.call(this, "addComponent", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(component, "component is required") });
}
/**
* (experimental) Remove a component from the image builder.
*
* Removal is done by component name. Multiple components with the same name will all be removed.
*
* @param component component to remove. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default void removeComponent(final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImageComponent component) {
software.amazon.jsii.Kernel.call(this, "removeComponent", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(component, "component is required") });
}
}
}