Docs Home
Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi
docker.Tag
Explore with Pulumi AI
Creates a docker tag. It has the exact same functionality as the docker tag command. Deleting the resource will neither delete the source nor target images. The source image must exist on the machine running the docker daemon.
Create Tag Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);@overload
def Tag(resource_name: str,
args: TagArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Tag(resource_name: str,
opts: Optional[ResourceOptions] = None,
source_image: Optional[str] = None,
target_image: Optional[str] = None)func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)type: docker:Tag
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
This property is required. TagArgs - 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
This property is required. TagArgs - 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
This property is required. TagArgs - 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
This property is required. TagArgs - 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. TagArgs - 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 tagResource = new Docker.Tag("tagResource", new()
{
SourceImage = "string",
TargetImage = "string",
});
example, err := docker.NewTag(ctx, "tagResource", &docker.TagArgs{
SourceImage: pulumi.String("string"),
TargetImage: pulumi.String("string"),
})
var tagResource = new Tag("tagResource", TagArgs.builder()
.sourceImage("string")
.targetImage("string")
.build());
tag_resource = docker.Tag("tagResource",
source_image="string",
target_image="string")
const tagResource = new docker.Tag("tagResource", {
sourceImage: "string",
targetImage: "string",
});
type: docker:Tag
properties:
sourceImage: string
targetImage: string
Tag 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 Tag resource accepts the following input properties:
- Source
Image stringThis property is required. 
Changes to this property will trigger replacement. - Name of the source image.
- Target
Image stringThis property is required. Changes to this property will trigger replacement. - Name of the target image.
- Source
Image stringThis property is required. Changes to this property will trigger replacement. - Name of the source image.
- Target
Image stringThis property is required. Changes to this property will trigger replacement. - Name of the target image.
- source
Image StringThis property is required. Changes to this property will trigger replacement. - Name of the source image.
- target
Image StringThis property is required. Changes to this property will trigger replacement. - Name of the target image.
- source
Image stringThis property is required. Changes to this property will trigger replacement. - Name of the source image.
- target
Image stringThis property is required. Changes to this property will trigger replacement. - Name of the target image.
- source_
image strThis property is required. Changes to this property will trigger replacement. - Name of the source image.
- target_
image strThis property is required. Changes to this property will trigger replacement. - Name of the target image.
- source
Image StringThis property is required. Changes to this property will trigger replacement. - Name of the source image.
- target
Image StringThis property is required. Changes to this property will trigger replacement. - Name of the target image.
Outputs
All input properties are implicitly available as output properties. Additionally, the Tag resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>>
- Id string
- The provider-assigned unique ID for this managed resource.
- Source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>>
- id String
- The provider-assigned unique ID for this managed resource.
- source
Image StringId - ImageID of the source image in the format of
sha256:<<ID>>
- id string
- The provider-assigned unique ID for this managed resource.
- source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>>
- id str
- The provider-assigned unique ID for this managed resource.
- source_
image_ strid - ImageID of the source image in the format of
sha256:<<ID>>
- id String
- The provider-assigned unique ID for this managed resource.
- source
Image StringId - ImageID of the source image in the format of
sha256:<<ID>>
Look up Existing Tag Resource
Get an existing Tag 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?: TagState, opts?: CustomResourceOptions): Tag@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
source_image: Optional[str] = None,
source_image_id: Optional[str] = None,
target_image: Optional[str] = None) -> Tagfunc GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)public static Tag get(String name, Output<String> id, TagState state, CustomResourceOptions options)resources: _: type: docker:Tag 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:
- Source
Image - Name of the source image.
- Source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>> - Target
Image - Name of the target image.
- Source
Image - Name of the source image.
- Source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>> - Target
Image - Name of the target image.
- source
Image - Name of the source image.
- source
Image StringId - ImageID of the source image in the format of
sha256:<<ID>> - target
Image - Name of the target image.
- source
Image - Name of the source image.
- source
Image stringId - ImageID of the source image in the format of
sha256:<<ID>> - target
Image - Name of the target image.
- source_
image - Name of the source image.
- source_
image_ strid - ImageID of the source image in the format of
sha256:<<ID>> - target_
image - Name of the target image.
- source
Image - Name of the source image.
- source
Image StringId - ImageID of the source image in the format of
sha256:<<ID>> - target
Image - Name of the target image.
Package Details
- Repository
- Docker pulumi/pulumi-docker
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
dockerTerraform Provider.