com.pulumi.azure.network.kotlin.PublicIpPrefix.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-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.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 [PublicIpPrefix].
*/
@PulumiTagMarker
public class PublicIpPrefixResourceBuilder internal constructor() {
public var name: String? = null
public var args: PublicIpPrefixArgs = PublicIpPrefixArgs()
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 PublicIpPrefixArgsBuilder.() -> Unit) {
val builder = PublicIpPrefixArgsBuilder()
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(): PublicIpPrefix {
val builtJavaResource = com.pulumi.azure.network.PublicIpPrefix(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PublicIpPrefix(builtJavaResource)
}
}
/**
* Manages a Public IP Prefix.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const examplePublicIpPrefix = new azure.network.PublicIpPrefix("example", {
* name: "acceptanceTestPublicIpPrefix1",
* location: example.location,
* resourceGroupName: example.name,
* prefixLength: 31,
* tags: {
* environment: "Production",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_public_ip_prefix = azure.network.PublicIpPrefix("example",
* name="acceptanceTestPublicIpPrefix1",
* location=example.location,
* resource_group_name=example.name,
* prefix_length=31,
* tags={
* "environment": "Production",
* })
* ```
* ```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 = "example-resources",
* Location = "West Europe",
* });
* var examplePublicIpPrefix = new Azure.Network.PublicIpPrefix("example", new()
* {
* Name = "acceptanceTestPublicIpPrefix1",
* Location = example.Location,
* ResourceGroupName = example.Name,
* PrefixLength = 31,
* Tags =
* {
* { "environment", "Production" },
* },
* });
* });
* ```
* ```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("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* _, err = network.NewPublicIpPrefix(ctx, "example", &network.PublicIpPrefixArgs{
* Name: pulumi.String("acceptanceTestPublicIpPrefix1"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* PrefixLength: pulumi.Int(31),
* Tags: pulumi.StringMap{
* "environment": pulumi.String("Production"),
* },
* })
* 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.PublicIpPrefix;
* import com.pulumi.azure.network.PublicIpPrefixArgs;
* 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("example-resources")
* .location("West Europe")
* .build());
* var examplePublicIpPrefix = new PublicIpPrefix("examplePublicIpPrefix", PublicIpPrefixArgs.builder()
* .name("acceptanceTestPublicIpPrefix1")
* .location(example.location())
* .resourceGroupName(example.name())
* .prefixLength(31)
* .tags(Map.of("environment", "Production"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* examplePublicIpPrefix:
* type: azure:network:PublicIpPrefix
* name: example
* properties:
* name: acceptanceTestPublicIpPrefix1
* location: ${example.location}
* resourceGroupName: ${example.name}
* prefixLength: 31
* tags:
* environment: Production
* ```
*
* ## Import
* Public IP Prefixes can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:network/publicIpPrefix:PublicIpPrefix myPublicIpPrefix /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/publicIPPrefixes/myPublicIpPrefix1
* ```
*/
public class PublicIpPrefix internal constructor(
override val javaResource: com.pulumi.azure.network.PublicIpPrefix,
) : KotlinCustomResource(javaResource, PublicIpPrefixMapper) {
/**
* The IP address prefix value that was allocated.
*/
public val ipPrefix: Output
get() = javaResource.ipPrefix().applyValue({ args0 -> args0 })
/**
* The IP Version to use, `IPv6` or `IPv4`. Changing this forces a new resource to be created. Default is `IPv4`.
*/
public val ipVersion: Output?
get() = javaResource.ipVersion().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Public IP Prefix resource . Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to `28`(16 addresses). Changing this forces a new resource to be created.
* > **Please Note:** There may be Public IP address limits on the subscription . [More information available here](https://docs.microsoft.com/azure/azure-subscription-service-limits?toc=%2fazure%2fvirtual-network%2ftoc.json#publicip-address)
*/
public val prefixLength: Output?
get() = javaResource.prefixLength().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the resource group in which to create the Public IP Prefix. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The SKU of the Public IP Prefix. Accepted values are `Standard`. Defaults to `Standard`. Changing this forces a new resource to be created.
* > **Note:** Public IP Prefix can only be created with Standard SKUs at this time.
*/
public val sku: Output?
get() = javaResource.sku().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)
})
/**
* Specifies a list of Availability Zones in which this Public IP Prefix should be located. Changing this forces a new Public IP Prefix to be created.
* > **Please Note:** Availability Zones are [only supported in several regions at this time](https://docs.microsoft.com/azure/availability-zones/az-overview).
*/
public val zones: Output>?
get() = javaResource.zones().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
}
public object PublicIpPrefixMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.network.PublicIpPrefix::class == javaResource::class
override fun map(javaResource: Resource): PublicIpPrefix = PublicIpPrefix(
javaResource as
com.pulumi.azure.network.PublicIpPrefix,
)
}
/**
* @see [PublicIpPrefix].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PublicIpPrefix].
*/
public suspend fun publicIpPrefix(
name: String,
block: suspend PublicIpPrefixResourceBuilder.() -> Unit,
): PublicIpPrefix {
val builder = PublicIpPrefixResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PublicIpPrefix].
* @param name The _unique_ name of the resulting resource.
*/
public fun publicIpPrefix(name: String): PublicIpPrefix {
val builder = PublicIpPrefixResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy