@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
119 lines • 5 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ContainerRegistryDockerCredentials = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Get Docker credentials for your DigitalOcean container registry.
*
* An error is triggered if the provided container registry name does not exist.
*
* ## Example Usage
*
* ### Basic Example
*
* Get the container registry:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = new digitalocean.ContainerRegistryDockerCredentials("example", {registryName: "example"});
* ```
*
* ### Docker Provider Example
*
* Use the `endpoint` and `dockerCredentials` with the Docker provider:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = digitalocean.getContainerRegistry({
* name: "example",
* });
* const exampleContainerRegistryDockerCredentials = new digitalocean.ContainerRegistryDockerCredentials("example", {registryName: "example"});
* ```
*
* ### Kubernetes Example
*
* Combined with the Kubernetes Provider's `kubernetesSecret` resource, you can
* access the registry from inside your cluster:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
* import * as kubernetes from "@pulumi/kubernetes";
*
* const exampleContainerRegistryDockerCredentials = new digitalocean.ContainerRegistryDockerCredentials("example", {registryName: "example"});
* const example = digitalocean.getKubernetesCluster({
* name: "prod-cluster-01",
* });
* const exampleSecret = new kubernetes.index.Secret("example", {
* metadata: [{
* name: "docker-cfg",
* }],
* data: {
* ".dockerconfigjson": exampleContainerRegistryDockerCredentials.dockerCredentials,
* },
* type: "kubernetes.io/dockerconfigjson",
* });
* ```
*/
class ContainerRegistryDockerCredentials extends pulumi.CustomResource {
/**
* Get an existing ContainerRegistryDockerCredentials resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new ContainerRegistryDockerCredentials(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ContainerRegistryDockerCredentials. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === ContainerRegistryDockerCredentials.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["credentialExpirationTime"] = state?.credentialExpirationTime;
resourceInputs["dockerCredentials"] = state?.dockerCredentials;
resourceInputs["expirySeconds"] = state?.expirySeconds;
resourceInputs["registryName"] = state?.registryName;
resourceInputs["write"] = state?.write;
}
else {
const args = argsOrState;
if (args?.registryName === undefined && !opts.urn) {
throw new Error("Missing required property 'registryName'");
}
resourceInputs["expirySeconds"] = args?.expirySeconds;
resourceInputs["registryName"] = args?.registryName;
resourceInputs["write"] = args?.write;
resourceInputs["credentialExpirationTime"] = undefined /*out*/;
resourceInputs["dockerCredentials"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["dockerCredentials"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(ContainerRegistryDockerCredentials.__pulumiType, name, resourceInputs, opts);
}
}
exports.ContainerRegistryDockerCredentials = ContainerRegistryDockerCredentials;
/** @internal */
ContainerRegistryDockerCredentials.__pulumiType = 'digitalocean:index/containerRegistryDockerCredentials:ContainerRegistryDockerCredentials';
//# sourceMappingURL=containerRegistryDockerCredentials.js.map