Docker v4.6.2, Mar 15 25

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

docker.RegistryImage

Explore with Pulumi AI

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

Create RegistryImage Resource

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

new RegistryImage(name: string, args?: RegistryImageArgs, opts?: CustomResourceOptions);

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

@overload
def RegistryImage(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  insecure_skip_verify: Optional[bool] = None,
                  keep_remotely: Optional[bool] = None,
                  name: Optional[str] = None,
                  triggers: Optional[Mapping[str, str]] = None)

func NewRegistryImage(ctx *Context, name string, args *RegistryImageArgs, opts ...ResourceOption) (*RegistryImage, error)

public RegistryImage(string name, RegistryImageArgs? args = null, CustomResourceOptions? opts = null)

public RegistryImage(String name, RegistryImageArgs args)
public RegistryImage(String name, RegistryImageArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args RegistryImageArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var registryImageResource = new Docker.RegistryImage("registryImageResource", new()
{
    InsecureSkipVerify = false,
    KeepRemotely = false,
    Name = "string",
    Triggers = 
    {
        { "string", "string" },
    },
});

example, err := docker.NewRegistryImage(ctx, "registryImageResource", &docker.RegistryImageArgs{
	InsecureSkipVerify: pulumi.Bool(false),
	KeepRemotely:       pulumi.Bool(false),
	Name:               pulumi.String("string"),
	Triggers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var registryImageResource = new RegistryImage("registryImageResource", RegistryImageArgs.builder()
    .insecureSkipVerify(false)
    .keepRemotely(false)
    .name("string")
    .triggers(Map.of("string", "string"))
    .build());

registry_image_resource = docker.RegistryImage("registryImageResource",
    insecure_skip_verify=False,
    keep_remotely=False,
    name="string",
    triggers={
        "string": "string",
    })

const registryImageResource = new docker.RegistryImage("registryImageResource", {
    insecureSkipVerify: false,
    keepRemotely: false,
    name: "string",
    triggers: {
        string: "string",
    },
});

type: docker:RegistryImage
properties:
    insecureSkipVerify: false
    keepRemotely: false
    name: string
    triggers:
        string: string

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

InsecureSkipVerify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
KeepRemotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
Name string: The name of the Docker image.
Triggers Dictionary<string, string>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

InsecureSkipVerify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
KeepRemotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
Name string: The name of the Docker image.
Triggers map[string]string: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify Boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely Boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name String: The name of the Docker image.
triggers Map<String,String>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name string: The name of the Docker image.
triggers {[key: string]: string}: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecure_skip_verify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keep_remotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name str: The name of the Docker image.
triggers Mapping[str, str]: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify Boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely Boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name String: The name of the Docker image.
triggers Map<String>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Sha256Digest string: The sha256 digest of the image.

Id string: The provider-assigned unique ID for this managed resource.
Sha256Digest string: The sha256 digest of the image.

id String: The provider-assigned unique ID for this managed resource.
sha256Digest String: The sha256 digest of the image.

id string: The provider-assigned unique ID for this managed resource.
sha256Digest string: The sha256 digest of the image.

id str: The provider-assigned unique ID for this managed resource.
sha256_digest str: The sha256 digest of the image.

id String: The provider-assigned unique ID for this managed resource.
sha256Digest String: The sha256 digest of the image.

Look up Existing RegistryImage Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: RegistryImageState, opts?: CustomResourceOptions): RegistryImage

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        insecure_skip_verify: Optional[bool] = None,
        keep_remotely: Optional[bool] = None,
        name: Optional[str] = None,
        sha256_digest: Optional[str] = None,
        triggers: Optional[Mapping[str, str]] = None) -> RegistryImage

func GetRegistryImage(ctx *Context, name string, id IDInput, state *RegistryImageState, opts ...ResourceOption) (*RegistryImage, error)

public static RegistryImage Get(string name, Input<string> id, RegistryImageState? state, CustomResourceOptions? opts = null)

public static RegistryImage get(String name, Output<String> id, RegistryImageState state, CustomResourceOptions options)

resources:  _:    type: docker:RegistryImage    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:

InsecureSkipVerify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
KeepRemotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
Name string: The name of the Docker image.
Sha256Digest string: The sha256 digest of the image.
Triggers Dictionary<string, string>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

InsecureSkipVerify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
KeepRemotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
Name string: The name of the Docker image.
Sha256Digest string: The sha256 digest of the image.
Triggers map[string]string: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify Boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely Boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name String: The name of the Docker image.
sha256Digest String: The sha256 digest of the image.
triggers Map<String,String>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name string: The name of the Docker image.
sha256Digest string: The sha256 digest of the image.
triggers {[key: string]: string}: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecure_skip_verify bool: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keep_remotely bool: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name str: The name of the Docker image.
sha256_digest str: The sha256 digest of the image.
triggers Mapping[str, str]: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

insecureSkipVerify Boolean: If true, the verification of TLS certificates of the server/registry is disabled. Defaults to false
keepRemotely Boolean: If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker registry on destroy operation. Defaults to false
name String: The name of the Docker image.
sha256Digest String: The sha256 digest of the image.
triggers Map<String>: A map of arbitrary strings that, when changed, will force the docker.RegistryImage resource to be replaced. This can be used to repush a local image

Package Details

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

Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi

pulumi/pulumi-docker

docker.RegistryImage

On this page

On this page

Create RegistryImage Resource

Constructor syntax

Parameters

Constructor example

RegistryImage Resource Properties

Inputs

Outputs

Look up Existing RegistryImage Resource

Package Details

On this page

On this page