BuildxBuilder class
<!-- Bug: Type and Name are switched --> Manages a Docker Buildx builder instance. This resource allows you to create a buildx builder with various configurations such as driver, nodes, and platform settings. Please see https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md for more documentation
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";
const example = new docker.BuildxBuilder("example", {
name: "example-builder",
driver: "docker-container",
use: true,
dockerContainer: {
image: "moby/buildkit:latest",
},
});
import pulumi
import pulumi_docker as docker
example = docker.BuildxBuilder("example",
name="example-builder",
driver="docker-container",
use=True,
docker_container={
"image": "moby/buildkit:latest",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;
return await Deployment.RunAsync(() =>
{
var example = new Docker.BuildxBuilder("example", new()
{
Name = "example-builder",
Driver = "docker-container",
Use = true,
DockerContainer = new Docker.Inputs.BuildxBuilderDockerContainerArgs
{
Image = "moby/buildkit:latest",
},
});
});
package main
import (
"github.com/pulumi/pulumi-docker/sdk/v5/go/docker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := docker.NewBuildxBuilder(ctx, "example", &docker.BuildxBuilderArgs{
Name: pulumi.String("example-builder"),
Driver: pulumi.String("docker-container"),
Use: pulumi.Bool(true),
DockerContainer: &docker.BuildxBuilderDockerContainerArgs{
Image: pulumi.String("moby/buildkit:latest"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
docker = {
source = "pulumi/docker"
}
}
}
resource "docker_buildxbuilder" "example" {
name = "example-builder"
driver = "docker-container"
use = true
docker_container = {
image = "moby/buildkit:latest"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.BuildxBuilder;
import com.pulumi.docker.BuildxBuilderArgs;
import com.pulumi.docker.inputs.BuildxBuilderDockerContainerArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new BuildxBuilder("example", BuildxBuilderArgs.builder()
.name("example-builder")
.driver("docker-container")
.use(true)
.dockerContainer(BuildxBuilderDockerContainerArgs.builder()
.image("moby/buildkit:latest")
.build())
.build());
}
}
resources:
example:
type: docker:BuildxBuilder
properties:
name: example-builder
driver: docker-container
use: true
dockerContainer:
image: moby/buildkit:latest
Constructors
- BuildxBuilder(String name, {BuildxBuilderArgs? args, CustomResourceOptions? options})
-
Creates a new BuildxBuilder.
nameThe Pulumi resource name.argsArguments used to configure this BuildxBuilder. The set of arguments for BuildxBuilder.optionsResource options controlling this resource's behavior. - BuildxBuilder.reference(String urn)
- Creates a typed reference to an existing BuildxBuilder resource.
Properties
-
append
↔ Output<
bool?> -
Append a node to builder instead of changing it
latefinal
-
bootstrap
↔ Output<
bool?> -
Automatically boot the builder after creation. Defaults to
falselatefinal -
buildkitConfig
↔ Output<
String?> -
BuildKit daemon config file
latefinal
-
buildkitFlags
↔ Output<
String?> -
BuildKit flags to set for the builder.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dockerContainer
↔ Output<
BuildxBuilderDockerContainer?> -
Configuration block for the Docker-Container driver.
latefinal
-
driver
↔ Output<
String?> -
The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
latefinal
-
driverOptions
↔ Output<
Map< String, String> ?> -
Additional options for the Buildx driver in the form of
key=value,.... These options are driver-specific.latefinal -
endpoint
↔ Output<
String?> -
The endpoint or context to use for the Buildx builder, where context is the name of a context from docker context ls and endpoint is the address for Docker socket (eg. DOCKER_HOST value). By default, the current Docker configuration is used for determining the context/endpoint value.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kubernetes
↔ Output<
BuildxBuilderKubernetes?> -
Configuration block for the Kubernetes driver.
latefinal
-
name
↔ Output<
String> -
The name of the Buildx builder. IF not specified, a random name will be generated.
latefinal
-
node
↔ Output<
String?> -
Create/modify node with given name
latefinal
-
platforms
↔ Output<
List< String> ?> -
Fixed platforms for current node
latefinal
-
remote
↔ Output<
BuildxBuilderRemote?> -
Configuration block for the Remote driver.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
use
↔ Output<
bool?> -
Set the current builder instance as the default for the current context.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {BuildxBuilderState? state, CustomResourceOptions? options}) → BuildxBuilder -
Gets an existing BuildxBuilder resource's state with the given
nameandid.