com.pulumi.azure.network.kotlin.NatGateway.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.network.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 [NatGateway].
*/
@PulumiTagMarker
public class NatGatewayResourceBuilder internal constructor() {
public var name: String? = null
public var args: NatGatewayArgs = NatGatewayArgs()
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 NatGatewayArgsBuilder.() -> Unit) {
val builder = NatGatewayArgsBuilder()
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(): NatGateway {
val builtJavaResource = com.pulumi.azure.network.NatGateway(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return NatGateway(builtJavaResource)
}
}
/**
* Manages an Azure NAT Gateway.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "nat-gateway-example-rg",
* location: "West Europe",
* });
* const exampleNatGateway = new azure.network.NatGateway("example", {
* name: "nat-Gateway",
* location: example.location,
* resourceGroupName: example.name,
* skuName: "Standard",
* idleTimeoutInMinutes: 10,
* zones: ["1"],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="nat-gateway-example-rg",
* location="West Europe")
* example_nat_gateway = azure.network.NatGateway("example",
* name="nat-Gateway",
* location=example.location,
* resource_group_name=example.name,
* sku_name="Standard",
* idle_timeout_in_minutes=10,
* zones=["1"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "nat-gateway-example-rg",
* Location = "West Europe",
* });
* var exampleNatGateway = new Azure.Network.NatGateway("example", new()
* {
* Name = "nat-Gateway",
* Location = example.Location,
* ResourceGroupName = example.Name,
* SkuName = "Standard",
* IdleTimeoutInMinutes = 10,
* Zones = new[]
* {
* "1",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("nat-gateway-example-rg"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* _, err = network.NewNatGateway(ctx, "example", &network.NatGatewayArgs{
* Name: pulumi.String("nat-Gateway"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* SkuName: pulumi.String("Standard"),
* IdleTimeoutInMinutes: pulumi.Int(10),
* Zones: pulumi.StringArray{
* pulumi.String("1"),
* },
* })
* 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.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.network.NatGateway;
* import com.pulumi.azure.network.NatGatewayArgs;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("nat-gateway-example-rg")
* .location("West Europe")
* .build());
* var exampleNatGateway = new NatGateway("exampleNatGateway", NatGatewayArgs.builder()
* .name("nat-Gateway")
* .location(example.location())
* .resourceGroupName(example.name())
* .skuName("Standard")
* .idleTimeoutInMinutes(10)
* .zones("1")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: nat-gateway-example-rg
* location: West Europe
* exampleNatGateway:
* type: azure:network:NatGateway
* name: example
* properties:
* name: nat-Gateway
* location: ${example.location}
* resourceGroupName: ${example.name}
* skuName: Standard
* idleTimeoutInMinutes: 10
* zones:
* - '1'
* ```
*
* For more complete examples, please see the azure.network.NatGatewayPublicIpAssociation and azure.network.NatGatewayPublicIpPrefixAssociation resources.
* ## Import
* NAT Gateway can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:network/natGateway:NatGateway test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/natGateways/gateway1
* ```
*/
public class NatGateway internal constructor(
override val javaResource: com.pulumi.azure.network.NatGateway,
) : KotlinCustomResource(javaResource, NatGatewayMapper) {
/**
* The idle timeout which should be used in minutes. Defaults to `4`.
*/
public val idleTimeoutInMinutes: Output?
get() = javaResource.idleTimeoutInMinutes().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Specifies the name of the NAT Gateway. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The resource GUID property of the NAT Gateway.
*/
public val resourceGuid: Output
get() = javaResource.resourceGuid().applyValue({ args0 -> args0 })
/**
* The SKU which should be used. At this time the only supported value is `Standard`. Defaults to `Standard`.
*/
public val skuName: Output?
get() = javaResource.skuName().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A mapping of tags to assign to the resource.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A list of Availability Zones in which this NAT Gateway should be located. Changing this forces a new NAT Gateway to be created.
* > **NOTE:** Only one Availability Zone can be defined. For more information, please check out the [Azure documentation](https://learn.microsoft.com/en-us/azure/nat-gateway/nat-overview#availability-zones)
*/
public val zones: Output>?
get() = javaResource.zones().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
}
public object NatGatewayMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.network.NatGateway::class == javaResource::class
override fun map(javaResource: Resource): NatGateway = NatGateway(
javaResource as
com.pulumi.azure.network.NatGateway,
)
}
/**
* @see [NatGateway].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [NatGateway].
*/
public suspend fun natGateway(name: String, block: suspend NatGatewayResourceBuilder.() -> Unit):
NatGateway {
val builder = NatGatewayResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [NatGateway].
* @param name The _unique_ name of the resulting resource.
*/
public fun natGateway(name: String): NatGateway {
val builder = NatGatewayResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy