Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. ServiceConnectionDocker
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.ServiceConnectionDocker

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";

// Create a local docker connection
const local = new authentik.ServiceConnectionDocker("local", {local: true});
// Create a remote docker connection
const tls_auth = new authentik.CertificateKeyPair("tls-auth", {
    certificateData: "...",
    keyData: "...",
});
const tls_verification = new authentik.CertificateKeyPair("tls-verification", {certificateData: "..."});
const remote_host = new authentik.ServiceConnectionDocker("remote-host", {
    url: "http://1.2.3.4:2368",
    tlsVerification: tls_auth.certificateKeyPairId,
    tlsAuthentication: tls_verification.certificateKeyPairId,
});
Copy
import pulumi
import pulumi_authentik as authentik

# Create a local docker connection
local = authentik.ServiceConnectionDocker("local", local=True)
# Create a remote docker connection
tls_auth = authentik.CertificateKeyPair("tls-auth",
    certificate_data="...",
    key_data="...")
tls_verification = authentik.CertificateKeyPair("tls-verification", certificate_data="...")
remote_host = authentik.ServiceConnectionDocker("remote-host",
    url="http://1.2.3.4:2368",
    tls_verification=tls_auth.certificate_key_pair_id,
    tls_authentication=tls_verification.certificate_key_pair_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a local docker connection
		_, err := authentik.NewServiceConnectionDocker(ctx, "local", &authentik.ServiceConnectionDockerArgs{
			Local: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		tls_auth, err := authentik.NewCertificateKeyPair(ctx, "tls-auth", &authentik.CertificateKeyPairArgs{
			CertificateData: pulumi.String("..."),
			KeyData:         pulumi.String("..."),
		})
		if err != nil {
			return err
		}
		tls_verification, err := authentik.NewCertificateKeyPair(ctx, "tls-verification", &authentik.CertificateKeyPairArgs{
			CertificateData: pulumi.String("..."),
		})
		if err != nil {
			return err
		}
		_, err = authentik.NewServiceConnectionDocker(ctx, "remote-host", &authentik.ServiceConnectionDockerArgs{
			Url:               pulumi.String("http://1.2.3.4:2368"),
			TlsVerification:   tls_auth.CertificateKeyPairId,
			TlsAuthentication: tls_verification.CertificateKeyPairId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    // Create a local docker connection
    var local = new Authentik.ServiceConnectionDocker("local", new()
    {
        Local = true,
    });

    // Create a remote docker connection
    var tls_auth = new Authentik.CertificateKeyPair("tls-auth", new()
    {
        CertificateData = "...",
        KeyData = "...",
    });

    var tls_verification = new Authentik.CertificateKeyPair("tls-verification", new()
    {
        CertificateData = "...",
    });

    var remote_host = new Authentik.ServiceConnectionDocker("remote-host", new()
    {
        Url = "http://1.2.3.4:2368",
        TlsVerification = tls_auth.CertificateKeyPairId,
        TlsAuthentication = tls_verification.CertificateKeyPairId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.ServiceConnectionDocker;
import com.pulumi.authentik.ServiceConnectionDockerArgs;
import com.pulumi.authentik.CertificateKeyPair;
import com.pulumi.authentik.CertificateKeyPairArgs;
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) {
        // Create a local docker connection
        var local = new ServiceConnectionDocker("local", ServiceConnectionDockerArgs.builder()
            .local(true)
            .build());

        // Create a remote docker connection
        var tls_auth = new CertificateKeyPair("tls-auth", CertificateKeyPairArgs.builder()
            .certificateData("...")
            .keyData("...")
            .build());

        var tls_verification = new CertificateKeyPair("tls-verification", CertificateKeyPairArgs.builder()
            .certificateData("...")
            .build());

        var remote_host = new ServiceConnectionDocker("remote-host", ServiceConnectionDockerArgs.builder()
            .url("http://1.2.3.4:2368")
            .tlsVerification(tls_auth.certificateKeyPairId())
            .tlsAuthentication(tls_verification.certificateKeyPairId())
            .build());

    }
}
Copy
resources:
  # Create a local docker connection
  local: # Create a remote docker connection
    type: authentik:ServiceConnectionDocker
    properties:
      local: true
  tls-auth:
    type: authentik:CertificateKeyPair
    properties:
      certificateData: '...'
      keyData: '...'
  tls-verification:
    type: authentik:CertificateKeyPair
    properties:
      certificateData: '...'
  remote-host:
    type: authentik:ServiceConnectionDocker
    properties:
      url: http://1.2.3.4:2368
      tlsVerification: ${["tls-auth"].certificateKeyPairId}
      tlsAuthentication: ${["tls-verification"].certificateKeyPairId}
Copy

Create ServiceConnectionDocker Resource

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

Constructor syntax

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

@overload
def ServiceConnectionDocker(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            local: Optional[bool] = None,
                            name: Optional[str] = None,
                            service_connection_docker_id: Optional[str] = None,
                            tls_authentication: Optional[str] = None,
                            tls_verification: Optional[str] = None,
                            url: Optional[str] = None)
func NewServiceConnectionDocker(ctx *Context, name string, args *ServiceConnectionDockerArgs, opts ...ResourceOption) (*ServiceConnectionDocker, error)
public ServiceConnectionDocker(string name, ServiceConnectionDockerArgs? args = null, CustomResourceOptions? opts = null)
public ServiceConnectionDocker(String name, ServiceConnectionDockerArgs args)
public ServiceConnectionDocker(String name, ServiceConnectionDockerArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args ServiceConnectionDockerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ServiceConnectionDockerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ServiceConnectionDockerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ServiceConnectionDockerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceConnectionDockerArgs
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 serviceConnectionDockerResource = new Authentik.ServiceConnectionDocker("serviceConnectionDockerResource", new()
{
    Local = false,
    Name = "string",
    ServiceConnectionDockerId = "string",
    TlsAuthentication = "string",
    TlsVerification = "string",
    Url = "string",
});
Copy
example, err := authentik.NewServiceConnectionDocker(ctx, "serviceConnectionDockerResource", &authentik.ServiceConnectionDockerArgs{
	Local:                     pulumi.Bool(false),
	Name:                      pulumi.String("string"),
	ServiceConnectionDockerId: pulumi.String("string"),
	TlsAuthentication:         pulumi.String("string"),
	TlsVerification:           pulumi.String("string"),
	Url:                       pulumi.String("string"),
})
Copy
var serviceConnectionDockerResource = new ServiceConnectionDocker("serviceConnectionDockerResource", ServiceConnectionDockerArgs.builder()
    .local(false)
    .name("string")
    .serviceConnectionDockerId("string")
    .tlsAuthentication("string")
    .tlsVerification("string")
    .url("string")
    .build());
Copy
service_connection_docker_resource = authentik.ServiceConnectionDocker("serviceConnectionDockerResource",
    local=False,
    name="string",
    service_connection_docker_id="string",
    tls_authentication="string",
    tls_verification="string",
    url="string")
Copy
const serviceConnectionDockerResource = new authentik.ServiceConnectionDocker("serviceConnectionDockerResource", {
    local: false,
    name: "string",
    serviceConnectionDockerId: "string",
    tlsAuthentication: "string",
    tlsVerification: "string",
    url: "string",
});
Copy
type: authentik:ServiceConnectionDocker
properties:
    local: false
    name: string
    serviceConnectionDockerId: string
    tlsAuthentication: string
    tlsVerification: string
    url: string
Copy

ServiceConnectionDocker 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 ServiceConnectionDocker resource accepts the following input properties:

Local bool
Defaults to false.
Name string
ServiceConnectionDockerId string
The ID of this resource.
TlsAuthentication string
TlsVerification string
Url string
Defaults to http+unix:///var/run/docker.sock.
Local bool
Defaults to false.
Name string
ServiceConnectionDockerId string
The ID of this resource.
TlsAuthentication string
TlsVerification string
Url string
Defaults to http+unix:///var/run/docker.sock.
local Boolean
Defaults to false.
name String
serviceConnectionDockerId String
The ID of this resource.
tlsAuthentication String
tlsVerification String
url String
Defaults to http+unix:///var/run/docker.sock.
local boolean
Defaults to false.
name string
serviceConnectionDockerId string
The ID of this resource.
tlsAuthentication string
tlsVerification string
url string
Defaults to http+unix:///var/run/docker.sock.
local bool
Defaults to false.
name str
service_connection_docker_id str
The ID of this resource.
tls_authentication str
tls_verification str
url str
Defaults to http+unix:///var/run/docker.sock.
local Boolean
Defaults to false.
name String
serviceConnectionDockerId String
The ID of this resource.
tlsAuthentication String
tlsVerification String
url String
Defaults to http+unix:///var/run/docker.sock.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceConnectionDocker 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 ServiceConnectionDocker Resource

Get an existing ServiceConnectionDocker 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?: ServiceConnectionDockerState, opts?: CustomResourceOptions): ServiceConnectionDocker
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        local: Optional[bool] = None,
        name: Optional[str] = None,
        service_connection_docker_id: Optional[str] = None,
        tls_authentication: Optional[str] = None,
        tls_verification: Optional[str] = None,
        url: Optional[str] = None) -> ServiceConnectionDocker
func GetServiceConnectionDocker(ctx *Context, name string, id IDInput, state *ServiceConnectionDockerState, opts ...ResourceOption) (*ServiceConnectionDocker, error)
public static ServiceConnectionDocker Get(string name, Input<string> id, ServiceConnectionDockerState? state, CustomResourceOptions? opts = null)
public static ServiceConnectionDocker get(String name, Output<String> id, ServiceConnectionDockerState state, CustomResourceOptions options)
resources:  _:    type: authentik:ServiceConnectionDocker    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Local bool
Defaults to false.
Name string
ServiceConnectionDockerId string
The ID of this resource.
TlsAuthentication string
TlsVerification string
Url string
Defaults to http+unix:///var/run/docker.sock.
Local bool
Defaults to false.
Name string
ServiceConnectionDockerId string
The ID of this resource.
TlsAuthentication string
TlsVerification string
Url string
Defaults to http+unix:///var/run/docker.sock.
local Boolean
Defaults to false.
name String
serviceConnectionDockerId String
The ID of this resource.
tlsAuthentication String
tlsVerification String
url String
Defaults to http+unix:///var/run/docker.sock.
local boolean
Defaults to false.
name string
serviceConnectionDockerId string
The ID of this resource.
tlsAuthentication string
tlsVerification string
url string
Defaults to http+unix:///var/run/docker.sock.
local bool
Defaults to false.
name str
service_connection_docker_id str
The ID of this resource.
tls_authentication str
tls_verification str
url str
Defaults to http+unix:///var/run/docker.sock.
local Boolean
Defaults to false.
name String
serviceConnectionDockerId String
The ID of this resource.
tlsAuthentication String
tlsVerification String
url String
Defaults to http+unix:///var/run/docker.sock.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik