NetworkArgs

data class NetworkArgs(val attachable: Output<Boolean>? = null, val checkDuplicate: Output<Boolean>? = null, val driver: Output<String>? = null, val ingress: Output<Boolean>? = null, val internal: Output<Boolean>? = null, val ipamConfigs: Output<List<NetworkIpamConfigArgs>>? = null, val ipamDriver: Output<String>? = null, val ipamOptions: Output<Map<String, String>>? = null, val ipv6: Output<Boolean>? = null, val labels: Output<List<NetworkLabelArgs>>? = null, val name: Output<String>? = null, val options: Output<Map<String, String>>? = null) : ConvertibleToJava<NetworkArgs>

docker.Network provides a docker network resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";
const privateNetwork = new docker.Network("private_network", {name: "my_network"});
import pulumi
import pulumi_docker as docker
private_network = docker.Network("private_network", name="my_network")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;
return await Deployment.RunAsync(() =>
{
var privateNetwork = new Docker.Network("private_network", new()
{
Name = "my_network",
});
});
package main
import (
"github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := docker.NewNetwork(ctx, "private_network", &docker.NetworkArgs{
Name: pulumi.String("my_network"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.Network;
import com.pulumi.docker.NetworkArgs;
import java.util.List;
import java.util.ArrayList;
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 privateNetwork = new Network("privateNetwork", NetworkArgs.builder()
.name("my_network")
.build());
}
}
resources:
privateNetwork:
type: docker:Network
name: private_network
properties:
name: my_network

Import

Example

Assuming you created a network as follows #!/bin/bash docker network create foo prints the long ID 87b57a9b91ecab2db2a6dbf38df74c67d7c7108cbe479d6576574ec2cd8c2d73 you provide the definition for the resource as follows terraform resource "docker_network" "foo" { name = "foo" } then the import command is as follows #!/bin/bash

$ pulumi import docker:index/network:Network foo 87b57a9b91ecab2db2a6dbf38df74c67d7c7108cbe479d6576574ec2cd8c2d73

Constructors

Link copied to clipboard
constructor(attachable: Output<Boolean>? = null, checkDuplicate: Output<Boolean>? = null, driver: Output<String>? = null, ingress: Output<Boolean>? = null, internal: Output<Boolean>? = null, ipamConfigs: Output<List<NetworkIpamConfigArgs>>? = null, ipamDriver: Output<String>? = null, ipamOptions: Output<Map<String, String>>? = null, ipv6: Output<Boolean>? = null, labels: Output<List<NetworkLabelArgs>>? = null, name: Output<String>? = null, options: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val attachable: Output<Boolean>? = null

Enable manual container attachment to the network.

Link copied to clipboard
val checkDuplicate: Output<Boolean>? = null

Requests daemon to check for networks with same name.

Link copied to clipboard
val driver: Output<String>? = null

The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.

Link copied to clipboard
val ingress: Output<Boolean>? = null

Create swarm routing-mesh network. Defaults to false.

Link copied to clipboard
val internal: Output<Boolean>? = null

Whether the network is internal.

Link copied to clipboard
val ipamConfigs: Output<List<NetworkIpamConfigArgs>>? = null

The IPAM configuration options

Link copied to clipboard
val ipamDriver: Output<String>? = null

Driver used by the custom IP scheme of the network. Defaults to default

Link copied to clipboard
val ipamOptions: Output<Map<String, String>>? = null

Provide explicit options to the IPAM driver. Valid options vary with ipam_driver and refer to that driver's documentation for more details.

Link copied to clipboard
val ipv6: Output<Boolean>? = null

Enable IPv6 networking. Defaults to false.

Link copied to clipboard
val labels: Output<List<NetworkLabelArgs>>? = null

User-defined key/value metadata

Link copied to clipboard
val name: Output<String>? = null

The name of the Docker network.

Link copied to clipboard
val options: Output<Map<String, String>>? = null

Only available with bridge networks. See bridge options docs for more details.

Functions

Link copied to clipboard
open override fun toJava(): NetworkArgs