com.pulumi.gcp.compute.kotlin.NetworkPeering.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.compute.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.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [NetworkPeering].
*/
@PulumiTagMarker
public class NetworkPeeringResourceBuilder internal constructor() {
public var name: String? = null
public var args: NetworkPeeringArgs = NetworkPeeringArgs()
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 NetworkPeeringArgsBuilder.() -> Unit) {
val builder = NetworkPeeringArgsBuilder()
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(): NetworkPeering {
val builtJavaResource = com.pulumi.gcp.compute.NetworkPeering(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return NetworkPeering(builtJavaResource)
}
}
/**
* Manages a network peering within GCE. For more information see
* [the official documentation](https://cloud.google.com/compute/docs/vpc/vpc-peering)
* and
* [API](https://cloud.google.com/compute/docs/reference/latest/networks).
* > Both networks must create a peering with each other for the peering
* to be functional.
* > Subnets IP ranges across peered VPC networks cannot overlap.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const _default = new gcp.compute.Network("default", {
* name: "foobar",
* autoCreateSubnetworks: false,
* });
* const other = new gcp.compute.Network("other", {
* name: "other",
* autoCreateSubnetworks: false,
* });
* const peering1 = new gcp.compute.NetworkPeering("peering1", {
* name: "peering1",
* network: _default.selfLink,
* peerNetwork: other.selfLink,
* });
* const peering2 = new gcp.compute.NetworkPeering("peering2", {
* name: "peering2",
* network: other.selfLink,
* peerNetwork: _default.selfLink,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* default = gcp.compute.Network("default",
* name="foobar",
* auto_create_subnetworks=False)
* other = gcp.compute.Network("other",
* name="other",
* auto_create_subnetworks=False)
* peering1 = gcp.compute.NetworkPeering("peering1",
* name="peering1",
* network=default.self_link,
* peer_network=other.self_link)
* peering2 = gcp.compute.NetworkPeering("peering2",
* name="peering2",
* network=other.self_link,
* peer_network=default.self_link)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var @default = new Gcp.Compute.Network("default", new()
* {
* Name = "foobar",
* AutoCreateSubnetworks = false,
* });
* var other = new Gcp.Compute.Network("other", new()
* {
* Name = "other",
* AutoCreateSubnetworks = false,
* });
* var peering1 = new Gcp.Compute.NetworkPeering("peering1", new()
* {
* Name = "peering1",
* Network = @default.SelfLink,
* PeerNetwork = other.SelfLink,
* });
* var peering2 = new Gcp.Compute.NetworkPeering("peering2", new()
* {
* Name = "peering2",
* Network = other.SelfLink,
* PeerNetwork = @default.SelfLink,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
* Name: pulumi.String("foobar"),
* AutoCreateSubnetworks: pulumi.Bool(false),
* })
* if err != nil {
* return err
* }
* other, err := compute.NewNetwork(ctx, "other", &compute.NetworkArgs{
* Name: pulumi.String("other"),
* AutoCreateSubnetworks: pulumi.Bool(false),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewNetworkPeering(ctx, "peering1", &compute.NetworkPeeringArgs{
* Name: pulumi.String("peering1"),
* Network: _default.SelfLink,
* PeerNetwork: other.SelfLink,
* })
* if err != nil {
* return err
* }
* _, err = compute.NewNetworkPeering(ctx, "peering2", &compute.NetworkPeeringArgs{
* Name: pulumi.String("peering2"),
* Network: other.SelfLink,
* PeerNetwork: _default.SelfLink,
* })
* 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.compute.Network;
* import com.pulumi.gcp.compute.NetworkArgs;
* import com.pulumi.gcp.compute.NetworkPeering;
* import com.pulumi.gcp.compute.NetworkPeeringArgs;
* 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 default_ = new Network("default", NetworkArgs.builder()
* .name("foobar")
* .autoCreateSubnetworks("false")
* .build());
* var other = new Network("other", NetworkArgs.builder()
* .name("other")
* .autoCreateSubnetworks("false")
* .build());
* var peering1 = new NetworkPeering("peering1", NetworkPeeringArgs.builder()
* .name("peering1")
* .network(default_.selfLink())
* .peerNetwork(other.selfLink())
* .build());
* var peering2 = new NetworkPeering("peering2", NetworkPeeringArgs.builder()
* .name("peering2")
* .network(other.selfLink())
* .peerNetwork(default_.selfLink())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* peering1:
* type: gcp:compute:NetworkPeering
* properties:
* name: peering1
* network: ${default.selfLink}
* peerNetwork: ${other.selfLink}
* peering2:
* type: gcp:compute:NetworkPeering
* properties:
* name: peering2
* network: ${other.selfLink}
* peerNetwork: ${default.selfLink}
* default:
* type: gcp:compute:Network
* properties:
* name: foobar
* autoCreateSubnetworks: 'false'
* other:
* type: gcp:compute:Network
* properties:
* name: other
* autoCreateSubnetworks: 'false'
* ```
*
* ## Import
* VPC network peerings can be imported using the name and project of the primary network the peering exists in and the name of the network peering
* * `{{project_id}}/{{network_id}}/{{peering_id}}`
* When using the `pulumi import` command, VPC network peerings can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:compute/networkPeering:NetworkPeering default {{project_id}}/{{network_id}}/{{peering_id}}
* ```
*/
public class NetworkPeering internal constructor(
override val javaResource: com.pulumi.gcp.compute.NetworkPeering,
) : KotlinCustomResource(javaResource, NetworkPeeringMapper) {
/**
* Whether to export the custom routes to the peer network. Defaults to `false`.
*/
public val exportCustomRoutes: Output?
get() = javaResource.exportCustomRoutes().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.
*/
public val exportSubnetRoutesWithPublicIp: Output?
get() = javaResource.exportSubnetRoutesWithPublicIp().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Whether to import the custom routes from the peer network. Defaults to `false`.
*/
public val importCustomRoutes: Output?
get() = javaResource.importCustomRoutes().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field.
*/
public val importSubnetRoutesWithPublicIp: Output?
get() = javaResource.importSubnetRoutesWithPublicIp().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Name of the peering.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The primary network of the peering.
*/
public val network: Output
get() = javaResource.network().applyValue({ args0 -> args0 })
/**
* The peer network in the peering. The peer network
* may belong to a different project.
*/
public val peerNetwork: Output
get() = javaResource.peerNetwork().applyValue({ args0 -> args0 })
/**
* Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY. Possible values: ["IPV4_ONLY", "IPV4_IPV6"].
*/
public val stackType: Output?
get() = javaResource.stackType().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* State for the peering, either `ACTIVE` or `INACTIVE`. The peering is
* `ACTIVE` when there's a matching configuration in the peer network.
*/
public val state: Output
get() = javaResource.state().applyValue({ args0 -> args0 })
/**
* Details about the current state of the peering.
*/
public val stateDetails: Output
get() = javaResource.stateDetails().applyValue({ args0 -> args0 })
}
public object NetworkPeeringMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.compute.NetworkPeering::class == javaResource::class
override fun map(javaResource: Resource): NetworkPeering = NetworkPeering(
javaResource as
com.pulumi.gcp.compute.NetworkPeering,
)
}
/**
* @see [NetworkPeering].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [NetworkPeering].
*/
public suspend fun networkPeering(
name: String,
block: suspend NetworkPeeringResourceBuilder.() -> Unit,
): NetworkPeering {
val builder = NetworkPeeringResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [NetworkPeering].
* @param name The _unique_ name of the resulting resource.
*/
public fun networkPeering(name: String): NetworkPeering {
val builder = NetworkPeeringResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy