com.pulumi.gcp.networkconnectivity.kotlin.HubArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.networkconnectivity.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.networkconnectivity.HubArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* The NetworkConnectivity Hub resource
* To get more information about Hub, see:
* * [API documentation](https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest/v1beta/projects.locations.global.hubs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/overview)
* ## Example Usage
* ### Network Connectivity Hub Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const primary = new gcp.networkconnectivity.Hub("primary", {
* name: "basic",
* description: "A sample hub",
* labels: {
* "label-one": "value-one",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* primary = gcp.networkconnectivity.Hub("primary",
* name="basic",
* description="A sample hub",
* labels={
* "label-one": "value-one",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var primary = new Gcp.NetworkConnectivity.Hub("primary", new()
* {
* Name = "basic",
* Description = "A sample hub",
* Labels =
* {
* { "label-one", "value-one" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networkconnectivity"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := networkconnectivity.NewHub(ctx, "primary", &networkconnectivity.HubArgs{
* Name: pulumi.String("basic"),
* Description: pulumi.String("A sample hub"),
* Labels: pulumi.StringMap{
* "label-one": pulumi.String("value-one"),
* },
* })
* 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.networkconnectivity.Hub;
* import com.pulumi.gcp.networkconnectivity.HubArgs;
* 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 primary = new Hub("primary", HubArgs.builder()
* .name("basic")
* .description("A sample hub")
* .labels(Map.of("label-one", "value-one"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* primary:
* type: gcp:networkconnectivity:Hub
* properties:
* name: basic
* description: A sample hub
* labels:
* label-one: value-one
* ```
*
* ### Network Connectivity Hub With Export Psc
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const primary = new gcp.networkconnectivity.Hub("primary", {
* name: "basic",
* description: "A sample hub with Private Service Connect transitivity is enabled",
* exportPsc: true,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* primary = gcp.networkconnectivity.Hub("primary",
* name="basic",
* description="A sample hub with Private Service Connect transitivity is enabled",
* export_psc=True)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var primary = new Gcp.NetworkConnectivity.Hub("primary", new()
* {
* Name = "basic",
* Description = "A sample hub with Private Service Connect transitivity is enabled",
* ExportPsc = true,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networkconnectivity"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := networkconnectivity.NewHub(ctx, "primary", &networkconnectivity.HubArgs{
* Name: pulumi.String("basic"),
* Description: pulumi.String("A sample hub with Private Service Connect transitivity is enabled"),
* ExportPsc: pulumi.Bool(true),
* })
* 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.networkconnectivity.Hub;
* import com.pulumi.gcp.networkconnectivity.HubArgs;
* 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 primary = new Hub("primary", HubArgs.builder()
* .name("basic")
* .description("A sample hub with Private Service Connect transitivity is enabled")
* .exportPsc(true)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* primary:
* type: gcp:networkconnectivity:Hub
* properties:
* name: basic
* description: A sample hub with Private Service Connect transitivity is enabled
* exportPsc: true
* ```
*
* ## Import
* Hub can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/global/hubs/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
* When using the `pulumi import` command, Hub can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:networkconnectivity/hub:Hub default projects/{{project}}/locations/global/hubs/{{name}}
* ```
* ```sh
* $ pulumi import gcp:networkconnectivity/hub:Hub default {{project}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:networkconnectivity/hub:Hub default {{name}}
* ```
* @property description An optional description of the hub.
* @property exportPsc Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.
* @property labels Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
* **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.
* @property name Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`
* - - -
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public data class HubArgs(
public val description: Output? = null,
public val exportPsc: Output? = null,
public val labels: Output>? = null,
public val name: Output? = null,
public val project: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.networkconnectivity.HubArgs =
com.pulumi.gcp.networkconnectivity.HubArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.exportPsc(exportPsc?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.name(name?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [HubArgs].
*/
@PulumiTagMarker
public class HubArgsBuilder internal constructor() {
private var description: Output? = null
private var exportPsc: Output? = null
private var labels: Output>? = null
private var name: Output? = null
private var project: Output? = null
/**
* @param value An optional description of the hub.
*/
@JvmName("ubrjwmbwlxirrqmn")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.
*/
@JvmName("swynvqemgvaawphe")
public suspend fun exportPsc(`value`: Output) {
this.exportPsc = value
}
/**
* @param value Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
* **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.
*/
@JvmName("awmkqndeujgtpudb")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`
* - - -
*/
@JvmName("vcckncvcwysybvgq")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("urabbmgnglngpafw")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value An optional description of the hub.
*/
@JvmName("sncopvprtmaphfof")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.
*/
@JvmName("asfteydavphdulma")
public suspend fun exportPsc(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.exportPsc = mapped
}
/**
* @param value Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
* **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.
*/
@JvmName("nulvnfkkphxsxeuw")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
* **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.
*/
@JvmName("ankukgberxkgjhxd")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`
* - - -
*/
@JvmName("qtosyorhdjhepnxl")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("srewmuswqrltnjhf")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
internal fun build(): HubArgs = HubArgs(
description = description,
exportPsc = exportPsc,
labels = labels,
name = name,
project = project,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy