com.pulumi.gcp.gkehub.kotlin.Scope.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-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.gcp.gkehub.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.gkehub.kotlin.outputs.ScopeState
import com.pulumi.gcp.gkehub.kotlin.outputs.ScopeState.Companion.toKotlin
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [Scope].
*/
@PulumiTagMarker
public class ScopeResourceBuilder internal constructor() {
public var name: String? = null
public var args: ScopeArgs = ScopeArgs()
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 ScopeArgsBuilder.() -> Unit) {
val builder = ScopeArgsBuilder()
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(): Scope {
val builtJavaResource = com.pulumi.gcp.gkehub.Scope(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Scope(builtJavaResource)
}
}
/**
* Scope represents a Scope in a Fleet.
* To get more information about Scope, see:
* * [API documentation](https://cloud.google.com/anthos/fleet-management/docs/reference/rest/v1/projects.locations.scopes)
* * How-to Guides
* * [Registering a Cluster](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
* ## Example Usage
* ### Gkehub Scope Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const scope = new gcp.gkehub.Scope("scope", {
* scopeId: "my-scope",
* namespaceLabels: {
* keyb: "valueb",
* keya: "valuea",
* keyc: "valuec",
* },
* labels: {
* keyb: "valueb",
* keya: "valuea",
* keyc: "valuec",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* scope = gcp.gkehub.Scope("scope",
* scope_id="my-scope",
* namespace_labels={
* "keyb": "valueb",
* "keya": "valuea",
* "keyc": "valuec",
* },
* labels={
* "keyb": "valueb",
* "keya": "valuea",
* "keyc": "valuec",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var scope = new Gcp.GkeHub.Scope("scope", new()
* {
* ScopeId = "my-scope",
* NamespaceLabels =
* {
* { "keyb", "valueb" },
* { "keya", "valuea" },
* { "keyc", "valuec" },
* },
* Labels =
* {
* { "keyb", "valueb" },
* { "keya", "valuea" },
* { "keyc", "valuec" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/gkehub"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := gkehub.NewScope(ctx, "scope", &gkehub.ScopeArgs{
* ScopeId: pulumi.String("my-scope"),
* NamespaceLabels: pulumi.StringMap{
* "keyb": pulumi.String("valueb"),
* "keya": pulumi.String("valuea"),
* "keyc": pulumi.String("valuec"),
* },
* Labels: pulumi.StringMap{
* "keyb": pulumi.String("valueb"),
* "keya": pulumi.String("valuea"),
* "keyc": pulumi.String("valuec"),
* },
* })
* 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.gcp.gkehub.Scope;
* import com.pulumi.gcp.gkehub.ScopeArgs;
* 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 scope = new Scope("scope", ScopeArgs.builder()
* .scopeId("my-scope")
* .namespaceLabels(Map.ofEntries(
* Map.entry("keyb", "valueb"),
* Map.entry("keya", "valuea"),
* Map.entry("keyc", "valuec")
* ))
* .labels(Map.ofEntries(
* Map.entry("keyb", "valueb"),
* Map.entry("keya", "valuea"),
* Map.entry("keyc", "valuec")
* ))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* scope:
* type: gcp:gkehub:Scope
* properties:
* scopeId: my-scope
* namespaceLabels:
* keyb: valueb
* keya: valuea
* keyc: valuec
* labels:
* keyb: valueb
* keya: valuea
* keyc: valuec
* ```
*
* ## Import
* Scope can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/global/scopes/{{scope_id}}`
* * `{{project}}/{{scope_id}}`
* * `{{scope_id}}`
* When using the `pulumi import` command, Scope can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:gkehub/scope:Scope default projects/{{project}}/locations/global/scopes/{{scope_id}}
* ```
* ```sh
* $ pulumi import gcp:gkehub/scope:Scope default {{project}}/{{scope_id}}
* ```
* ```sh
* $ pulumi import gcp:gkehub/scope:Scope default {{scope_id}}
* ```
*/
public class Scope internal constructor(
override val javaResource: com.pulumi.gcp.gkehub.Scope,
) : KotlinCustomResource(javaResource, ScopeMapper) {
/**
* Time the Scope was created in UTC.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* Time the Scope was deleted in UTC.
*/
public val deleteTime: Output
get() = javaResource.deleteTime().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Labels for this Scope.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The unique identifier of the scope
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Scope-level cluster namespace labels. For the member clusters bound
* to the Scope, these labels are applied to each namespace under the
* Scope. Scope-level labels take precedence over Namespace-level
* labels (`namespace_labels` in the Fleet Namespace resource) if they
* share a key. Keys and values must be Kubernetes-conformant.
*/
public val namespaceLabels: Output>?
get() = javaResource.namespaceLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The client-provided identifier of the scope.
* - - -
*/
public val scopeId: Output
get() = javaResource.scopeId().applyValue({ args0 -> args0 })
/**
* State of the scope resource.
* Structure is documented below.
*/
public val states: Output>
get() = javaResource.states().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
})
})
/**
* Google-generated UUID for this resource.
*/
public val uid: Output
get() = javaResource.uid().applyValue({ args0 -> args0 })
/**
* Time the Scope was updated in UTC.
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}
public object ScopeMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.gkehub.Scope::class == javaResource::class
override fun map(javaResource: Resource): Scope = Scope(
javaResource as
com.pulumi.gcp.gkehub.Scope,
)
}
/**
* @see [Scope].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Scope].
*/
public suspend fun scope(name: String, block: suspend ScopeResourceBuilder.() -> Unit): Scope {
val builder = ScopeResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Scope].
* @param name The _unique_ name of the resulting resource.
*/
public fun scope(name: String): Scope {
val builder = ScopeResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy