com.pulumi.digitalocean.kotlin.ContainerRegistryDockerCredentials.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-digitalocean-kotlin Show documentation
Show all versions of pulumi-digitalocean-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.digitalocean.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [ContainerRegistryDockerCredentials].
*/
@PulumiTagMarker
public class ContainerRegistryDockerCredentialsResourceBuilder internal constructor() {
public var name: String? = null
public var args: ContainerRegistryDockerCredentialsArgs = ContainerRegistryDockerCredentialsArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ContainerRegistryDockerCredentialsArgsBuilder.() -> Unit) {
val builder = ContainerRegistryDockerCredentialsArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ContainerRegistryDockerCredentials {
val builtJavaResource =
com.pulumi.digitalocean.ContainerRegistryDockerCredentials(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ContainerRegistryDockerCredentials(builtJavaResource)
}
}
/**
* 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"});
* ```
* ```python
* import pulumi
* import pulumi_digitalocean as digitalocean
* example = digitalocean.ContainerRegistryDockerCredentials("example", registry_name="example")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using DigitalOcean = Pulumi.DigitalOcean;
* return await Deployment.RunAsync(() =>
* {
* var example = new DigitalOcean.ContainerRegistryDockerCredentials("example", new()
* {
* RegistryName = "example",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := digitalocean.NewContainerRegistryDockerCredentials(ctx, "example", &digitalocean.ContainerRegistryDockerCredentialsArgs{
* RegistryName: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentials;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentialsArgs;
* 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 example = new ContainerRegistryDockerCredentials("example", ContainerRegistryDockerCredentialsArgs.builder()
* .registryName("example")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: digitalocean:ContainerRegistryDockerCredentials
* properties:
* registryName: example
* ```
*
* ### Docker Provider Example
* Use the `endpoint` and `docker_credentials` 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"});
* ```
* ```python
* import pulumi
* import pulumi_digitalocean as digitalocean
* example = digitalocean.get_container_registry(name="example")
* example_container_registry_docker_credentials = digitalocean.ContainerRegistryDockerCredentials("example", registry_name="example")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using DigitalOcean = Pulumi.DigitalOcean;
* return await Deployment.RunAsync(() =>
* {
* var example = DigitalOcean.GetContainerRegistry.Invoke(new()
* {
* Name = "example",
* });
* var exampleContainerRegistryDockerCredentials = new DigitalOcean.ContainerRegistryDockerCredentials("example", new()
* {
* RegistryName = "example",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := digitalocean.LookupContainerRegistry(ctx, &digitalocean.LookupContainerRegistryArgs{
* Name: "example",
* }, nil)
* if err != nil {
* return err
* }
* _, err = digitalocean.NewContainerRegistryDockerCredentials(ctx, "example", &digitalocean.ContainerRegistryDockerCredentialsArgs{
* RegistryName: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.digitalocean.DigitaloceanFunctions;
* import com.pulumi.digitalocean.inputs.GetContainerRegistryArgs;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentials;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentialsArgs;
* 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) {
* final var example = DigitaloceanFunctions.getContainerRegistry(GetContainerRegistryArgs.builder()
* .name("example")
* .build());
* var exampleContainerRegistryDockerCredentials = new ContainerRegistryDockerCredentials("exampleContainerRegistryDockerCredentials", ContainerRegistryDockerCredentialsArgs.builder()
* .registryName("example")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleContainerRegistryDockerCredentials:
* type: digitalocean:ContainerRegistryDockerCredentials
* name: example
* properties:
* registryName: example
* variables:
* example:
* fn::invoke:
* Function: digitalocean:getContainerRegistry
* Arguments:
* name: example
* ```
*
* ### Kubernetes Example
* Combined with the Kubernetes Provider's `kubernetes_secret` 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.core.v1.Secret("example", {
* metadata: {
* name: "docker-cfg",
* },
* data: {
* ".dockerconfigjson": exampleContainerRegistryDockerCredentials.dockerCredentials,
* },
* type: "kubernetes.io/dockerconfigjson",
* });
* ```
* ```python
* import pulumi
* import pulumi_digitalocean as digitalocean
* import pulumi_kubernetes as kubernetes
* example_container_registry_docker_credentials = digitalocean.ContainerRegistryDockerCredentials("example", registry_name="example")
* example = digitalocean.get_kubernetes_cluster(name="prod-cluster-01")
* example_secret = kubernetes.core.v1.Secret("example",
* metadata={
* "name": "docker-cfg",
* },
* data={
* ".dockerconfigjson": example_container_registry_docker_credentials.docker_credentials,
* },
* type="kubernetes.io/dockerconfigjson")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using DigitalOcean = Pulumi.DigitalOcean;
* using Kubernetes = Pulumi.Kubernetes;
* return await Deployment.RunAsync(() =>
* {
* var exampleContainerRegistryDockerCredentials = new DigitalOcean.ContainerRegistryDockerCredentials("example", new()
* {
* RegistryName = "example",
* });
* var example = DigitalOcean.GetKubernetesCluster.Invoke(new()
* {
* Name = "prod-cluster-01",
* });
* var exampleSecret = new Kubernetes.Core.V1.Secret("example", new()
* {
* Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
* {
* Name = "docker-cfg",
* },
* Data =
* {
* { ".dockerconfigjson", exampleContainerRegistryDockerCredentials.DockerCredentials },
* },
* Type = "kubernetes.io/dockerconfigjson",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
* corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
* metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* exampleContainerRegistryDockerCredentials, err := digitalocean.NewContainerRegistryDockerCredentials(ctx, "example", &digitalocean.ContainerRegistryDockerCredentialsArgs{
* RegistryName: pulumi.String("example"),
* })
* if err != nil {
* return err
* }
* _, err = digitalocean.LookupKubernetesCluster(ctx, &digitalocean.LookupKubernetesClusterArgs{
* Name: "prod-cluster-01",
* }, nil)
* if err != nil {
* return err
* }
* _, err = corev1.NewSecret(ctx, "example", &corev1.SecretArgs{
* Metadata: &metav1.ObjectMetaArgs{
* Name: pulumi.String("docker-cfg"),
* },
* Data: pulumi.StringMap{
* ".dockerconfigjson": exampleContainerRegistryDockerCredentials.DockerCredentials,
* },
* Type: pulumi.String("kubernetes.io/dockerconfigjson"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentials;
* import com.pulumi.digitalocean.ContainerRegistryDockerCredentialsArgs;
* import com.pulumi.digitalocean.DigitaloceanFunctions;
* import com.pulumi.digitalocean.inputs.GetKubernetesClusterArgs;
* import com.pulumi.kubernetes.core_v1.Secret;
* import com.pulumi.kubernetes.core_v1.SecretArgs;
* import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
* 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 exampleContainerRegistryDockerCredentials = new ContainerRegistryDockerCredentials("exampleContainerRegistryDockerCredentials", ContainerRegistryDockerCredentialsArgs.builder()
* .registryName("example")
* .build());
* final var example = DigitaloceanFunctions.getKubernetesCluster(GetKubernetesClusterArgs.builder()
* .name("prod-cluster-01")
* .build());
* var exampleSecret = new Secret("exampleSecret", SecretArgs.builder()
* .metadata(ObjectMetaArgs.builder()
* .name("docker-cfg")
* .build())
* .data(Map.of(".dockerconfigjson", exampleContainerRegistryDockerCredentials.dockerCredentials()))
* .type("kubernetes.io/dockerconfigjson")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* exampleContainerRegistryDockerCredentials:
* type: digitalocean:ContainerRegistryDockerCredentials
* name: example
* properties:
* registryName: example
* exampleSecret:
* type: kubernetes:core/v1:Secret
* name: example
* properties:
* metadata:
* name: docker-cfg
* data:
* .dockerconfigjson: ${exampleContainerRegistryDockerCredentials.dockerCredentials}
* type: kubernetes.io/dockerconfigjson
* variables:
* example:
* fn::invoke:
* Function: digitalocean:getKubernetesCluster
* Arguments:
* name: prod-cluster-01
* ```
*
*/
public class ContainerRegistryDockerCredentials internal constructor(
override val javaResource: com.pulumi.digitalocean.ContainerRegistryDockerCredentials,
) : KotlinCustomResource(javaResource, ContainerRegistryDockerCredentialsMapper) {
/**
* The date and time the registry access token will expire.
*/
public val credentialExpirationTime: Output
get() = javaResource.credentialExpirationTime().applyValue({ args0 -> args0 })
/**
* Credentials for the container registry.
*/
public val dockerCredentials: Output
get() = javaResource.dockerCredentials().applyValue({ args0 -> args0 })
/**
* The amount of time to pass before the Docker credentials expire in seconds. Defaults to 1576800000, or roughly 50 years. Must be greater than 0 and less than 1576800000.
*/
public val expirySeconds: Output?
get() = javaResource.expirySeconds().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the container registry.
*/
public val registryName: Output
get() = javaResource.registryName().applyValue({ args0 -> args0 })
/**
* Allow for write access to the container registry. Defaults to false.
*/
public val write: Output?
get() = javaResource.write().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object ContainerRegistryDockerCredentialsMapper :
ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.digitalocean.ContainerRegistryDockerCredentials::class == javaResource::class
override fun map(javaResource: Resource): ContainerRegistryDockerCredentials =
ContainerRegistryDockerCredentials(
javaResource as
com.pulumi.digitalocean.ContainerRegistryDockerCredentials,
)
}
/**
* @see [ContainerRegistryDockerCredentials].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ContainerRegistryDockerCredentials].
*/
public suspend fun containerRegistryDockerCredentials(
name: String,
block: suspend ContainerRegistryDockerCredentialsResourceBuilder.() -> Unit,
): ContainerRegistryDockerCredentials {
val builder = ContainerRegistryDockerCredentialsResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ContainerRegistryDockerCredentials].
* @param name The _unique_ name of the resulting resource.
*/
public fun containerRegistryDockerCredentials(name: String): ContainerRegistryDockerCredentials {
val builder = ContainerRegistryDockerCredentialsResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy