com.pulumi.cloudflare.kotlin.CustomHostname.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.cloudflare.kotlin.outputs.CustomHostnameSsl
import com.pulumi.cloudflare.kotlin.outputs.CustomHostnameSsl.Companion.toKotlin
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 [CustomHostname].
*/
@PulumiTagMarker
public class CustomHostnameResourceBuilder internal constructor() {
public var name: String? = null
public var args: CustomHostnameArgs = CustomHostnameArgs()
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 CustomHostnameArgsBuilder.() -> Unit) {
val builder = CustomHostnameArgsBuilder()
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(): CustomHostname {
val builtJavaResource = com.pulumi.cloudflare.CustomHostname(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return CustomHostname(builtJavaResource)
}
}
/**
* Provides a Cloudflare custom hostname (also known as SSL for SaaS) resource.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.CustomHostname("example", {
* zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
* hostname: "hostname.example.com",
* ssls: [{
* method: "txt",
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.CustomHostname("example",
* zone_id="0da42c8d2132a9ddaf714f9e7c920711",
* hostname="hostname.example.com",
* ssls=[{
* "method": "txt",
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.CustomHostname("example", new()
* {
* ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
* Hostname = "hostname.example.com",
* Ssls = new[]
* {
* new Cloudflare.Inputs.CustomHostnameSslArgs
* {
* Method = "txt",
* },
* },
* });
* });
* ```
* ```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.NewCustomHostname(ctx, "example", &cloudflare.CustomHostnameArgs{
* ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
* Hostname: pulumi.String("hostname.example.com"),
* Ssls: cloudflare.CustomHostnameSslArray{
* &cloudflare.CustomHostnameSslArgs{
* Method: pulumi.String("txt"),
* },
* },
* })
* 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.CustomHostname;
* import com.pulumi.cloudflare.CustomHostnameArgs;
* import com.pulumi.cloudflare.inputs.CustomHostnameSslArgs;
* 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 CustomHostname("example", CustomHostnameArgs.builder()
* .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
* .hostname("hostname.example.com")
* .ssls(CustomHostnameSslArgs.builder()
* .method("txt")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:CustomHostname
* properties:
* zoneId: 0da42c8d2132a9ddaf714f9e7c920711
* hostname: hostname.example.com
* ssls:
* - method: txt
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/customHostname:CustomHostname example 1d5fdc9e88c8a8c4518b068cd94331fe/0d89c70d-ad9f-4843-b99f-6cc0252067e9
* ```
*/
public class CustomHostname internal constructor(
override val javaResource: com.pulumi.cloudflare.CustomHostname,
) : KotlinCustomResource(javaResource, CustomHostnameMapper) {
/**
* Custom metadata associated with custom hostname. Only supports primitive string values, all other values are accessible via the API directly.
*/
public val customMetadata: Output>?
get() = javaResource.customMetadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* The custom origin server used for certificates.
*/
public val customOriginServer: Output?
get() = javaResource.customOriginServer().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The [custom origin SNI](https://developers.cloudflare.com/ssl/ssl-for-saas/hostname-specific-behavior/custom-origin) used for certificates.
*/
public val customOriginSni: Output?
get() = javaResource.customOriginSni().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Hostname you intend to request a certificate for. **Modifying this attribute will force creation of a new resource.**
*/
public val hostname: Output
get() = javaResource.hostname().applyValue({ args0 -> args0 })
public val ownershipVerification: Output>
get() = javaResource.ownershipVerification().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
public val ownershipVerificationHttp: Output>
get() = javaResource.ownershipVerificationHttp().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* SSL properties used when creating the custom hostname.
*/
public val ssls: Output>?
get() = javaResource.ssls().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> toKotlin(args0) })
})
}).orElse(null)
})
/**
* Status of the certificate.
*/
public val status: Output
get() = javaResource.status().applyValue({ args0 -> args0 })
/**
* Whether to wait for a custom hostname SSL sub-object to reach status `pending_validation` during creation. Defaults to `false`.
*/
public val waitForSslPendingValidation: Output?
get() = javaResource.waitForSslPendingValidation().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
public val zoneId: Output
get() = javaResource.zoneId().applyValue({ args0 -> args0 })
}
public object CustomHostnameMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.CustomHostname::class == javaResource::class
override fun map(javaResource: Resource): CustomHostname = CustomHostname(
javaResource as
com.pulumi.cloudflare.CustomHostname,
)
}
/**
* @see [CustomHostname].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [CustomHostname].
*/
public suspend fun customHostname(
name: String,
block: suspend CustomHostnameResourceBuilder.() -> Unit,
): CustomHostname {
val builder = CustomHostnameResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [CustomHostname].
* @param name The _unique_ name of the resulting resource.
*/
public fun customHostname(name: String): CustomHostname {
val builder = CustomHostnameResourceBuilder()
builder.name(name)
return builder.build()
}