Docker v4.5.6, Sep 24 24

Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi

docker.Provider

Explore with Pulumi AI

Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi

The provider type for the docker package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ca_material: Optional[str] = None,
             cert_material: Optional[str] = None,
             cert_path: Optional[str] = None,
             host: Optional[str] = None,
             key_material: Optional[str] = None,
             registry_auth: Optional[Sequence[ProviderRegistryAuthArgs]] = None,
             ssh_opts: Optional[Sequence[str]] = None)

func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:docker
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 ProviderArgs: 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 ProviderArgs: 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 ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

CaMaterial string: PEM-encoded content of Docker host CA certificate
CertMaterial string: PEM-encoded content of Docker client certificate
CertPath string: Path to directory with Docker TLS config
Host string: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
KeyMaterial string: PEM-encoded content of Docker client private key
RegistryAuth List<ProviderRegistryAuth>
SshOpts List<string>: Additional SSH option flags to be appended when using ssh:// protocol

CaMaterial string: PEM-encoded content of Docker host CA certificate
CertMaterial string: PEM-encoded content of Docker client certificate
CertPath string: Path to directory with Docker TLS config
Host string: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
KeyMaterial string: PEM-encoded content of Docker client private key
RegistryAuth []ProviderRegistryAuthArgs
SshOpts []string: Additional SSH option flags to be appended when using ssh:// protocol

caMaterial String: PEM-encoded content of Docker host CA certificate
certMaterial String: PEM-encoded content of Docker client certificate
certPath String: Path to directory with Docker TLS config
host String: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
keyMaterial String: PEM-encoded content of Docker client private key
registryAuth List<ProviderRegistryAuth>
sshOpts List<String>: Additional SSH option flags to be appended when using ssh:// protocol

caMaterial string: PEM-encoded content of Docker host CA certificate
certMaterial string: PEM-encoded content of Docker client certificate
certPath string: Path to directory with Docker TLS config
host string: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
keyMaterial string: PEM-encoded content of Docker client private key
registryAuth ProviderRegistryAuth[]
sshOpts string[]: Additional SSH option flags to be appended when using ssh:// protocol

ca_material str: PEM-encoded content of Docker host CA certificate
cert_material str: PEM-encoded content of Docker client certificate
cert_path str: Path to directory with Docker TLS config
host str: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
key_material str: PEM-encoded content of Docker client private key
registry_auth Sequence[ProviderRegistryAuthArgs]
ssh_opts Sequence[str]: Additional SSH option flags to be appended when using ssh:// protocol

caMaterial String: PEM-encoded content of Docker host CA certificate
certMaterial String: PEM-encoded content of Docker client certificate
certPath String: Path to directory with Docker TLS config
host String: The Docker daemon address It can also be sourced from the following environment variable: DOCKER_HOST
keyMaterial String: PEM-encoded content of Docker client private key
registryAuth List<Property Map>
sshOpts List<String>: Additional SSH option flags to be appended when using ssh:// protocol

Outputs

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

Supporting Types

ProviderRegistryAuth, ProviderRegistryAuthArgs

Address string: Address of the registry
AuthDisabled bool
ConfigFile string: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
ConfigFileContent string: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
Password string: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
Username string: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

Address string: Address of the registry
AuthDisabled bool
ConfigFile string: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
ConfigFileContent string: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
Password string: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
Username string: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

address String: Address of the registry
authDisabled Boolean
configFile String: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
configFileContent String: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
password String: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
username String: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

address string: Address of the registry
authDisabled boolean
configFile string: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
configFileContent string: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
password string: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
username string: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

address str: Address of the registry
auth_disabled bool
config_file str: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
config_file_content str: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
password str: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
username str: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

address String: Address of the registry
authDisabled Boolean
configFile String: Path to docker json file for registry auth. Defaults to ~/.docker/config.json. If DOCKER_CONFIG is set, the value of DOCKER_CONFIG is used as the path. config_file has predencen over all other options.
configFileContent String: Plain content of the docker json file for registry auth. config_file_content has precedence over username/password.
password String: Password for the registry. Defaults to DOCKER_REGISTRY_PASS env variable if set.
username String: Username for the registry. Defaults to DOCKER_REGISTRY_USER env variable if set.

Package Details

Repository: Docker pulumi/pulumi-docker
License: Apache-2.0
Notes: This Pulumi package is based on the docker Terraform Provider.

Docker v4.5.6 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-docker

docker.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Supporting Types

ProviderRegistryAuth, ProviderRegistryAuthArgs

Package Details

On this page

On this page