com.pulumi.cloudflare.kotlin.Zone.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.
@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
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [Zone].
*/
@PulumiTagMarker
public class ZoneResourceBuilder internal constructor() {
public var name: String? = null
public var args: ZoneArgs = ZoneArgs()
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 ZoneArgsBuilder.() -> Unit) {
val builder = ZoneArgsBuilder()
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(): Zone {
val builtJavaResource = com.pulumi.cloudflare.Zone(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Zone(builtJavaResource)
}
}
/**
* Provides a Cloudflare Zone resource. Zone is the basic resource for
* working with Cloudflare and is roughly equivalent to a domain name
* that the user purchases.
* > If you are attempting to sign up a subdomain of a zone you must first have Subdomain Support entitlement for your account.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.Zone("example", {
* accountId: "f037e56e89293a057740de681ac9abbe",
* zone: "example.com",
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.Zone("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* zone="example.com")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.Zone("example", new()
* {
* AccountId = "f037e56e89293a057740de681ac9abbe",
* ZoneName = "example.com",
* });
* });
* ```
* ```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.NewZone(ctx, "example", &cloudflare.ZoneArgs{
* AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
* Zone: pulumi.String("example.com"),
* })
* 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.Zone;
* import com.pulumi.cloudflare.ZoneArgs;
* 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 Zone("example", ZoneArgs.builder()
* .accountId("f037e56e89293a057740de681ac9abbe")
* .zone("example.com")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:Zone
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* zone: example.com
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/zone:Zone example
* ```
*/
public class Zone internal constructor(
override val javaResource: com.pulumi.cloudflare.Zone,
) : KotlinCustomResource(javaResource, ZoneMapper) {
/**
* Account ID to manage the zone resource in.
*/
public val accountId: Output
get() = javaResource.accountId().applyValue({ args0 -> args0 })
/**
* Whether to scan for DNS records on creation. Ignored after zone is created.
*/
public val jumpStart: Output?
get() = javaResource.jumpStart().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
public val meta: Output>
get() = javaResource.meta().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Cloudflare-assigned name servers. This is only populated for zones that use Cloudflare DNS.
*/
public val nameServers: Output>
get() = javaResource.nameServers().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* Whether this zone is paused (traffic bypasses Cloudflare). Defaults to `false`.
*/
public val paused: Output?
get() = javaResource.paused().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name of the commercial plan to apply to the zone. Available values: `free`, `lite`, `pro`, `pro_plus`, `business`, `enterprise`, `partners_free`, `partners_pro`, `partners_business`, `partners_enterprise`.
*/
public val plan: Output
get() = javaResource.plan().applyValue({ args0 -> args0 })
/**
* Status of the zone. Available values: `active`, `pending`, `initializing`, `moved`, `deleted`, `deactivated`.
*/
public val status: Output
get() = javaResource.status().applyValue({ args0 -> args0 })
/**
* A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. Available values: `full`, `partial`, `secondary`. Defaults to `full`.
*/
public val type: Output?
get() = javaResource.type().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* List of Vanity Nameservers (if set).
*/
public val vanityNameServers: Output>
get() = javaResource.vanityNameServers().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* Contains the TXT record value to validate domain ownership. This is only populated for zones of type `partial`.
*/
public val verificationKey: Output
get() = javaResource.verificationKey().applyValue({ args0 -> args0 })
/**
* The DNS zone name which will be added. **Modifying this attribute will force creation of a new resource.**
*/
public val zone: Output
get() = javaResource.zone().applyValue({ args0 -> args0 })
}
public object ZoneMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.Zone::class == javaResource::class
override fun map(javaResource: Resource): Zone = Zone(javaResource as com.pulumi.cloudflare.Zone)
}
/**
* @see [Zone].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Zone].
*/
public suspend fun zone(name: String, block: suspend ZoneResourceBuilder.() -> Unit): Zone {
val builder = ZoneResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Zone].
* @param name The _unique_ name of the resulting resource.
*/
public fun zone(name: String): Zone {
val builder = ZoneResourceBuilder()
builder.name(name)
return builder.build()
}