1. Packages
  2. Hsdp Provider
  3. API Docs
  4. DockerServiceKey
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.DockerServiceKey

Explore with Pulumi AI

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

    Manages HSDP Docker Registry service keys

    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 cicd = new hsdp.DockerServiceKey("cicd", {description: "Terraform managed key"});
    export const dockerUsername = cicd.username;
    export const dockerPassword = cicd.password;
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    cicd = hsdp.DockerServiceKey("cicd", description="Terraform managed key")
    pulumi.export("dockerUsername", cicd.username)
    pulumi.export("dockerPassword", cicd.password)
    
    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 {
    		cicd, err := hsdp.NewDockerServiceKey(ctx, "cicd", &hsdp.DockerServiceKeyArgs{
    			Description: pulumi.String("Terraform managed key"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("dockerUsername", cicd.Username)
    		ctx.Export("dockerPassword", cicd.Password)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var cicd = new Hsdp.DockerServiceKey("cicd", new()
        {
            Description = "Terraform managed key",
        });
    
        return new Dictionary<string, object?>
        {
            ["dockerUsername"] = cicd.Username,
            ["dockerPassword"] = cicd.Password,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.DockerServiceKey;
    import com.pulumi.hsdp.DockerServiceKeyArgs;
    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 cicd = new DockerServiceKey("cicd", DockerServiceKeyArgs.builder()
                .description("Terraform managed key")
                .build());
    
            ctx.export("dockerUsername", cicd.username());
            ctx.export("dockerPassword", cicd.password());
        }
    }
    
    resources:
      cicd:
        type: hsdp:DockerServiceKey
        properties:
          description: Terraform managed key
    outputs:
      dockerUsername: ${cicd.username}
      dockerPassword: ${cicd.password}
    

    Create DockerServiceKey Resource

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

    Constructor syntax

    new DockerServiceKey(name: string, args: DockerServiceKeyArgs, opts?: CustomResourceOptions);
    @overload
    def DockerServiceKey(resource_name: str,
                         args: DockerServiceKeyArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DockerServiceKey(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         docker_service_key_id: Optional[str] = None)
    func NewDockerServiceKey(ctx *Context, name string, args DockerServiceKeyArgs, opts ...ResourceOption) (*DockerServiceKey, error)
    public DockerServiceKey(string name, DockerServiceKeyArgs args, CustomResourceOptions? opts = null)
    public DockerServiceKey(String name, DockerServiceKeyArgs args)
    public DockerServiceKey(String name, DockerServiceKeyArgs args, CustomResourceOptions options)
    
    type: hsdp:DockerServiceKey
    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 DockerServiceKeyArgs
    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 DockerServiceKeyArgs
    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 DockerServiceKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DockerServiceKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DockerServiceKeyArgs
    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 dockerServiceKeyResource = new Hsdp.DockerServiceKey("dockerServiceKeyResource", new()
    {
        Description = "string",
        DockerServiceKeyId = "string",
    });
    
    example, err := hsdp.NewDockerServiceKey(ctx, "dockerServiceKeyResource", &hsdp.DockerServiceKeyArgs{
    	Description:        pulumi.String("string"),
    	DockerServiceKeyId: pulumi.String("string"),
    })
    
    var dockerServiceKeyResource = new DockerServiceKey("dockerServiceKeyResource", DockerServiceKeyArgs.builder()
        .description("string")
        .dockerServiceKeyId("string")
        .build());
    
    docker_service_key_resource = hsdp.DockerServiceKey("dockerServiceKeyResource",
        description="string",
        docker_service_key_id="string")
    
    const dockerServiceKeyResource = new hsdp.DockerServiceKey("dockerServiceKeyResource", {
        description: "string",
        dockerServiceKeyId: "string",
    });
    
    type: hsdp:DockerServiceKey
    properties:
        description: string
        dockerServiceKeyId: string
    

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

    Description string
    The description of the service key
    DockerServiceKeyId string
    The ID of the service key
    Description string
    The description of the service key
    DockerServiceKeyId string
    The ID of the service key
    description String
    The description of the service key
    dockerServiceKeyId String
    The ID of the service key
    description string
    The description of the service key
    dockerServiceKeyId string
    The ID of the service key
    description str
    The description of the service key
    docker_service_key_id str
    The ID of the service key
    description String
    The description of the service key
    dockerServiceKeyId String
    The ID of the service key

    Outputs

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

    CreatedAt string
    (Computed) The timestamp the key was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Computed, Sensitive) The service key password
    Username string
    (Computed) The service key username
    CreatedAt string
    (Computed) The timestamp the key was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Computed, Sensitive) The service key password
    Username string
    (Computed) The service key username
    createdAt String
    (Computed) The timestamp the key was created
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Computed, Sensitive) The service key password
    username String
    (Computed) The service key username
    createdAt string
    (Computed) The timestamp the key was created
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (Computed, Sensitive) The service key password
    username string
    (Computed) The service key username
    created_at str
    (Computed) The timestamp the key was created
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (Computed, Sensitive) The service key password
    username str
    (Computed) The service key username
    createdAt String
    (Computed) The timestamp the key was created
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Computed, Sensitive) The service key password
    username String
    (Computed) The service key username

    Look up Existing DockerServiceKey Resource

    Get an existing DockerServiceKey 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?: DockerServiceKeyState, opts?: CustomResourceOptions): DockerServiceKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            docker_service_key_id: Optional[str] = None,
            password: Optional[str] = None,
            username: Optional[str] = None) -> DockerServiceKey
    func GetDockerServiceKey(ctx *Context, name string, id IDInput, state *DockerServiceKeyState, opts ...ResourceOption) (*DockerServiceKey, error)
    public static DockerServiceKey Get(string name, Input<string> id, DockerServiceKeyState? state, CustomResourceOptions? opts = null)
    public static DockerServiceKey get(String name, Output<String> id, DockerServiceKeyState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:DockerServiceKey    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:
    CreatedAt string
    (Computed) The timestamp the key was created
    Description string
    The description of the service key
    DockerServiceKeyId string
    The ID of the service key
    Password string
    (Computed, Sensitive) The service key password
    Username string
    (Computed) The service key username
    CreatedAt string
    (Computed) The timestamp the key was created
    Description string
    The description of the service key
    DockerServiceKeyId string
    The ID of the service key
    Password string
    (Computed, Sensitive) The service key password
    Username string
    (Computed) The service key username
    createdAt String
    (Computed) The timestamp the key was created
    description String
    The description of the service key
    dockerServiceKeyId String
    The ID of the service key
    password String
    (Computed, Sensitive) The service key password
    username String
    (Computed) The service key username
    createdAt string
    (Computed) The timestamp the key was created
    description string
    The description of the service key
    dockerServiceKeyId string
    The ID of the service key
    password string
    (Computed, Sensitive) The service key password
    username string
    (Computed) The service key username
    created_at str
    (Computed) The timestamp the key was created
    description str
    The description of the service key
    docker_service_key_id str
    The ID of the service key
    password str
    (Computed, Sensitive) The service key password
    username str
    (Computed) The service key username
    createdAt String
    (Computed) The timestamp the key was created
    description String
    The description of the service key
    dockerServiceKeyId String
    The ID of the service key
    password String
    (Computed, Sensitive) The service key password
    username String
    (Computed) The service key username

    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