com.pulumi.cloudflare.kotlin.NotificationPolicyWebhooks.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
/**
* Builder for [NotificationPolicyWebhooks].
*/
@PulumiTagMarker
public class NotificationPolicyWebhooksResourceBuilder internal constructor() {
public var name: String? = null
public var args: NotificationPolicyWebhooksArgs = NotificationPolicyWebhooksArgs()
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 NotificationPolicyWebhooksArgsBuilder.() -> Unit) {
val builder = NotificationPolicyWebhooksArgsBuilder()
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(): NotificationPolicyWebhooks {
val builtJavaResource =
com.pulumi.cloudflare.NotificationPolicyWebhooks(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return NotificationPolicyWebhooks(builtJavaResource)
}
}
/**
* Provides a resource, that manages a webhook destination. These destinations can be tied to the notification policies created for Cloudflare's products.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.NotificationPolicyWebhooks("example", {
* accountId: "f037e56e89293a057740de681ac9abbe",
* name: "Webhooks destination",
* url: "https://example.com",
* secret: "my-secret",
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.NotificationPolicyWebhooks("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* name="Webhooks destination",
* url="https://example.com",
* secret="my-secret")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.NotificationPolicyWebhooks("example", new()
* {
* AccountId = "f037e56e89293a057740de681ac9abbe",
* Name = "Webhooks destination",
* Url = "https://example.com",
* Secret = "my-secret",
* });
* });
* ```
* ```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.NewNotificationPolicyWebhooks(ctx, "example", &cloudflare.NotificationPolicyWebhooksArgs{
* AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
* Name: pulumi.String("Webhooks destination"),
* Url: pulumi.String("https://example.com"),
* Secret: pulumi.String("my-secret"),
* })
* 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.NotificationPolicyWebhooks;
* import com.pulumi.cloudflare.NotificationPolicyWebhooksArgs;
* 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 NotificationPolicyWebhooks("example", NotificationPolicyWebhooksArgs.builder()
* .accountId("f037e56e89293a057740de681ac9abbe")
* .name("Webhooks destination")
* .url("https://example.com")
* .secret("my-secret")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:NotificationPolicyWebhooks
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* name: Webhooks destination
* url: https://example.com
* secret: my-secret
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/notificationPolicyWebhooks:NotificationPolicyWebhooks example /
* ```
*/
public class NotificationPolicyWebhooks internal constructor(
override val javaResource: com.pulumi.cloudflare.NotificationPolicyWebhooks,
) : KotlinCustomResource(javaResource, NotificationPolicyWebhooksMapper) {
/**
* The account identifier to target for the resource.
*/
public val accountId: Output
get() = javaResource.accountId().applyValue({ args0 -> args0 })
/**
* Timestamp of when the notification webhook was created.
*/
public val createdAt: Output
get() = javaResource.createdAt().applyValue({ args0 -> args0 })
/**
* Timestamp of when the notification webhook last failed.
*/
public val lastFailure: Output
get() = javaResource.lastFailure().applyValue({ args0 -> args0 })
/**
* Timestamp of when the notification webhook was last successful.
*/
public val lastSuccess: Output
get() = javaResource.lastSuccess().applyValue({ args0 -> args0 })
/**
* The name of the webhook destination.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* An optional secret can be provided that will be passed in the `cf-webhook-auth` header when dispatching a webhook notification. Secrets are not returned in any API response body. Refer to the [documentation](https://api.cloudflare.com/#notification-webhooks-create-webhook) for more details.
*/
public val secret: Output?
get() = javaResource.secret().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* The URL of the webhook destinations. **Modifying this attribute will force creation of a new resource.**
*/
public val url: Output?
get() = javaResource.url().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object NotificationPolicyWebhooksMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.NotificationPolicyWebhooks::class == javaResource::class
override fun map(javaResource: Resource): NotificationPolicyWebhooks =
NotificationPolicyWebhooks(javaResource as com.pulumi.cloudflare.NotificationPolicyWebhooks)
}
/**
* @see [NotificationPolicyWebhooks].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [NotificationPolicyWebhooks].
*/
public suspend fun notificationPolicyWebhooks(
name: String,
block: suspend NotificationPolicyWebhooksResourceBuilder.() -> Unit,
): NotificationPolicyWebhooks {
val builder = NotificationPolicyWebhooksResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [NotificationPolicyWebhooks].
* @param name The _unique_ name of the resulting resource.
*/
public fun notificationPolicyWebhooks(name: String): NotificationPolicyWebhooks {
val builder = NotificationPolicyWebhooksResourceBuilder()
builder.name(name)
return builder.build()
}