com.pulumi.cloudflare.kotlin.WebAnalyticsRule.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
/**
* Builder for [WebAnalyticsRule].
*/
@PulumiTagMarker
public class WebAnalyticsRuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: WebAnalyticsRuleArgs = WebAnalyticsRuleArgs()
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 WebAnalyticsRuleArgsBuilder.() -> Unit) {
val builder = WebAnalyticsRuleArgsBuilder()
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(): WebAnalyticsRule {
val builtJavaResource = com.pulumi.cloudflare.WebAnalyticsRule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return WebAnalyticsRule(builtJavaResource)
}
}
/**
* Provides a Cloudflare Web Analytics Rule resource.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.WebAnalyticsSite("example", {
* accountId: "f037e56e89293a057740de681ac9abbe",
* zoneTag: "0da42c8d2132a9ddaf714f9e7c920711",
* autoInstall: true,
* });
* const exampleWebAnalyticsRule = new cloudflare.WebAnalyticsRule("example", {
* accountId: "f037e56e89293a057740de681ac9abbe",
* rulesetId: example.rulesetId,
* host: "*",
* paths: ["/excluded"],
* inclusive: false,
* isPaused: false,
* }, {
* dependsOn: [example],
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.WebAnalyticsSite("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* zone_tag="0da42c8d2132a9ddaf714f9e7c920711",
* auto_install=True)
* example_web_analytics_rule = cloudflare.WebAnalyticsRule("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* ruleset_id=example.ruleset_id,
* host="*",
* paths=["/excluded"],
* inclusive=False,
* is_paused=False,
* opts = pulumi.ResourceOptions(depends_on=[example]))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.WebAnalyticsSite("example", new()
* {
* AccountId = "f037e56e89293a057740de681ac9abbe",
* ZoneTag = "0da42c8d2132a9ddaf714f9e7c920711",
* AutoInstall = true,
* });
* var exampleWebAnalyticsRule = new Cloudflare.WebAnalyticsRule("example", new()
* {
* AccountId = "f037e56e89293a057740de681ac9abbe",
* RulesetId = example.RulesetId,
* Host = "*",
* Paths = new[]
* {
* "/excluded",
* },
* Inclusive = false,
* IsPaused = false,
* }, new CustomResourceOptions
* {
* DependsOn =
* {
* example,
* },
* });
* });
* ```
* ```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 {
* example, err := cloudflare.NewWebAnalyticsSite(ctx, "example", &cloudflare.WebAnalyticsSiteArgs{
* AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
* ZoneTag: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
* AutoInstall: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* _, err = cloudflare.NewWebAnalyticsRule(ctx, "example", &cloudflare.WebAnalyticsRuleArgs{
* AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
* RulesetId: example.RulesetId,
* Host: pulumi.String("*"),
* Paths: pulumi.StringArray{
* pulumi.String("/excluded"),
* },
* Inclusive: pulumi.Bool(false),
* IsPaused: pulumi.Bool(false),
* }, pulumi.DependsOn([]pulumi.Resource{
* example,
* }))
* 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.WebAnalyticsSite;
* import com.pulumi.cloudflare.WebAnalyticsSiteArgs;
* import com.pulumi.cloudflare.WebAnalyticsRule;
* import com.pulumi.cloudflare.WebAnalyticsRuleArgs;
* import com.pulumi.resources.CustomResourceOptions;
* 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 WebAnalyticsSite("example", WebAnalyticsSiteArgs.builder()
* .accountId("f037e56e89293a057740de681ac9abbe")
* .zoneTag("0da42c8d2132a9ddaf714f9e7c920711")
* .autoInstall(true)
* .build());
* var exampleWebAnalyticsRule = new WebAnalyticsRule("exampleWebAnalyticsRule", WebAnalyticsRuleArgs.builder()
* .accountId("f037e56e89293a057740de681ac9abbe")
* .rulesetId(example.rulesetId())
* .host("*")
* .paths("/excluded")
* .inclusive(false)
* .isPaused(false)
* .build(), CustomResourceOptions.builder()
* .dependsOn(example)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:WebAnalyticsSite
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* zoneTag: 0da42c8d2132a9ddaf714f9e7c920711
* autoInstall: true
* exampleWebAnalyticsRule:
* type: cloudflare:WebAnalyticsRule
* name: example
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* rulesetId: ${example.rulesetId}
* host: '*'
* paths:
* - /excluded
* inclusive: false
* isPaused: false
* options:
* dependson:
* - ${example}
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/webAnalyticsRule:WebAnalyticsRule example //
* ```
*/
public class WebAnalyticsRule internal constructor(
override val javaResource: com.pulumi.cloudflare.WebAnalyticsRule,
) : KotlinCustomResource(javaResource, WebAnalyticsRuleMapper) {
/**
* The account identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
public val accountId: Output
get() = javaResource.accountId().applyValue({ args0 -> args0 })
/**
* The host to apply the rule to.
*/
public val host: Output
get() = javaResource.host().applyValue({ args0 -> args0 })
/**
* Whether the rule includes or excludes the matched traffic from being measured in Web Analytics.
*/
public val inclusive: Output
get() = javaResource.inclusive().applyValue({ args0 -> args0 })
/**
* Whether the rule is paused or not.
*/
public val isPaused: Output
get() = javaResource.isPaused().applyValue({ args0 -> args0 })
/**
* A list of paths to apply the rule to.
*/
public val paths: Output>
get() = javaResource.paths().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* The Web Analytics ruleset id. **Modifying this attribute will force creation of a new resource.**
*/
public val rulesetId: Output
get() = javaResource.rulesetId().applyValue({ args0 -> args0 })
}
public object WebAnalyticsRuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.WebAnalyticsRule::class == javaResource::class
override fun map(javaResource: Resource): WebAnalyticsRule = WebAnalyticsRule(
javaResource as
com.pulumi.cloudflare.WebAnalyticsRule,
)
}
/**
* @see [WebAnalyticsRule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [WebAnalyticsRule].
*/
public suspend fun webAnalyticsRule(
name: String,
block: suspend WebAnalyticsRuleResourceBuilder.() -> Unit,
): WebAnalyticsRule {
val builder = WebAnalyticsRuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [WebAnalyticsRule].
* @param name The _unique_ name of the resulting resource.
*/
public fun webAnalyticsRule(name: String): WebAnalyticsRule {
val builder = WebAnalyticsRuleResourceBuilder()
builder.name(name)
return builder.build()
}