Skip to main content

DockerImage

Resource DockerImage in pulumi-portainer.
2 min read

Resource DockerImage in pulumi-portainer.

Pulumi type: portainer:index/dockerImage:DockerImage.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
dockerImageIdstringno
endpointIdnumberyesIdentifier of the Portainer endpoint on which the Docker image should be pulled.
imagestringyesImage reference to pull (for example nginx:latest).
registryAuthstringnoSensitive base64-encoded JSON object with registry credentials (username, password, email, serveraddress) used to pull the image.
timeoutsDockerImageTimeouts (input)no

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
dockerImageIdstringno
endpointIdnumbernoIdentifier of the Portainer endpoint on which the Docker image should be pulled.
imagestringnoImage reference to pull (for example nginx:latest).
registryAuthstringnoSensitive base64-encoded JSON object with registry credentials (username, password, email, serveraddress) used to pull the image.
timeoutsDockerImageTimeouts (output)no

DockerImageTimeouts (input)#

Input object DockerImageTimeouts. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
createstringno
deletestringno

DockerImageTimeouts (output)#

Output object DockerImageTimeouts. Fields below belong to this object.

PropertyTypeAlways presentDescription
createstringno
deletestringno