All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.edgenetwork.kotlin.Subnet.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.edgenetwork.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
import kotlin.collections.List
import kotlin.collections.Map

/**
 * Builder for [Subnet].
 */
@PulumiTagMarker
public class SubnetResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: SubnetArgs = SubnetArgs()

    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 SubnetArgsBuilder.() -> Unit) {
        val builder = SubnetArgsBuilder()
        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(): Subnet {
        val builtJavaResource = com.pulumi.gcp.edgenetwork.Subnet(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Subnet(builtJavaResource)
    }
}

/**
 * A Distributed Cloud Edge subnet, which provides L2 isolation within a network.
 * To get more information about Subnet, see:
 * * [API documentation](https://cloud.google.com/distributed-cloud/edge/latest/docs/reference/network/rest/v1/projects.locations.zones.subnets)
 * * How-to Guides
 *     * [Create and manage subnetworks](https://cloud.google.com/distributed-cloud/edge/latest/docs/subnetworks#api)
 * ## Example Usage
 * ### Edgenetwork Subnet
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const exampleNetwork = new gcp.edgenetwork.Network("example_network", {
 *     networkId: "example-network",
 *     location: "us-west1",
 *     zone: "",
 *     description: "Example network.",
 *     mtu: 9000,
 * });
 * const exampleSubnet = new gcp.edgenetwork.Subnet("example_subnet", {
 *     subnetId: "example-subnet",
 *     location: "us-west1",
 *     zone: "",
 *     description: "Example subnet.",
 *     network: exampleNetwork.id,
 *     ipv4Cidrs: ["4.4.4.1/24"],
 *     labels: {
 *         environment: "dev",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * example_network = gcp.edgenetwork.Network("example_network",
 *     network_id="example-network",
 *     location="us-west1",
 *     zone="",
 *     description="Example network.",
 *     mtu=9000)
 * example_subnet = gcp.edgenetwork.Subnet("example_subnet",
 *     subnet_id="example-subnet",
 *     location="us-west1",
 *     zone="",
 *     description="Example subnet.",
 *     network=example_network.id,
 *     ipv4_cidrs=["4.4.4.1/24"],
 *     labels={
 *         "environment": "dev",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var exampleNetwork = new Gcp.EdgeNetwork.Network("example_network", new()
 *     {
 *         NetworkId = "example-network",
 *         Location = "us-west1",
 *         Zone = "",
 *         Description = "Example network.",
 *         Mtu = 9000,
 *     });
 *     var exampleSubnet = new Gcp.EdgeNetwork.Subnet("example_subnet", new()
 *     {
 *         SubnetId = "example-subnet",
 *         Location = "us-west1",
 *         Zone = "",
 *         Description = "Example subnet.",
 *         Network = exampleNetwork.Id,
 *         Ipv4Cidrs = new[]
 *         {
 *             "4.4.4.1/24",
 *         },
 *         Labels =
 *         {
 *             { "environment", "dev" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/edgenetwork"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		exampleNetwork, err := edgenetwork.NewNetwork(ctx, "example_network", &edgenetwork.NetworkArgs{
 * 			NetworkId:   pulumi.String("example-network"),
 * 			Location:    pulumi.String("us-west1"),
 * 			Zone:        pulumi.String(""),
 * 			Description: pulumi.String("Example network."),
 * 			Mtu:         pulumi.Int(9000),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = edgenetwork.NewSubnet(ctx, "example_subnet", &edgenetwork.SubnetArgs{
 * 			SubnetId:    pulumi.String("example-subnet"),
 * 			Location:    pulumi.String("us-west1"),
 * 			Zone:        pulumi.String(""),
 * 			Description: pulumi.String("Example subnet."),
 * 			Network:     exampleNetwork.ID(),
 * 			Ipv4Cidrs: pulumi.StringArray{
 * 				pulumi.String("4.4.4.1/24"),
 * 			},
 * 			Labels: pulumi.StringMap{
 * 				"environment": pulumi.String("dev"),
 * 			},
 * 		})
 * 		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.edgenetwork.Network;
 * import com.pulumi.gcp.edgenetwork.NetworkArgs;
 * import com.pulumi.gcp.edgenetwork.Subnet;
 * import com.pulumi.gcp.edgenetwork.SubnetArgs;
 * 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 exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
 *             .networkId("example-network")
 *             .location("us-west1")
 *             .zone("")
 *             .description("Example network.")
 *             .mtu(9000)
 *             .build());
 *         var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
 *             .subnetId("example-subnet")
 *             .location("us-west1")
 *             .zone("")
 *             .description("Example subnet.")
 *             .network(exampleNetwork.id())
 *             .ipv4Cidrs("4.4.4.1/24")
 *             .labels(Map.of("environment", "dev"))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   exampleSubnet:
 *     type: gcp:edgenetwork:Subnet
 *     name: example_subnet
 *     properties:
 *       subnetId: example-subnet
 *       location: us-west1
 *       zone:
 *       description: Example subnet.
 *       network: ${exampleNetwork.id}
 *       ipv4Cidrs:
 *         - 4.4.4.1/24
 *       labels:
 *         environment: dev
 *   exampleNetwork:
 *     type: gcp:edgenetwork:Network
 *     name: example_network
 *     properties:
 *       networkId: example-network
 *       location: us-west1
 *       zone:
 *       description: Example network.
 *       mtu: 9000
 * ```
 * 
 * ### Edgenetwork Subnet With Vlan Id
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const exampleNetwork = new gcp.edgenetwork.Network("example_network", {
 *     networkId: "example-network",
 *     location: "us-west1",
 *     zone: "",
 *     description: "Example network.",
 *     mtu: 9000,
 * });
 * const exampleSubnetWithVlanId = new gcp.edgenetwork.Subnet("example_subnet_with_vlan_id", {
 *     subnetId: "example-subnet-with-vlan-id",
 *     location: "us-west1",
 *     zone: "",
 *     description: "Example subnet with VLAN ID.",
 *     network: exampleNetwork.id,
 *     ipv6Cidrs: ["4444:4444:4444:4444::1/64"],
 *     vlanId: 44,
 *     labels: {
 *         environment: "dev",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * example_network = gcp.edgenetwork.Network("example_network",
 *     network_id="example-network",
 *     location="us-west1",
 *     zone="",
 *     description="Example network.",
 *     mtu=9000)
 * example_subnet_with_vlan_id = gcp.edgenetwork.Subnet("example_subnet_with_vlan_id",
 *     subnet_id="example-subnet-with-vlan-id",
 *     location="us-west1",
 *     zone="",
 *     description="Example subnet with VLAN ID.",
 *     network=example_network.id,
 *     ipv6_cidrs=["4444:4444:4444:4444::1/64"],
 *     vlan_id=44,
 *     labels={
 *         "environment": "dev",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var exampleNetwork = new Gcp.EdgeNetwork.Network("example_network", new()
 *     {
 *         NetworkId = "example-network",
 *         Location = "us-west1",
 *         Zone = "",
 *         Description = "Example network.",
 *         Mtu = 9000,
 *     });
 *     var exampleSubnetWithVlanId = new Gcp.EdgeNetwork.Subnet("example_subnet_with_vlan_id", new()
 *     {
 *         SubnetId = "example-subnet-with-vlan-id",
 *         Location = "us-west1",
 *         Zone = "",
 *         Description = "Example subnet with VLAN ID.",
 *         Network = exampleNetwork.Id,
 *         Ipv6Cidrs = new[]
 *         {
 *             "4444:4444:4444:4444::1/64",
 *         },
 *         VlanId = 44,
 *         Labels =
 *         {
 *             { "environment", "dev" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/edgenetwork"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		exampleNetwork, err := edgenetwork.NewNetwork(ctx, "example_network", &edgenetwork.NetworkArgs{
 * 			NetworkId:   pulumi.String("example-network"),
 * 			Location:    pulumi.String("us-west1"),
 * 			Zone:        pulumi.String(""),
 * 			Description: pulumi.String("Example network."),
 * 			Mtu:         pulumi.Int(9000),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = edgenetwork.NewSubnet(ctx, "example_subnet_with_vlan_id", &edgenetwork.SubnetArgs{
 * 			SubnetId:    pulumi.String("example-subnet-with-vlan-id"),
 * 			Location:    pulumi.String("us-west1"),
 * 			Zone:        pulumi.String(""),
 * 			Description: pulumi.String("Example subnet with VLAN ID."),
 * 			Network:     exampleNetwork.ID(),
 * 			Ipv6Cidrs: pulumi.StringArray{
 * 				pulumi.String("4444:4444:4444:4444::1/64"),
 * 			},
 * 			VlanId: pulumi.Int(44),
 * 			Labels: pulumi.StringMap{
 * 				"environment": pulumi.String("dev"),
 * 			},
 * 		})
 * 		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.edgenetwork.Network;
 * import com.pulumi.gcp.edgenetwork.NetworkArgs;
 * import com.pulumi.gcp.edgenetwork.Subnet;
 * import com.pulumi.gcp.edgenetwork.SubnetArgs;
 * 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 exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
 *             .networkId("example-network")
 *             .location("us-west1")
 *             .zone("")
 *             .description("Example network.")
 *             .mtu(9000)
 *             .build());
 *         var exampleSubnetWithVlanId = new Subnet("exampleSubnetWithVlanId", SubnetArgs.builder()
 *             .subnetId("example-subnet-with-vlan-id")
 *             .location("us-west1")
 *             .zone("")
 *             .description("Example subnet with VLAN ID.")
 *             .network(exampleNetwork.id())
 *             .ipv6Cidrs("4444:4444:4444:4444::1/64")
 *             .vlanId(44)
 *             .labels(Map.of("environment", "dev"))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   exampleSubnetWithVlanId:
 *     type: gcp:edgenetwork:Subnet
 *     name: example_subnet_with_vlan_id
 *     properties:
 *       subnetId: example-subnet-with-vlan-id
 *       location: us-west1
 *       zone:
 *       description: Example subnet with VLAN ID.
 *       network: ${exampleNetwork.id}
 *       ipv6Cidrs:
 *         - 4444:4444:4444:4444::1/64
 *       vlanId: 44
 *       labels:
 *         environment: dev
 *   exampleNetwork:
 *     type: gcp:edgenetwork:Network
 *     name: example_network
 *     properties:
 *       networkId: example-network
 *       location: us-west1
 *       zone:
 *       description: Example network.
 *       mtu: 9000
 * ```
 * 
 * ## Import
 * Subnet can be imported using any of these accepted formats:
 * * `projects/{{project}}/locations/{{location}}/zones/{{zone}}/subnets/{{subnet_id}}`
 * * `{{project}}/{{location}}/{{zone}}/{{subnet_id}}`
 * * `{{location}}/{{zone}}/{{subnet_id}}`
 * * `{{location}}/{{subnet_id}}`
 * * `{{name}}`
 * When using the `pulumi import` command, Subnet can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:edgenetwork/subnet:Subnet default projects/{{project}}/locations/{{location}}/zones/{{zone}}/subnets/{{subnet_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgenetwork/subnet:Subnet default {{project}}/{{location}}/{{zone}}/{{subnet_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgenetwork/subnet:Subnet default {{location}}/{{zone}}/{{subnet_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgenetwork/subnet:Subnet default {{location}}/{{subnet_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgenetwork/subnet:Subnet default {{name}}
 * ```
 */
public class Subnet internal constructor(
    override val javaResource: com.pulumi.gcp.edgenetwork.Subnet,
) : KotlinCustomResource(javaResource, SubnetMapper) {
    /**
     * The time when the subnet was created.
     * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine
     * fractional digits. Examples: `2014-10-02T15:01:23Z` and `2014-10-02T15:01:23.045123456Z`.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * A free-text description of the resource. Max length 1024 characters.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The ranges of ipv4 addresses that are owned by this subnetwork, in CIDR format.
     */
    public val ipv4Cidrs: Output>?
        get() = javaResource.ipv4Cidrs().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * The ranges of ipv6 addresses that are owned by this subnetwork, in CIDR format.
     */
    public val ipv6Cidrs: Output>?
        get() = javaResource.ipv6Cidrs().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * Labels associated with this 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 Google Cloud region to which the target Distributed Cloud Edge zone belongs.
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * The canonical name of this resource, with format
     * `projects/{{project}}/locations/{{location}}/zones/{{zone}}/subnets/{{subnet_id}}`
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The ID of the network to which this router belongs.
     * Must be of the form: `projects/{{project}}/locations/{{location}}/zones/{{zone}}/networks/{{network_id}}`
     */
    public val network: Output
        get() = javaResource.network().applyValue({ args0 -> args0 })

    /**
     * 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 })

    /**
     * Current stage of the resource to the device by config push.
     */
    public val state: Output
        get() = javaResource.state().applyValue({ args0 -> args0 })

    /**
     * A unique ID that identifies this subnet.
     * - - -
     */
    public val subnetId: Output
        get() = javaResource.subnetId().applyValue({ args0 -> args0 })

    /**
     * The time when the subnet was last updated.
     * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine
     * fractional digits. Examples: `2014-10-02T15:01:23Z` and `2014-10-02T15:01:23.045123456Z`.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })

    /**
     * VLAN ID for this subnetwork. If not specified, one is assigned automatically.
     */
    public val vlanId: Output
        get() = javaResource.vlanId().applyValue({ args0 -> args0 })

    /**
     * The name of the target Distributed Cloud Edge zone.
     */
    public val zone: Output
        get() = javaResource.zone().applyValue({ args0 -> args0 })
}

public object SubnetMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.edgenetwork.Subnet::class == javaResource::class

    override fun map(javaResource: Resource): Subnet = Subnet(
        javaResource as
            com.pulumi.gcp.edgenetwork.Subnet,
    )
}

/**
 * @see [Subnet].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Subnet].
 */
public suspend fun subnet(name: String, block: suspend SubnetResourceBuilder.() -> Unit): Subnet {
    val builder = SubnetResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Subnet].
 * @param name The _unique_ name of the resulting resource.
 */
public fun subnet(name: String): Subnet {
    val builder = SubnetResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy