com.pulumi.cloudflare.kotlin.ByoIpPrefix.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-cloudflare-kotlin Show documentation
Show all versions of pulumi-cloudflare-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.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.cloudflare.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 [ByoIpPrefix].
*/
@PulumiTagMarker
public class ByoIpPrefixResourceBuilder internal constructor() {
public var name: String? = null
public var args: ByoIpPrefixArgs = ByoIpPrefixArgs()
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 ByoIpPrefixArgsBuilder.() -> Unit) {
val builder = ByoIpPrefixArgsBuilder()
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(): ByoIpPrefix {
val builtJavaResource = com.pulumi.cloudflare.ByoIpPrefix(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ByoIpPrefix(builtJavaResource)
}
}
/**
* Provides the ability to manage Bring-Your-Own-IP prefixes (BYOIP)
* which are used with or without Magic Transit.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.ByoIpPrefix("example", {
* accountId: "f037e56e89293a057740de681ac9abbe",
* prefixId: "d41d8cd98f00b204e9800998ecf8427e",
* description: "Example IP Prefix",
* advertisement: "on",
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.ByoIpPrefix("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* prefix_id="d41d8cd98f00b204e9800998ecf8427e",
* description="Example IP Prefix",
* advertisement="on")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.ByoIpPrefix("example", new()
* {
* AccountId = "f037e56e89293a057740de681ac9abbe",
* PrefixId = "d41d8cd98f00b204e9800998ecf8427e",
* Description = "Example IP Prefix",
* Advertisement = "on",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := cloudflare.NewByoIpPrefix(ctx, "example", &cloudflare.ByoIpPrefixArgs{
* AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
* PrefixId: pulumi.String("d41d8cd98f00b204e9800998ecf8427e"),
* Description: pulumi.String("Example IP Prefix"),
* Advertisement: pulumi.String("on"),
* })
* 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.cloudflare.ByoIpPrefix;
* import com.pulumi.cloudflare.ByoIpPrefixArgs;
* 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 ByoIpPrefix("example", ByoIpPrefixArgs.builder()
* .accountId("f037e56e89293a057740de681ac9abbe")
* .prefixId("d41d8cd98f00b204e9800998ecf8427e")
* .description("Example IP Prefix")
* .advertisement("on")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:ByoIpPrefix
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* prefixId: d41d8cd98f00b204e9800998ecf8427e
* description: Example IP Prefix
* advertisement: on
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/byoIpPrefix:ByoIpPrefix example /
* ```
*/
public class ByoIpPrefix internal constructor(
override val javaResource: com.pulumi.cloudflare.ByoIpPrefix,
) : KotlinCustomResource(javaResource, ByoIpPrefixMapper) {
/**
* The account identifier to target for the resource.
*/
public val accountId: Output
get() = javaResource.accountId().applyValue({ args0 -> args0 })
/**
* Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: `on`, `off`.
*/
public val advertisement: Output
get() = javaResource.advertisement().applyValue({ args0 -> args0 })
/**
* Description of the BYO IP prefix.
*/
public val description: Output
get() = javaResource.description().applyValue({ args0 -> args0 })
/**
* The assigned Bring-Your-Own-IP prefix ID. **Modifying this attribute will force creation of a new resource.**
*/
public val prefixId: Output
get() = javaResource.prefixId().applyValue({ args0 -> args0 })
}
public object ByoIpPrefixMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.ByoIpPrefix::class == javaResource::class
override fun map(javaResource: Resource): ByoIpPrefix = ByoIpPrefix(
javaResource as
com.pulumi.cloudflare.ByoIpPrefix,
)
}
/**
* @see [ByoIpPrefix].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ByoIpPrefix].
*/
public suspend fun byoIpPrefix(name: String, block: suspend ByoIpPrefixResourceBuilder.() -> Unit): ByoIpPrefix {
val builder = ByoIpPrefixResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ByoIpPrefix].
* @param name The _unique_ name of the resulting resource.
*/
public fun byoIpPrefix(name: String): ByoIpPrefix {
val builder = ByoIpPrefixResourceBuilder()
builder.name(name)
return builder.build()
}