com.pulumi.kubernetes.yaml.v2.kotlin.ConfigGroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Show all versions of pulumi-kubernetes-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.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.kubernetes.yaml.v2.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs.builder
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* ConfigGroup creates a set of Kubernetes resources from Kubernetes YAML text. The YAML text
* may be supplied using any of the following methods:
* 1. Using a filename or a list of filenames:
* 2. Using a file pattern or a list of file patterns:
* 3. Using a literal string containing YAML, or a list of such strings:
* 4. Any combination of files, patterns, or YAML strings:
* ## Dependency ordering
* Sometimes resources must be applied in a specific order. For example, a namespace resource must be
* created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
* Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigGroup. Pulumi also
* waits for each object to be fully reconciled, unless `skipAwait` is enabled.
* ### Explicit Dependency Ordering
* Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
* The annotation accepts a list of resource references, delimited by commas.
* Note that references to resources outside the ConfigGroup aren't supported.
* **Resource reference**
* A resource reference is a string that uniquely identifies a resource.
* It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
* | Resource Scope | Format |
* | :--------------- | :--------------------------------------------- |
* | namespace-scoped | `/namespaces///` |
* | cluster-scoped | `//` |
* For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
* ### Ordering across ConfigGroups
* The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
* Use it on another resource to make it dependent on the ConfigGroup and to wait for the resources within
* the group to be deployed.
* A best practice is to deploy each application using its own ConfigGroup, especially when that application
* installs custom resource definitions.
* {{% examples %}}
* ## Example Usage
* {{% example %}}
* ### Local File(s)
* ```yaml
* name: example
* runtime: yaml
* resources:
* example:
* type: kubernetes:yaml/v2:ConfigGroup
* properties:
* files:
* - ./manifest.yaml
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* files: ["./manifest.yaml"],
* });
* ```
* ```python
* import pulumi
* from pulumi_kubernetes.yaml.v2 import ConfigGroup
* example = ConfigGroup(
* "example",
* files=["./manifest.yaml"]
* )
* ```
* ```csharp
* using Pulumi;
* using Pulumi.Kubernetes.Types.Inputs.Yaml.V2;
* using Pulumi.Kubernetes.Yaml.V2;
* using System.Collections.Generic;
* return await Deployment.RunAsync(() =>
* {
* var example = new ConfigGroup("example", new ConfigGroupArgs
* {
* Files = new[] { "./manifest.yaml" }
* });
* });
* ```
* ```go
* package main
* import (
* yamlv2 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/yaml/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := yamlv2.NewConfigGroup(ctx, "example", &yamlv2.ConfigGroupArgs{
* Files: pulumi.ToStringArray([]string{"manifest.yaml"}),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package myproject;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroup;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var example = new ConfigGroup("example", ConfigGroupArgs.builder()
* .files("./manifest.yaml")
* .build());
* });
* }
* }
* ```
* {{% /example %}}
* ### Local File Pattern
* ```yaml
* name: example
* runtime: yaml
* resources:
* example:
* type: kubernetes:yaml/v2:ConfigGroup
* properties:
* files:
* - ./manifests/*.yaml
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* files: ["./manifests/*.yaml"],
* });
* ```
* ```python
* import pulumi
* from pulumi_kubernetes.yaml.v2 import ConfigGroup
* example = ConfigGroup(
* "example",
* files=["./manifests/*.yaml"]
* )
* ```
* ```csharp
* using Pulumi;
* using Pulumi.Kubernetes.Types.Inputs.Yaml.V2;
* using Pulumi.Kubernetes.Yaml.V2;
* using System.Collections.Generic;
* return await Deployment.RunAsync(() =>
* {
* var example = new ConfigGroup("example", new ConfigGroupArgs
* {
* Files = new[] { "./manifests/*.yaml" }
* });
* });
* ```
* ```go
* package main
* import (
* yamlv2 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/yaml/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := yamlv2.NewConfigGroup(ctx, "example", &yamlv2.ConfigGroupArgs{
* Files: pulumi.ToStringArray([]string{"./manifests/*.yaml"}),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package myproject;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroup;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var example = new ConfigGroup("example", ConfigGroupArgs.builder()
* .files("./manifests/*.yaml")
* .build());
* });
* }
* }
* ```
* {{% /example %}}
* {{% example %}}
* ### Literal YAML String
* ```yaml
* name: example
* runtime: yaml
* resources:
* example:
* type: kubernetes:yaml/v2:ConfigGroup
* properties:
* yaml: |
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* yaml: `
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* `
* });
* ```
* ```python
* import pulumi
* from pulumi_kubernetes.yaml.v2 import ConfigGroup
* example = ConfigGroup(
* "example",
* yaml="""
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* """
* )
* ```
* ```csharp
* using Pulumi;
* using Pulumi.Kubernetes.Types.Inputs.Yaml.V2;
* using Pulumi.Kubernetes.Yaml.V2;
* using System.Collections.Generic;
* return await Deployment.RunAsync(() =>
* {
* var example = new ConfigGroup("example", new ConfigGroupArgs
* {
* Yaml = @"
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* "
* });
* });
* ```
* ```go
* package main
* import (
* yamlv2 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/yaml/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := yamlv2.NewConfigGroup(ctx, "example", &yamlv2.ConfigGroupArgs{
* Yaml: pulumi.StringPtr(`
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* `),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package myproject;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroup;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var example = new ConfigGroup("example", ConfigGroupArgs.builder()
* .yaml("""
* apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* """
* )
* .build());
* });
* }
* }
* ```
* {{% /example %}}
* {{% example %}}
* ### Literal Object
* ```yaml
* name: example
* runtime: yaml
* resources:
* example:
* type: kubernetes:yaml/v2:ConfigGroup
* properties:
* objs:
* - apiVersion: v1
* kind: ConfigMap
* metadata:
* name: my-map
* ```
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as k8s from "@pulumi/kubernetes";
* const example = new k8s.yaml.v2.ConfigGroup("example", {
* objs: [
* {
* apiVersion: "v1",
* kind: "ConfigMap",
* metadata: {
* name: "my-map"
* }
* }
* ]
* });
* ```
* ```python
* import pulumi
* from pulumi_kubernetes.yaml.v2 import ConfigGroup
* example = ConfigGroup(
* "example",
* objs=[
* {
* "apiVersion": "v1",
* "kind": "ConfigMap",
* "metadata": {
* "name": "my-map",
* },
* }
* ]
* )
* ```
* ```csharp
* using Pulumi;
* using Pulumi.Kubernetes.Types.Inputs.Yaml.V2;
* using Pulumi.Kubernetes.Yaml.V2;
* using System.Collections.Generic;
* return await Deployment.RunAsync(() =>
* {
* var example = new ConfigGroup("example", new ConfigGroupArgs
* {
* Objs = new[]
* {
* new Dictionary
* {
* ["apiVersion"] = "v1",
* ["kind"] = "ConfigMap",
* ["metadata"] = new Dictionary
* {
* ["name"] = "my-map",
* },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* yamlv2 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/yaml/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := yamlv2.NewConfigGroup(ctx, "example", &yamlv2.ConfigGroupArgs{
* Objs: pulumi.Array{
* pulumi.Map{
* "apiVersion": pulumi.String("v1"),
* "kind": pulumi.String("ConfigMap"),
* "metadata": pulumi.Map{
* "name": pulumi.String("my-map"),
* },
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package myproject;
* import java.util.Map;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroup;
* import com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var example = new ConfigGroup("example", ConfigGroupArgs.builder()
* .objs(Map.ofEntries(
* Map.entry("apiVersion", "v1"),
* Map.entry("kind", "ConfigMap"),
* Map.entry("metadata", Map.ofEntries(
* Map.entry("name", "my-map")
* ))
* ))
* .build());
* });
* }
* }
* ```
* {{% /example %}}
* {% /examples %}}
* @property files Set of paths and/or URLs to Kubernetes manifest files. Supports glob patterns.
* @property objs Objects representing Kubernetes resource configurations.
* @property resourcePrefix A prefix for the auto-generated resource names. Defaults to the name of the ConfigGroup. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo-resourceName".
* @property skipAwait Indicates that child resources should skip the await logic.
* @property yaml A Kubernetes YAML manifest containing Kubernetes resource configuration(s).
* */*/*/*/*/*/
*/
public data class ConfigGroupArgs(
public val files: Output>? = null,
public val objs: Output>? = null,
public val resourcePrefix: Output? = null,
public val skipAwait: Output? = null,
public val yaml: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs =
com.pulumi.kubernetes.yaml.v2.ConfigGroupArgs.builder()
.files(files?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.objs(objs?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.resourcePrefix(resourcePrefix?.applyValue({ args0 -> args0 }))
.skipAwait(skipAwait?.applyValue({ args0 -> args0 }))
.yaml(yaml?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ConfigGroupArgs].
*/
@PulumiTagMarker
public class ConfigGroupArgsBuilder internal constructor() {
private var files: Output>? = null
private var objs: Output>? = null
private var resourcePrefix: Output? = null
private var skipAwait: Output? = null
private var yaml: Output? = null
/**
* @param value Set of paths and/or URLs to Kubernetes manifest files. Supports glob patterns.
*/
@JvmName("kaufmogvtvjphowl")
public suspend fun files(`value`: Output>) {
this.files = value
}
@JvmName("jqrnqbmborxucmgl")
public suspend fun files(vararg values: Output) {
this.files = Output.all(values.asList())
}
/**
* @param values Set of paths and/or URLs to Kubernetes manifest files. Supports glob patterns.
*/
@JvmName("rbkfhniljcurxkwy")
public suspend fun files(values: List>) {
this.files = Output.all(values)
}
/**
* @param value Objects representing Kubernetes resource configurations.
*/
@JvmName("xyblwfkimrafhidb")
public suspend fun objs(`value`: Output>) {
this.objs = value
}
@JvmName("fmdwusjotcwglvtm")
public suspend fun objs(vararg values: Output) {
this.objs = Output.all(values.asList())
}
/**
* @param values Objects representing Kubernetes resource configurations.
*/
@JvmName("fkagthlusfcsmvbj")
public suspend fun objs(values: List>) {
this.objs = Output.all(values)
}
/**
* @param value A prefix for the auto-generated resource names. Defaults to the name of the ConfigGroup. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo-resourceName".
*/
@JvmName("stalsdqhvjbaegro")
public suspend fun resourcePrefix(`value`: Output) {
this.resourcePrefix = value
}
/**
* @param value Indicates that child resources should skip the await logic.
*/
@JvmName("uigjqxotgntpasrm")
public suspend fun skipAwait(`value`: Output) {
this.skipAwait = value
}
/**
* @param value A Kubernetes YAML manifest containing Kubernetes resource configuration(s).
*/
@JvmName("diwfbqjxjqtwpvlu")
public suspend fun yaml(`value`: Output) {
this.yaml = value
}
/**
* @param value Set of paths and/or URLs to Kubernetes manifest files. Supports glob patterns.
*/
@JvmName("nxwdoijsrtjgfsuf")
public suspend fun files(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.files = mapped
}
/**
* @param values Set of paths and/or URLs to Kubernetes manifest files. Supports glob patterns.
*/
@JvmName("twfvuicleuukkciq")
public suspend fun files(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.files = mapped
}
/**
* @param value Objects representing Kubernetes resource configurations.
*/
@JvmName("visfaohwrhsebvmq")
public suspend fun objs(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.objs = mapped
}
/**
* @param values Objects representing Kubernetes resource configurations.
*/
@JvmName("oihykxrlokgqhtmh")
public suspend fun objs(vararg values: Any) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.objs = mapped
}
/**
* @param value A prefix for the auto-generated resource names. Defaults to the name of the ConfigGroup. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo-resourceName".
*/
@JvmName("vywdkpwkvxfiyskg")
public suspend fun resourcePrefix(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourcePrefix = mapped
}
/**
* @param value Indicates that child resources should skip the await logic.
*/
@JvmName("jnxxriuqfsgcqarx")
public suspend fun skipAwait(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skipAwait = mapped
}
/**
* @param value A Kubernetes YAML manifest containing Kubernetes resource configuration(s).
*/
@JvmName("okwduwlrqjpordgg")
public suspend fun yaml(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.yaml = mapped
}
internal fun build(): ConfigGroupArgs = ConfigGroupArgs(
files = files,
objs = objs,
resourcePrefix = resourcePrefix,
skipAwait = skipAwait,
yaml = yaml,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy