Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Docker Provider
  3. API Docs
  4. BuildxBuilder
Docker v4.8.0 published on Wednesday, Jun 18, 2025 by Pulumi
pulumi/pulumi-docker

docker.BuildxBuilder

Explore with Pulumi AI

docker logo
Docker v4.8.0 published on Wednesday, Jun 18, 2025 by Pulumi
pulumi/pulumi-docker

    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

    Create BuildxBuilder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BuildxBuilder(name: string, args?: BuildxBuilderArgs, opts?: CustomResourceOptions);
    @overload
def BuildxBuilder(resource_name: str,
                  args: Optional[BuildxBuilderArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def BuildxBuilder(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  append: Optional[bool] = None,
                  bootstrap: Optional[bool] = None,
                  buildkit_config: Optional[str] = None,
                  buildkit_flags: Optional[str] = None,
                  docker_container: Optional[BuildxBuilderDockerContainerArgs] = None,
                  driver: Optional[str] = None,
                  driver_options: Optional[Mapping[str, str]] = None,
                  endpoint: Optional[str] = None,
                  kubernetes: Optional[BuildxBuilderKubernetesArgs] = None,
                  name: Optional[str] = None,
                  node: Optional[str] = None,
                  platforms: Optional[Sequence[str]] = None,
                  remote: Optional[BuildxBuilderRemoteArgs] = None,
                  use: Optional[bool] = None)
    func NewBuildxBuilder(ctx *Context, name string, args *BuildxBuilderArgs, opts ...ResourceOption) (*BuildxBuilder, error)
    public BuildxBuilder(string name, BuildxBuilderArgs? args = null, CustomResourceOptions? opts = null)
    public BuildxBuilder(String name, BuildxBuilderArgs args)
public BuildxBuilder(String name, BuildxBuilderArgs args, CustomResourceOptions options)

    type: docker:BuildxBuilder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BuildxBuilderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BuildxBuilderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BuildxBuilderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BuildxBuilderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BuildxBuilderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var buildxBuilderResource = new Docker.BuildxBuilder("buildxBuilderResource", new()
{
    Append = false,
    Bootstrap = false,
    BuildkitConfig = "string",
    BuildkitFlags = "string",
    DockerContainer = new Docker.Inputs.BuildxBuilderDockerContainerArgs
    {
        CgroupParent = "string",
        CpuPeriod = "string",
        CpuQuota = "string",
        CpuShares = "string",
        CpusetCpus = "string",
        CpusetMems = "string",
        DefaultLoad = false,
        Env = 
        {
            { "string", "string" },
        },
        Image = "string",
        Memory = "string",
        MemorySwap = "string",
        Network = "string",
        RestartPolicy = "string",
    },
    Driver = "string",
    DriverOptions = 
    {
        { "string", "string" },
    },
    Endpoint = "string",
    Kubernetes = new Docker.Inputs.BuildxBuilderKubernetesArgs
    {
        Annotations = "string",
        DefaultLoad = false,
        Image = "string",
        Labels = "string",
        Limits = new Docker.Inputs.BuildxBuilderKubernetesLimitsArgs
        {
            Cpu = "string",
            EphemeralStorage = "string",
            Memory = "string",
        },
        Loadbalance = "string",
        Namespace = "string",
        Nodeselector = "string",
        Qemu = new Docker.Inputs.BuildxBuilderKubernetesQemuArgs
        {
            Image = "string",
            Install = false,
        },
        Replicas = 0,
        Requests = new Docker.Inputs.BuildxBuilderKubernetesRequestsArgs
        {
            Cpu = "string",
            EphemeralStorage = "string",
            Memory = "string",
        },
        Rootless = false,
        Schedulername = "string",
        Serviceaccount = "string",
        Timeout = "string",
        Tolerations = "string",
    },
    Name = "string",
    Node = "string",
    Platforms = new[]
    {
        "string",
    },
    Remote = new Docker.Inputs.BuildxBuilderRemoteArgs
    {
        Cacert = "string",
        Cert = "string",
        DefaultLoad = false,
        Key = "string",
        Servername = "string",
    },
    Use = false,
});

    example, err := docker.NewBuildxBuilder(ctx, "buildxBuilderResource", &docker.BuildxBuilderArgs{
	Append:         pulumi.Bool(false),
	Bootstrap:      pulumi.Bool(false),
	BuildkitConfig: pulumi.String("string"),
	BuildkitFlags:  pulumi.String("string"),
	DockerContainer: &docker.BuildxBuilderDockerContainerArgs{
		CgroupParent: pulumi.String("string"),
		CpuPeriod:    pulumi.String("string"),
		CpuQuota:     pulumi.String("string"),
		CpuShares:    pulumi.String("string"),
		CpusetCpus:   pulumi.String("string"),
		CpusetMems:   pulumi.String("string"),
		DefaultLoad:  pulumi.Bool(false),
		Env: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Image:         pulumi.String("string"),
		Memory:        pulumi.String("string"),
		MemorySwap:    pulumi.String("string"),
		Network:       pulumi.String("string"),
		RestartPolicy: pulumi.String("string"),
	},
	Driver: pulumi.String("string"),
	DriverOptions: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Endpoint: pulumi.String("string"),
	Kubernetes: &docker.BuildxBuilderKubernetesArgs{
		Annotations: pulumi.String("string"),
		DefaultLoad: pulumi.Bool(false),
		Image:       pulumi.String("string"),
		Labels:      pulumi.String("string"),
		Limits: &docker.BuildxBuilderKubernetesLimitsArgs{
			Cpu:              pulumi.String("string"),
			EphemeralStorage: pulumi.String("string"),
			Memory:           pulumi.String("string"),
		},
		Loadbalance:  pulumi.String("string"),
		Namespace:    pulumi.String("string"),
		Nodeselector: pulumi.String("string"),
		Qemu: &docker.BuildxBuilderKubernetesQemuArgs{
			Image:   pulumi.String("string"),
			Install: pulumi.Bool(false),
		},
		Replicas: pulumi.Int(0),
		Requests: &docker.BuildxBuilderKubernetesRequestsArgs{
			Cpu:              pulumi.String("string"),
			EphemeralStorage: pulumi.String("string"),
			Memory:           pulumi.String("string"),
		},
		Rootless:       pulumi.Bool(false),
		Schedulername:  pulumi.String("string"),
		Serviceaccount: pulumi.String("string"),
		Timeout:        pulumi.String("string"),
		Tolerations:    pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Node: pulumi.String("string"),
	Platforms: pulumi.StringArray{
		pulumi.String("string"),
	},
	Remote: &docker.BuildxBuilderRemoteArgs{
		Cacert:      pulumi.String("string"),
		Cert:        pulumi.String("string"),
		DefaultLoad: pulumi.Bool(false),
		Key:         pulumi.String("string"),
		Servername:  pulumi.String("string"),
	},
	Use: pulumi.Bool(false),
})

    var buildxBuilderResource = new BuildxBuilder("buildxBuilderResource", BuildxBuilderArgs.builder()
    .append(false)
    .bootstrap(false)
    .buildkitConfig("string")
    .buildkitFlags("string")
    .dockerContainer(BuildxBuilderDockerContainerArgs.builder()
        .cgroupParent("string")
        .cpuPeriod("string")
        .cpuQuota("string")
        .cpuShares("string")
        .cpusetCpus("string")
        .cpusetMems("string")
        .defaultLoad(false)
        .env(Map.of("string", "string"))
        .image("string")
        .memory("string")
        .memorySwap("string")
        .network("string")
        .restartPolicy("string")
        .build())
    .driver("string")
    .driverOptions(Map.of("string", "string"))
    .endpoint("string")
    .kubernetes(BuildxBuilderKubernetesArgs.builder()
        .annotations("string")
        .defaultLoad(false)
        .image("string")
        .labels("string")
        .limits(BuildxBuilderKubernetesLimitsArgs.builder()
            .cpu("string")
            .ephemeralStorage("string")
            .memory("string")
            .build())
        .loadbalance("string")
        .namespace("string")
        .nodeselector("string")
        .qemu(BuildxBuilderKubernetesQemuArgs.builder()
            .image("string")
            .install(false)
            .build())
        .replicas(0)
        .requests(BuildxBuilderKubernetesRequestsArgs.builder()
            .cpu("string")
            .ephemeralStorage("string")
            .memory("string")
            .build())
        .rootless(false)
        .schedulername("string")
        .serviceaccount("string")
        .timeout("string")
        .tolerations("string")
        .build())
    .name("string")
    .node("string")
    .platforms("string")
    .remote(BuildxBuilderRemoteArgs.builder()
        .cacert("string")
        .cert("string")
        .defaultLoad(false)
        .key("string")
        .servername("string")
        .build())
    .use(false)
    .build());

    buildx_builder_resource = docker.BuildxBuilder("buildxBuilderResource",
    append=False,
    bootstrap=False,
    buildkit_config="string",
    buildkit_flags="string",
    docker_container={
        "cgroup_parent": "string",
        "cpu_period": "string",
        "cpu_quota": "string",
        "cpu_shares": "string",
        "cpuset_cpus": "string",
        "cpuset_mems": "string",
        "default_load": False,
        "env": {
            "string": "string",
        },
        "image": "string",
        "memory": "string",
        "memory_swap": "string",
        "network": "string",
        "restart_policy": "string",
    },
    driver="string",
    driver_options={
        "string": "string",
    },
    endpoint="string",
    kubernetes={
        "annotations": "string",
        "default_load": False,
        "image": "string",
        "labels": "string",
        "limits": {
            "cpu": "string",
            "ephemeral_storage": "string",
            "memory": "string",
        },
        "loadbalance": "string",
        "namespace": "string",
        "nodeselector": "string",
        "qemu": {
            "image": "string",
            "install": False,
        },
        "replicas": 0,
        "requests": {
            "cpu": "string",
            "ephemeral_storage": "string",
            "memory": "string",
        },
        "rootless": False,
        "schedulername": "string",
        "serviceaccount": "string",
        "timeout": "string",
        "tolerations": "string",
    },
    name="string",
    node="string",
    platforms=["string"],
    remote={
        "cacert": "string",
        "cert": "string",
        "default_load": False,
        "key": "string",
        "servername": "string",
    },
    use=False)

    const buildxBuilderResource = new docker.BuildxBuilder("buildxBuilderResource", {
    append: false,
    bootstrap: false,
    buildkitConfig: "string",
    buildkitFlags: "string",
    dockerContainer: {
        cgroupParent: "string",
        cpuPeriod: "string",
        cpuQuota: "string",
        cpuShares: "string",
        cpusetCpus: "string",
        cpusetMems: "string",
        defaultLoad: false,
        env: {
            string: "string",
        },
        image: "string",
        memory: "string",
        memorySwap: "string",
        network: "string",
        restartPolicy: "string",
    },
    driver: "string",
    driverOptions: {
        string: "string",
    },
    endpoint: "string",
    kubernetes: {
        annotations: "string",
        defaultLoad: false,
        image: "string",
        labels: "string",
        limits: {
            cpu: "string",
            ephemeralStorage: "string",
            memory: "string",
        },
        loadbalance: "string",
        namespace: "string",
        nodeselector: "string",
        qemu: {
            image: "string",
            install: false,
        },
        replicas: 0,
        requests: {
            cpu: "string",
            ephemeralStorage: "string",
            memory: "string",
        },
        rootless: false,
        schedulername: "string",
        serviceaccount: "string",
        timeout: "string",
        tolerations: "string",
    },
    name: "string",
    node: "string",
    platforms: ["string"],
    remote: {
        cacert: "string",
        cert: "string",
        defaultLoad: false,
        key: "string",
        servername: "string",
    },
    use: false,
});

    type: docker:BuildxBuilder
properties:
    append: false
    bootstrap: false
    buildkitConfig: string
    buildkitFlags: string
    dockerContainer:
        cgroupParent: string
        cpuPeriod: string
        cpuQuota: string
        cpuShares: string
        cpusetCpus: string
        cpusetMems: string
        defaultLoad: false
        env:
            string: string
        image: string
        memory: string
        memorySwap: string
        network: string
        restartPolicy: string
    driver: string
    driverOptions:
        string: string
    endpoint: string
    kubernetes:
        annotations: string
        defaultLoad: false
        image: string
        labels: string
        limits:
            cpu: string
            ephemeralStorage: string
            memory: string
        loadbalance: string
        namespace: string
        nodeselector: string
        qemu:
            image: string
            install: false
        replicas: 0
        requests:
            cpu: string
            ephemeralStorage: string
            memory: string
        rootless: false
        schedulername: string
        serviceaccount: string
        timeout: string
        tolerations: string
    name: string
    node: string
    platforms:
        - string
    remote:
        cacert: string
        cert: string
        defaultLoad: false
        key: string
        servername: string
    use: false

    BuildxBuilder Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BuildxBuilder resource accepts the following input properties:

    Append bool
    Append a node to builder instead of changing it
    Bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    BuildkitConfig string
    BuildKit daemon config file
    BuildkitFlags string
    BuildKit flags to set for the builder.
    DockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    Driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    DriverOptions Dictionary<string, string>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    Endpoint 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.
    Kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    Name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    Node string
    Create/modify node with given name
    Platforms List<string>
    Fixed platforms for current node
    Remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    Use bool
    Set the current builder instance as the default for the current context.
    Append bool
    Append a node to builder instead of changing it
    Bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    BuildkitConfig string
    BuildKit daemon config file
    BuildkitFlags string
    BuildKit flags to set for the builder.
    DockerContainer BuildxBuilderDockerContainerArgs
    Configuration block for the Docker-Container driver.
    Driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    DriverOptions map[string]string
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    Endpoint 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.
    Kubernetes BuildxBuilderKubernetesArgs
    Configuration block for the Kubernetes driver.
    Name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    Node string
    Create/modify node with given name
    Platforms []string
    Fixed platforms for current node
    Remote BuildxBuilderRemoteArgs
    Configuration block for the Remote driver.
    Use bool
    Set the current builder instance as the default for the current context.
    append Boolean
    Append a node to builder instead of changing it
    bootstrap Boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig String
    BuildKit daemon config file
    buildkitFlags String
    BuildKit flags to set for the builder.
    dockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    driver String
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions Map<String,String>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    name String
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node String
    Create/modify node with given name
    platforms List<String>
    Fixed platforms for current node
    remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    use Boolean
    Set the current builder instance as the default for the current context.
    append boolean
    Append a node to builder instead of changing it
    bootstrap boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig string
    BuildKit daemon config file
    buildkitFlags string
    BuildKit flags to set for the builder.
    dockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions {[key: string]: string}
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node string
    Create/modify node with given name
    platforms string[]
    Fixed platforms for current node
    remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    use boolean
    Set the current builder instance as the default for the current context.
    append bool
    Append a node to builder instead of changing it
    bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    buildkit_config str
    BuildKit daemon config file
    buildkit_flags str
    BuildKit flags to set for the builder.
    docker_container BuildxBuilderDockerContainerArgs
    Configuration block for the Docker-Container driver.
    driver str
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driver_options Mapping[str, str]
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint str
    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.
    kubernetes BuildxBuilderKubernetesArgs
    Configuration block for the Kubernetes driver.
    name str
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node str
    Create/modify node with given name
    platforms Sequence[str]
    Fixed platforms for current node
    remote BuildxBuilderRemoteArgs
    Configuration block for the Remote driver.
    use bool
    Set the current builder instance as the default for the current context.
    append Boolean
    Append a node to builder instead of changing it
    bootstrap Boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig String
    BuildKit daemon config file
    buildkitFlags String
    BuildKit flags to set for the builder.
    dockerContainer Property Map
    Configuration block for the Docker-Container driver.
    driver String
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions Map<String>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes Property Map
    Configuration block for the Kubernetes driver.
    name String
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node String
    Create/modify node with given name
    platforms List<String>
    Fixed platforms for current node
    remote Property Map
    Configuration block for the Remote driver.
    use Boolean
    Set the current builder instance as the default for the current context.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BuildxBuilder resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BuildxBuilder Resource

    Get an existing BuildxBuilder resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BuildxBuilderState, opts?: CustomResourceOptions): BuildxBuilder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append: Optional[bool] = None,
        bootstrap: Optional[bool] = None,
        buildkit_config: Optional[str] = None,
        buildkit_flags: Optional[str] = None,
        docker_container: Optional[BuildxBuilderDockerContainerArgs] = None,
        driver: Optional[str] = None,
        driver_options: Optional[Mapping[str, str]] = None,
        endpoint: Optional[str] = None,
        kubernetes: Optional[BuildxBuilderKubernetesArgs] = None,
        name: Optional[str] = None,
        node: Optional[str] = None,
        platforms: Optional[Sequence[str]] = None,
        remote: Optional[BuildxBuilderRemoteArgs] = None,
        use: Optional[bool] = None) -> BuildxBuilder
    func GetBuildxBuilder(ctx *Context, name string, id IDInput, state *BuildxBuilderState, opts ...ResourceOption) (*BuildxBuilder, error)
    public static BuildxBuilder Get(string name, Input<string> id, BuildxBuilderState? state, CustomResourceOptions? opts = null)
    public static BuildxBuilder get(String name, Output<String> id, BuildxBuilderState state, CustomResourceOptions options)
    resources:  _:    type: docker:BuildxBuilder    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Append bool
    Append a node to builder instead of changing it
    Bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    BuildkitConfig string
    BuildKit daemon config file
    BuildkitFlags string
    BuildKit flags to set for the builder.
    DockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    Driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    DriverOptions Dictionary<string, string>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    Endpoint 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.
    Kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    Name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    Node string
    Create/modify node with given name
    Platforms List<string>
    Fixed platforms for current node
    Remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    Use bool
    Set the current builder instance as the default for the current context.
    Append bool
    Append a node to builder instead of changing it
    Bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    BuildkitConfig string
    BuildKit daemon config file
    BuildkitFlags string
    BuildKit flags to set for the builder.
    DockerContainer BuildxBuilderDockerContainerArgs
    Configuration block for the Docker-Container driver.
    Driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    DriverOptions map[string]string
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    Endpoint 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.
    Kubernetes BuildxBuilderKubernetesArgs
    Configuration block for the Kubernetes driver.
    Name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    Node string
    Create/modify node with given name
    Platforms []string
    Fixed platforms for current node
    Remote BuildxBuilderRemoteArgs
    Configuration block for the Remote driver.
    Use bool
    Set the current builder instance as the default for the current context.
    append Boolean
    Append a node to builder instead of changing it
    bootstrap Boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig String
    BuildKit daemon config file
    buildkitFlags String
    BuildKit flags to set for the builder.
    dockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    driver String
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions Map<String,String>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    name String
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node String
    Create/modify node with given name
    platforms List<String>
    Fixed platforms for current node
    remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    use Boolean
    Set the current builder instance as the default for the current context.
    append boolean
    Append a node to builder instead of changing it
    bootstrap boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig string
    BuildKit daemon config file
    buildkitFlags string
    BuildKit flags to set for the builder.
    dockerContainer BuildxBuilderDockerContainer
    Configuration block for the Docker-Container driver.
    driver string
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions {[key: string]: string}
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes BuildxBuilderKubernetes
    Configuration block for the Kubernetes driver.
    name string
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node string
    Create/modify node with given name
    platforms string[]
    Fixed platforms for current node
    remote BuildxBuilderRemote
    Configuration block for the Remote driver.
    use boolean
    Set the current builder instance as the default for the current context.
    append bool
    Append a node to builder instead of changing it
    bootstrap bool
    Automatically boot the builder after creation. Defaults to false
    buildkit_config str
    BuildKit daemon config file
    buildkit_flags str
    BuildKit flags to set for the builder.
    docker_container BuildxBuilderDockerContainerArgs
    Configuration block for the Docker-Container driver.
    driver str
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driver_options Mapping[str, str]
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint str
    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.
    kubernetes BuildxBuilderKubernetesArgs
    Configuration block for the Kubernetes driver.
    name str
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node str
    Create/modify node with given name
    platforms Sequence[str]
    Fixed platforms for current node
    remote BuildxBuilderRemoteArgs
    Configuration block for the Remote driver.
    use bool
    Set the current builder instance as the default for the current context.
    append Boolean
    Append a node to builder instead of changing it
    bootstrap Boolean
    Automatically boot the builder after creation. Defaults to false
    buildkitConfig String
    BuildKit daemon config file
    buildkitFlags String
    BuildKit flags to set for the builder.
    dockerContainer Property Map
    Configuration block for the Docker-Container driver.
    driver String
    The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
    driverOptions Map<String>
    Additional options for the Buildx driver in the form of key=value,.... These options are driver-specific.
    endpoint 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.
    kubernetes Property Map
    Configuration block for the Kubernetes driver.
    name String
    The name of the Buildx builder. IF not specified, a random name will be generated.
    node String
    Create/modify node with given name
    platforms List<String>
    Fixed platforms for current node
    remote Property Map
    Configuration block for the Remote driver.
    use Boolean
    Set the current builder instance as the default for the current context.

    Supporting Types

    BuildxBuilderDockerContainer, BuildxBuilderDockerContainerArgs

    CgroupParent string
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    CpuPeriod string
    Sets the CPU CFS scheduler period for the container.
    CpuQuota string
    Imposes a CPU CFS quota on the container.
    CpuShares string
    Configures CPU shares (relative weight) of the container.
    CpusetCpus string
    Limits the set of CPU cores the container can use.
    CpusetMems string
    Limits the set of CPU memory nodes the container can use.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Env Dictionary<string, string>
    Sets environment variables in the container.
    Image string
    Sets the BuildKit image to use for the container.
    Memory string
    Sets the amount of memory the container can use.
    MemorySwap string
    Sets the memory swap limit for the container.
    Network string
    Sets the network mode for the container.
    RestartPolicy string
    Sets the container's restart policy.
    CgroupParent string
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    CpuPeriod string
    Sets the CPU CFS scheduler period for the container.
    CpuQuota string
    Imposes a CPU CFS quota on the container.
    CpuShares string
    Configures CPU shares (relative weight) of the container.
    CpusetCpus string
    Limits the set of CPU cores the container can use.
    CpusetMems string
    Limits the set of CPU memory nodes the container can use.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Env map[string]string
    Sets environment variables in the container.
    Image string
    Sets the BuildKit image to use for the container.
    Memory string
    Sets the amount of memory the container can use.
    MemorySwap string
    Sets the memory swap limit for the container.
    Network string
    Sets the network mode for the container.
    RestartPolicy string
    Sets the container's restart policy.
    cgroupParent String
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    cpuPeriod String
    Sets the CPU CFS scheduler period for the container.
    cpuQuota String
    Imposes a CPU CFS quota on the container.
    cpuShares String
    Configures CPU shares (relative weight) of the container.
    cpusetCpus String
    Limits the set of CPU cores the container can use.
    cpusetMems String
    Limits the set of CPU memory nodes the container can use.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    env Map<String,String>
    Sets environment variables in the container.
    image String
    Sets the BuildKit image to use for the container.
    memory String
    Sets the amount of memory the container can use.
    memorySwap String
    Sets the memory swap limit for the container.
    network String
    Sets the network mode for the container.
    restartPolicy String
    Sets the container's restart policy.
    cgroupParent string
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    cpuPeriod string
    Sets the CPU CFS scheduler period for the container.
    cpuQuota string
    Imposes a CPU CFS quota on the container.
    cpuShares string
    Configures CPU shares (relative weight) of the container.
    cpusetCpus string
    Limits the set of CPU cores the container can use.
    cpusetMems string
    Limits the set of CPU memory nodes the container can use.
    defaultLoad boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    env {[key: string]: string}
    Sets environment variables in the container.
    image string
    Sets the BuildKit image to use for the container.
    memory string
    Sets the amount of memory the container can use.
    memorySwap string
    Sets the memory swap limit for the container.
    network string
    Sets the network mode for the container.
    restartPolicy string
    Sets the container's restart policy.
    cgroup_parent str
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    cpu_period str
    Sets the CPU CFS scheduler period for the container.
    cpu_quota str
    Imposes a CPU CFS quota on the container.
    cpu_shares str
    Configures CPU shares (relative weight) of the container.
    cpuset_cpus str
    Limits the set of CPU cores the container can use.
    cpuset_mems str
    Limits the set of CPU memory nodes the container can use.
    default_load bool
    Automatically load images to the Docker Engine image store. Defaults to false
    env Mapping[str, str]
    Sets environment variables in the container.
    image str
    Sets the BuildKit image to use for the container.
    memory str
    Sets the amount of memory the container can use.
    memory_swap str
    Sets the memory swap limit for the container.
    network str
    Sets the network mode for the container.
    restart_policy str
    Sets the container's restart policy.
    cgroupParent String
    Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
    cpuPeriod String
    Sets the CPU CFS scheduler period for the container.
    cpuQuota String
    Imposes a CPU CFS quota on the container.
    cpuShares String
    Configures CPU shares (relative weight) of the container.
    cpusetCpus String
    Limits the set of CPU cores the container can use.
    cpusetMems String
    Limits the set of CPU memory nodes the container can use.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    env Map<String>
    Sets environment variables in the container.
    image String
    Sets the BuildKit image to use for the container.
    memory String
    Sets the amount of memory the container can use.
    memorySwap String
    Sets the memory swap limit for the container.
    network String
    Sets the network mode for the container.
    restartPolicy String
    Sets the container's restart policy.

    BuildxBuilderKubernetes, BuildxBuilderKubernetesArgs

    Annotations string
    Sets additional annotations on the deployments and pods.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Image string
    Sets the image to use for running BuildKit.
    Labels string
    Sets additional labels on the deployments and pods.
    Limits BuildxBuilderKubernetesLimits
    Resource limits for CPU, memory, and ephemeral storage.
    Loadbalance string
    Load-balancing strategy (sticky or random).
    Namespace string
    Sets the Kubernetes namespace.
    Nodeselector string
    Sets the pod's nodeSelector label(s).
    Qemu BuildxBuilderKubernetesQemu
    QEMU emulation configuration.
    Replicas int
    Sets the number of Pod replicas to create.
    Requests BuildxBuilderKubernetesRequests
    Resource requests for CPU, memory, and ephemeral storage.
    Rootless bool
    Run the container as a non-root user.
    Schedulername string
    Sets the scheduler responsible for scheduling the pod.
    Serviceaccount string
    Sets the pod's serviceAccountName.
    Timeout string
    Set the timeout limit for pod provisioning.
    Tolerations string
    Configures the pod's taint toleration.
    Annotations string
    Sets additional annotations on the deployments and pods.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Image string
    Sets the image to use for running BuildKit.
    Labels string
    Sets additional labels on the deployments and pods.
    Limits BuildxBuilderKubernetesLimits
    Resource limits for CPU, memory, and ephemeral storage.
    Loadbalance string
    Load-balancing strategy (sticky or random).
    Namespace string
    Sets the Kubernetes namespace.
    Nodeselector string
    Sets the pod's nodeSelector label(s).
    Qemu BuildxBuilderKubernetesQemu
    QEMU emulation configuration.
    Replicas int
    Sets the number of Pod replicas to create.
    Requests BuildxBuilderKubernetesRequests
    Resource requests for CPU, memory, and ephemeral storage.
    Rootless bool
    Run the container as a non-root user.
    Schedulername string
    Sets the scheduler responsible for scheduling the pod.
    Serviceaccount string
    Sets the pod's serviceAccountName.
    Timeout string
    Set the timeout limit for pod provisioning.
    Tolerations string
    Configures the pod's taint toleration.
    annotations String
    Sets additional annotations on the deployments and pods.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    image String
    Sets the image to use for running BuildKit.
    labels String
    Sets additional labels on the deployments and pods.
    limits BuildxBuilderKubernetesLimits
    Resource limits for CPU, memory, and ephemeral storage.
    loadbalance String
    Load-balancing strategy (sticky or random).
    namespace String
    Sets the Kubernetes namespace.
    nodeselector String
    Sets the pod's nodeSelector label(s).
    qemu BuildxBuilderKubernetesQemu
    QEMU emulation configuration.
    replicas Integer
    Sets the number of Pod replicas to create.
    requests BuildxBuilderKubernetesRequests
    Resource requests for CPU, memory, and ephemeral storage.
    rootless Boolean
    Run the container as a non-root user.
    schedulername String
    Sets the scheduler responsible for scheduling the pod.
    serviceaccount String
    Sets the pod's serviceAccountName.
    timeout String
    Set the timeout limit for pod provisioning.
    tolerations String
    Configures the pod's taint toleration.
    annotations string
    Sets additional annotations on the deployments and pods.
    defaultLoad boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    image string
    Sets the image to use for running BuildKit.
    labels string
    Sets additional labels on the deployments and pods.
    limits BuildxBuilderKubernetesLimits
    Resource limits for CPU, memory, and ephemeral storage.
    loadbalance string
    Load-balancing strategy (sticky or random).
    namespace string
    Sets the Kubernetes namespace.
    nodeselector string
    Sets the pod's nodeSelector label(s).
    qemu BuildxBuilderKubernetesQemu
    QEMU emulation configuration.
    replicas number
    Sets the number of Pod replicas to create.
    requests BuildxBuilderKubernetesRequests
    Resource requests for CPU, memory, and ephemeral storage.
    rootless boolean
    Run the container as a non-root user.
    schedulername string
    Sets the scheduler responsible for scheduling the pod.
    serviceaccount string
    Sets the pod's serviceAccountName.
    timeout string
    Set the timeout limit for pod provisioning.
    tolerations string
    Configures the pod's taint toleration.
    annotations str
    Sets additional annotations on the deployments and pods.
    default_load bool
    Automatically load images to the Docker Engine image store. Defaults to false
    image str
    Sets the image to use for running BuildKit.
    labels str
    Sets additional labels on the deployments and pods.
    limits BuildxBuilderKubernetesLimits
    Resource limits for CPU, memory, and ephemeral storage.
    loadbalance str
    Load-balancing strategy (sticky or random).
    namespace str
    Sets the Kubernetes namespace.
    nodeselector str
    Sets the pod's nodeSelector label(s).
    qemu BuildxBuilderKubernetesQemu
    QEMU emulation configuration.
    replicas int
    Sets the number of Pod replicas to create.
    requests BuildxBuilderKubernetesRequests
    Resource requests for CPU, memory, and ephemeral storage.
    rootless bool
    Run the container as a non-root user.
    schedulername str
    Sets the scheduler responsible for scheduling the pod.
    serviceaccount str
    Sets the pod's serviceAccountName.
    timeout str
    Set the timeout limit for pod provisioning.
    tolerations str
    Configures the pod's taint toleration.
    annotations String
    Sets additional annotations on the deployments and pods.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    image String
    Sets the image to use for running BuildKit.
    labels String
    Sets additional labels on the deployments and pods.
    limits Property Map
    Resource limits for CPU, memory, and ephemeral storage.
    loadbalance String
    Load-balancing strategy (sticky or random).
    namespace String
    Sets the Kubernetes namespace.
    nodeselector String
    Sets the pod's nodeSelector label(s).
    qemu Property Map
    QEMU emulation configuration.
    replicas Number
    Sets the number of Pod replicas to create.
    requests Property Map
    Resource requests for CPU, memory, and ephemeral storage.
    rootless Boolean
    Run the container as a non-root user.
    schedulername String
    Sets the scheduler responsible for scheduling the pod.
    serviceaccount String
    Sets the pod's serviceAccountName.
    timeout String
    Set the timeout limit for pod provisioning.
    tolerations String
    Configures the pod's taint toleration.

    BuildxBuilderKubernetesLimits, BuildxBuilderKubernetesLimitsArgs

    Cpu string
    CPU limit for the Kubernetes pod.
    EphemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    Memory string
    Memory limit for the Kubernetes pod.
    Cpu string
    CPU limit for the Kubernetes pod.
    EphemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    Memory string
    Memory limit for the Kubernetes pod.
    cpu String
    CPU limit for the Kubernetes pod.
    ephemeralStorage String
    Ephemeral storage limit for the Kubernetes pod.
    memory String
    Memory limit for the Kubernetes pod.
    cpu string
    CPU limit for the Kubernetes pod.
    ephemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    memory string
    Memory limit for the Kubernetes pod.
    cpu str
    CPU limit for the Kubernetes pod.
    ephemeral_storage str
    Ephemeral storage limit for the Kubernetes pod.
    memory str
    Memory limit for the Kubernetes pod.
    cpu String
    CPU limit for the Kubernetes pod.
    ephemeralStorage String
    Ephemeral storage limit for the Kubernetes pod.
    memory String
    Memory limit for the Kubernetes pod.

    BuildxBuilderKubernetesQemu, BuildxBuilderKubernetesQemuArgs

    Image string
    Sets the QEMU emulation image.
    Install bool
    Install QEMU emulation for multi-platform support.
    Image string
    Sets the QEMU emulation image.
    Install bool
    Install QEMU emulation for multi-platform support.
    image String
    Sets the QEMU emulation image.
    install Boolean
    Install QEMU emulation for multi-platform support.
    image string
    Sets the QEMU emulation image.
    install boolean
    Install QEMU emulation for multi-platform support.
    image str
    Sets the QEMU emulation image.
    install bool
    Install QEMU emulation for multi-platform support.
    image String
    Sets the QEMU emulation image.
    install Boolean
    Install QEMU emulation for multi-platform support.

    BuildxBuilderKubernetesRequests, BuildxBuilderKubernetesRequestsArgs

    Cpu string
    CPU limit for the Kubernetes pod.
    EphemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    Memory string
    Memory limit for the Kubernetes pod.
    Cpu string
    CPU limit for the Kubernetes pod.
    EphemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    Memory string
    Memory limit for the Kubernetes pod.
    cpu String
    CPU limit for the Kubernetes pod.
    ephemeralStorage String
    Ephemeral storage limit for the Kubernetes pod.
    memory String
    Memory limit for the Kubernetes pod.
    cpu string
    CPU limit for the Kubernetes pod.
    ephemeralStorage string
    Ephemeral storage limit for the Kubernetes pod.
    memory string
    Memory limit for the Kubernetes pod.
    cpu str
    CPU limit for the Kubernetes pod.
    ephemeral_storage str
    Ephemeral storage limit for the Kubernetes pod.
    memory str
    Memory limit for the Kubernetes pod.
    cpu String
    CPU limit for the Kubernetes pod.
    ephemeralStorage String
    Ephemeral storage limit for the Kubernetes pod.
    memory String
    Memory limit for the Kubernetes pod.

    BuildxBuilderRemote, BuildxBuilderRemoteArgs

    Cacert string
    Absolute path to the TLS certificate authority used for validation.
    Cert string
    Absolute path to the TLS client certificate to present to buildkitd.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Key string
    Sets the TLS client key.
    Servername string
    TLS server name used in requests.
    Cacert string
    Absolute path to the TLS certificate authority used for validation.
    Cert string
    Absolute path to the TLS client certificate to present to buildkitd.
    DefaultLoad bool
    Automatically load images to the Docker Engine image store. Defaults to false
    Key string
    Sets the TLS client key.
    Servername string
    TLS server name used in requests.
    cacert String
    Absolute path to the TLS certificate authority used for validation.
    cert String
    Absolute path to the TLS client certificate to present to buildkitd.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    key String
    Sets the TLS client key.
    servername String
    TLS server name used in requests.
    cacert string
    Absolute path to the TLS certificate authority used for validation.
    cert string
    Absolute path to the TLS client certificate to present to buildkitd.
    defaultLoad boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    key string
    Sets the TLS client key.
    servername string
    TLS server name used in requests.
    cacert str
    Absolute path to the TLS certificate authority used for validation.
    cert str
    Absolute path to the TLS client certificate to present to buildkitd.
    default_load bool
    Automatically load images to the Docker Engine image store. Defaults to false
    key str
    Sets the TLS client key.
    servername str
    TLS server name used in requests.
    cacert String
    Absolute path to the TLS certificate authority used for validation.
    cert String
    Absolute path to the TLS client certificate to present to buildkitd.
    defaultLoad Boolean
    Automatically load images to the Docker Engine image store. Defaults to false
    key String
    Sets the TLS client key.
    servername String
    TLS server name used in requests.

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Docker v4.8.0 published on Wednesday, Jun 18, 2025 by Pulumi
    pulumi/pulumi-docker