1. Packages
  2. Docker
  3. API Docs
  4. Tag
Docker v4.5.3 published on Wednesday, Mar 27, 2024 by Pulumi

docker.Tag

Explore with Pulumi AI

docker logo
Docker v4.5.3 published on Wednesday, Mar 27, 2024 by Pulumi

    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

    new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);
    @overload
    def Tag(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            source_image: Optional[str] = None,
            target_image: Optional[str] = None)
    @overload
    def Tag(resource_name: str,
            args: TagArgs,
            opts: Optional[ResourceOptions] = None)
    func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
    public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
    public Tag(String name, TagArgs args)
    public Tag(String name, TagArgs args, CustomResourceOptions options)
    
    type: docker:Tag
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args TagArgs
    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 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 string
    The unique name of the resource.
    args TagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Tag resource accepts the following input properties:

    SourceImage string
    Name of the source image.
    TargetImage string
    Name of the target image.
    SourceImage string
    Name of the source image.
    TargetImage string
    Name of the target image.
    sourceImage String
    Name of the source image.
    targetImage String
    Name of the target image.
    sourceImage string
    Name of the source image.
    targetImage string
    Name of the target image.
    source_image str
    Name of the source image.
    target_image str
    Name of the target image.
    sourceImage String
    Name of the source image.
    targetImage String
    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.
    SourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    id String
    The provider-assigned unique ID for this managed resource.
    sourceImageId String
    ImageID of the source image in the format of sha256:<<ID>>
    id string
    The provider-assigned unique ID for this managed resource.
    sourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    id str
    The provider-assigned unique ID for this managed resource.
    source_image_id str
    ImageID of the source image in the format of sha256:<<ID>>
    id String
    The provider-assigned unique ID for this managed resource.
    sourceImageId String
    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) -> Tag
    func 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)
    Resource lookup is not supported in YAML
    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:
    SourceImage string
    Name of the source image.
    SourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    TargetImage string
    Name of the target image.
    SourceImage string
    Name of the source image.
    SourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    TargetImage string
    Name of the target image.
    sourceImage String
    Name of the source image.
    sourceImageId String
    ImageID of the source image in the format of sha256:<<ID>>
    targetImage String
    Name of the target image.
    sourceImage string
    Name of the source image.
    sourceImageId string
    ImageID of the source image in the format of sha256:<<ID>>
    targetImage string
    Name of the target image.
    source_image str
    Name of the source image.
    source_image_id str
    ImageID of the source image in the format of sha256:<<ID>>
    target_image str
    Name of the target image.
    sourceImage String
    Name of the source image.
    sourceImageId String
    ImageID of the source image in the format of sha256:<<ID>>
    targetImage String
    Name of the target image.

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Docker v4.5.3 published on Wednesday, Mar 27, 2024 by Pulumi