Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. DockerRepository
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.DockerRepository

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Manages a HSDP Docker repository

    This resource only works when HSDP_UAA_USERNAME and HSDP_UAA_PASSWORD values matching provider arguments are set

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as hsdp from "@pulumi/hsdp";

const apps = new hsdp.DockerNamespace("apps", {});
const caddy = new hsdp.DockerRepository("caddy", {
    namespaceId: apps.dockerNamespaceId,
    shortDescription: "Caddy server image",
    fullDescription: "A copy of the official Caddy Docker image",
});

    import pulumi
import pulumi_hsdp as hsdp

apps = hsdp.DockerNamespace("apps")
caddy = hsdp.DockerRepository("caddy",
    namespace_id=apps.docker_namespace_id,
    short_description="Caddy server image",
    full_description="A copy of the official Caddy Docker image")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		apps, err := hsdp.NewDockerNamespace(ctx, "apps", nil)
		if err != nil {
			return err
		}
		_, err = hsdp.NewDockerRepository(ctx, "caddy", &hsdp.DockerRepositoryArgs{
			NamespaceId:      apps.DockerNamespaceId,
			ShortDescription: pulumi.String("Caddy server image"),
			FullDescription:  pulumi.String("A copy of the official Caddy Docker image"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hsdp = Pulumi.Hsdp;

return await Deployment.RunAsync(() => 
{
    var apps = new Hsdp.DockerNamespace("apps");

    var caddy = new Hsdp.DockerRepository("caddy", new()
    {
        NamespaceId = apps.DockerNamespaceId,
        ShortDescription = "Caddy server image",
        FullDescription = "A copy of the official Caddy Docker image",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.DockerNamespace;
import com.pulumi.hsdp.DockerRepository;
import com.pulumi.hsdp.DockerRepositoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var apps = new DockerNamespace("apps");

        var caddy = new DockerRepository("caddy", DockerRepositoryArgs.builder()
            .namespaceId(apps.dockerNamespaceId())
            .shortDescription("Caddy server image")
            .fullDescription("A copy of the official Caddy Docker image")
            .build());

    }
}

    resources:
  apps:
    type: hsdp:DockerNamespace
  caddy:
    type: hsdp:DockerRepository
    properties:
      namespaceId: ${apps.dockerNamespaceId}
      shortDescription: Caddy server image
      fullDescription: A copy of the official Caddy Docker image

    Create DockerRepository Resource

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

    Constructor syntax

    new DockerRepository(name: string, args: DockerRepositoryArgs, opts?: CustomResourceOptions);
    @overload
def DockerRepository(resource_name: str,
                     args: DockerRepositoryArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def DockerRepository(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     namespace_id: Optional[str] = None,
                     docker_repository_id: Optional[str] = None,
                     full_description: Optional[str] = None,
                     name: Optional[str] = None,
                     short_description: Optional[str] = None)
    func NewDockerRepository(ctx *Context, name string, args DockerRepositoryArgs, opts ...ResourceOption) (*DockerRepository, error)
    public DockerRepository(string name, DockerRepositoryArgs args, CustomResourceOptions? opts = null)
    public DockerRepository(String name, DockerRepositoryArgs args)
public DockerRepository(String name, DockerRepositoryArgs args, CustomResourceOptions options)

    type: hsdp:DockerRepository
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 DockerRepositoryArgs
    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 DockerRepositoryArgs
    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 DockerRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerRepositoryArgs
    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 dockerRepositoryResource = new Hsdp.DockerRepository("dockerRepositoryResource", new()
{
    NamespaceId = "string",
    DockerRepositoryId = "string",
    FullDescription = "string",
    Name = "string",
    ShortDescription = "string",
});

    example, err := hsdp.NewDockerRepository(ctx, "dockerRepositoryResource", &hsdp.DockerRepositoryArgs{
	NamespaceId:        pulumi.String("string"),
	DockerRepositoryId: pulumi.String("string"),
	FullDescription:    pulumi.String("string"),
	Name:               pulumi.String("string"),
	ShortDescription:   pulumi.String("string"),
})

    var dockerRepositoryResource = new DockerRepository("dockerRepositoryResource", DockerRepositoryArgs.builder()
    .namespaceId("string")
    .dockerRepositoryId("string")
    .fullDescription("string")
    .name("string")
    .shortDescription("string")
    .build());

    docker_repository_resource = hsdp.DockerRepository("dockerRepositoryResource",
    namespace_id="string",
    docker_repository_id="string",
    full_description="string",
    name="string",
    short_description="string")

    const dockerRepositoryResource = new hsdp.DockerRepository("dockerRepositoryResource", {
    namespaceId: "string",
    dockerRepositoryId: "string",
    fullDescription: "string",
    name: "string",
    shortDescription: "string",
});

    type: hsdp:DockerRepository
properties:
    dockerRepositoryId: string
    fullDescription: string
    name: string
    namespaceId: string
    shortDescription: string

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

    NamespaceId string
    The organization users should belong to
    DockerRepositoryId string
    The ids of the repository
    FullDescription string
    A longer description, supporting markdown
    Name string
    Filter users on verified email state
    ShortDescription string
    A short description of the repository (100 chars max)
    NamespaceId string
    The organization users should belong to
    DockerRepositoryId string
    The ids of the repository
    FullDescription string
    A longer description, supporting markdown
    Name string
    Filter users on verified email state
    ShortDescription string
    A short description of the repository (100 chars max)
    namespaceId String
    The organization users should belong to
    dockerRepositoryId String
    The ids of the repository
    fullDescription String
    A longer description, supporting markdown
    name String
    Filter users on verified email state
    shortDescription String
    A short description of the repository (100 chars max)
    namespaceId string
    The organization users should belong to
    dockerRepositoryId string
    The ids of the repository
    fullDescription string
    A longer description, supporting markdown
    name string
    Filter users on verified email state
    shortDescription string
    A short description of the repository (100 chars max)
    namespace_id str
    The organization users should belong to
    docker_repository_id str
    The ids of the repository
    full_description str
    A longer description, supporting markdown
    name str
    Filter users on verified email state
    short_description str
    A short description of the repository (100 chars max)
    namespaceId String
    The organization users should belong to
    dockerRepositoryId String
    The ids of the repository
    fullDescription String
    A longer description, supporting markdown
    name String
    Filter users on verified email state
    shortDescription String
    A short description of the repository (100 chars max)

    Outputs

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

    CompressedSizes List<double>
    The compressed size of the tags
    FullName string
    The full name to use to pull and push images, includes Docker host and namespace
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<double>
    ImageDigests List<string>
    The SHA256 image digest of the tags
    ImageIds List<string>
    The image ids of the tags
    LatestTag string
    The latest tag, if available, based on the updated field
    NumPulls List<double>
    The pulls per tag
    Tags List<string>
    The list of tag names
    TotalPulls double
    The total number of pulls for this repo
    TotalTags double
    UpdatedAts List<string>
    The update timestamp
    CompressedSizes []float64
    The compressed size of the tags
    FullName string
    The full name to use to pull and push images, includes Docker host and namespace
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []float64
    ImageDigests []string
    The SHA256 image digest of the tags
    ImageIds []string
    The image ids of the tags
    LatestTag string
    The latest tag, if available, based on the updated field
    NumPulls []float64
    The pulls per tag
    Tags []string
    The list of tag names
    TotalPulls float64
    The total number of pulls for this repo
    TotalTags float64
    UpdatedAts []string
    The update timestamp
    compressedSizes List<Double>
    The compressed size of the tags
    fullName String
    The full name to use to pull and push images, includes Docker host and namespace
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<Double>
    imageDigests List<String>
    The SHA256 image digest of the tags
    imageIds List<String>
    The image ids of the tags
    latestTag String
    The latest tag, if available, based on the updated field
    numPulls List<Double>
    The pulls per tag
    tags List<String>
    The list of tag names
    totalPulls Double
    The total number of pulls for this repo
    totalTags Double
    updatedAts List<String>
    The update timestamp
    compressedSizes number[]
    The compressed size of the tags
    fullName string
    The full name to use to pull and push images, includes Docker host and namespace
    id string
    The provider-assigned unique ID for this managed resource.
    ids number[]
    imageDigests string[]
    The SHA256 image digest of the tags
    imageIds string[]
    The image ids of the tags
    latestTag string
    The latest tag, if available, based on the updated field
    numPulls number[]
    The pulls per tag
    tags string[]
    The list of tag names
    totalPulls number
    The total number of pulls for this repo
    totalTags number
    updatedAts string[]
    The update timestamp
    compressed_sizes Sequence[float]
    The compressed size of the tags
    full_name str
    The full name to use to pull and push images, includes Docker host and namespace
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[float]
    image_digests Sequence[str]
    The SHA256 image digest of the tags
    image_ids Sequence[str]
    The image ids of the tags
    latest_tag str
    The latest tag, if available, based on the updated field
    num_pulls Sequence[float]
    The pulls per tag
    tags Sequence[str]
    The list of tag names
    total_pulls float
    The total number of pulls for this repo
    total_tags float
    updated_ats Sequence[str]
    The update timestamp
    compressedSizes List<Number>
    The compressed size of the tags
    fullName String
    The full name to use to pull and push images, includes Docker host and namespace
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<Number>
    imageDigests List<String>
    The SHA256 image digest of the tags
    imageIds List<String>
    The image ids of the tags
    latestTag String
    The latest tag, if available, based on the updated field
    numPulls List<Number>
    The pulls per tag
    tags List<String>
    The list of tag names
    totalPulls Number
    The total number of pulls for this repo
    totalTags Number
    updatedAts List<String>
    The update timestamp

    Look up Existing DockerRepository Resource

    Get an existing DockerRepository 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?: DockerRepositoryState, opts?: CustomResourceOptions): DockerRepository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compressed_sizes: Optional[Sequence[float]] = None,
        docker_repository_id: Optional[str] = None,
        full_description: Optional[str] = None,
        full_name: Optional[str] = None,
        ids: Optional[Sequence[float]] = None,
        image_digests: Optional[Sequence[str]] = None,
        image_ids: Optional[Sequence[str]] = None,
        latest_tag: Optional[str] = None,
        name: Optional[str] = None,
        namespace_id: Optional[str] = None,
        num_pulls: Optional[Sequence[float]] = None,
        short_description: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        total_pulls: Optional[float] = None,
        total_tags: Optional[float] = None,
        updated_ats: Optional[Sequence[str]] = None) -> DockerRepository
    func GetDockerRepository(ctx *Context, name string, id IDInput, state *DockerRepositoryState, opts ...ResourceOption) (*DockerRepository, error)
    public static DockerRepository Get(string name, Input<string> id, DockerRepositoryState? state, CustomResourceOptions? opts = null)
    public static DockerRepository get(String name, Output<String> id, DockerRepositoryState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:DockerRepository    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:
    CompressedSizes List<double>
    The compressed size of the tags
    DockerRepositoryId string
    The ids of the repository
    FullDescription string
    A longer description, supporting markdown
    FullName string
    The full name to use to pull and push images, includes Docker host and namespace
    Ids List<double>
    ImageDigests List<string>
    The SHA256 image digest of the tags
    ImageIds List<string>
    The image ids of the tags
    LatestTag string
    The latest tag, if available, based on the updated field
    Name string
    Filter users on verified email state
    NamespaceId string
    The organization users should belong to
    NumPulls List<double>
    The pulls per tag
    ShortDescription string
    A short description of the repository (100 chars max)
    Tags List<string>
    The list of tag names
    TotalPulls double
    The total number of pulls for this repo
    TotalTags double
    UpdatedAts List<string>
    The update timestamp
    CompressedSizes []float64
    The compressed size of the tags
    DockerRepositoryId string
    The ids of the repository
    FullDescription string
    A longer description, supporting markdown
    FullName string
    The full name to use to pull and push images, includes Docker host and namespace
    Ids []float64
    ImageDigests []string
    The SHA256 image digest of the tags
    ImageIds []string
    The image ids of the tags
    LatestTag string
    The latest tag, if available, based on the updated field
    Name string
    Filter users on verified email state
    NamespaceId string
    The organization users should belong to
    NumPulls []float64
    The pulls per tag
    ShortDescription string
    A short description of the repository (100 chars max)
    Tags []string
    The list of tag names
    TotalPulls float64
    The total number of pulls for this repo
    TotalTags float64
    UpdatedAts []string
    The update timestamp
    compressedSizes List<Double>
    The compressed size of the tags
    dockerRepositoryId String
    The ids of the repository
    fullDescription String
    A longer description, supporting markdown
    fullName String
    The full name to use to pull and push images, includes Docker host and namespace
    ids List<Double>
    imageDigests List<String>
    The SHA256 image digest of the tags
    imageIds List<String>
    The image ids of the tags
    latestTag String
    The latest tag, if available, based on the updated field
    name String
    Filter users on verified email state
    namespaceId String
    The organization users should belong to
    numPulls List<Double>
    The pulls per tag
    shortDescription String
    A short description of the repository (100 chars max)
    tags List<String>
    The list of tag names
    totalPulls Double
    The total number of pulls for this repo
    totalTags Double
    updatedAts List<String>
    The update timestamp
    compressedSizes number[]
    The compressed size of the tags
    dockerRepositoryId string
    The ids of the repository
    fullDescription string
    A longer description, supporting markdown
    fullName string
    The full name to use to pull and push images, includes Docker host and namespace
    ids number[]
    imageDigests string[]
    The SHA256 image digest of the tags
    imageIds string[]
    The image ids of the tags
    latestTag string
    The latest tag, if available, based on the updated field
    name string
    Filter users on verified email state
    namespaceId string
    The organization users should belong to
    numPulls number[]
    The pulls per tag
    shortDescription string
    A short description of the repository (100 chars max)
    tags string[]
    The list of tag names
    totalPulls number
    The total number of pulls for this repo
    totalTags number
    updatedAts string[]
    The update timestamp
    compressed_sizes Sequence[float]
    The compressed size of the tags
    docker_repository_id str
    The ids of the repository
    full_description str
    A longer description, supporting markdown
    full_name str
    The full name to use to pull and push images, includes Docker host and namespace
    ids Sequence[float]
    image_digests Sequence[str]
    The SHA256 image digest of the tags
    image_ids Sequence[str]
    The image ids of the tags
    latest_tag str
    The latest tag, if available, based on the updated field
    name str
    Filter users on verified email state
    namespace_id str
    The organization users should belong to
    num_pulls Sequence[float]
    The pulls per tag
    short_description str
    A short description of the repository (100 chars max)
    tags Sequence[str]
    The list of tag names
    total_pulls float
    The total number of pulls for this repo
    total_tags float
    updated_ats Sequence[str]
    The update timestamp
    compressedSizes List<Number>
    The compressed size of the tags
    dockerRepositoryId String
    The ids of the repository
    fullDescription String
    A longer description, supporting markdown
    fullName String
    The full name to use to pull and push images, includes Docker host and namespace
    ids List<Number>
    imageDigests List<String>
    The SHA256 image digest of the tags
    imageIds List<String>
    The image ids of the tags
    latestTag String
    The latest tag, if available, based on the updated field
    name String
    Filter users on verified email state
    namespaceId String
    The organization users should belong to
    numPulls List<Number>
    The pulls per tag
    shortDescription String
    A short description of the repository (100 chars max)
    tags List<String>
    The list of tag names
    totalPulls Number
    The total number of pulls for this repo
    totalTags Number
    updatedAts List<String>
    The update timestamp

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp