com.pulumi.alicloud.dcdn.kotlin.WafRule.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-alicloud-kotlin Show documentation
Show all versions of pulumi-alicloud-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.alicloud.dcdn.kotlin
import com.pulumi.alicloud.dcdn.kotlin.outputs.WafRuleCondition
import com.pulumi.alicloud.dcdn.kotlin.outputs.WafRuleRateLimit
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 com.pulumi.alicloud.dcdn.kotlin.outputs.WafRuleCondition.Companion.toKotlin as wafRuleConditionToKotlin
import com.pulumi.alicloud.dcdn.kotlin.outputs.WafRuleRateLimit.Companion.toKotlin as wafRuleRateLimitToKotlin
/**
* Builder for [WafRule].
*/
@PulumiTagMarker
public class WafRuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: WafRuleArgs = WafRuleArgs()
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 WafRuleArgsBuilder.() -> Unit) {
val builder = WafRuleArgsBuilder()
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(): WafRule {
val builtJavaResource = com.pulumi.alicloud.dcdn.WafRule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return WafRule(builtJavaResource)
}
}
/**
* Provides a Dcdn Waf Rule resource.
* For information about Dcdn Waf Rule and how to use it, see [What is Waf Rule](https://www.alibabacloud.com/help/en/dcdn/developer-reference/api-dcdn-2018-01-15-batchcreatedcdnwafrules).
* > **NOTE:** Available since v1.201.0.
* ## Example Usage
* Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as alicloud from "@pulumi/alicloud";
* import * as random from "@pulumi/random";
* const config = new pulumi.Config();
* const name = config.get("name") || "tf_example";
* const _default = new random.index.Integer("default", {
* min: 10000,
* max: 99999,
* });
* const example = new alicloud.dcdn.WafPolicy("example", {
* defenseScene: "waf_group",
* policyName: `${name}_${_default.result}`,
* policyType: "custom",
* status: "on",
* });
* const exampleWafRule = new alicloud.dcdn.WafRule("example", {
* policyId: example.id,
* ruleName: name,
* conditions: [
* {
* key: "URI",
* opValue: "ne",
* values: "/login.php",
* },
* {
* key: "Header",
* subKey: "a",
* opValue: "eq",
* values: "b",
* },
* ],
* status: "on",
* action: "monitor",
* rateLimit: {
* target: "IP",
* interval: 5,
* threshold: 5,
* ttl: 1800,
* status: {
* code: "200",
* ratio: 60,
* },
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_alicloud as alicloud
* import pulumi_random as random
* config = pulumi.Config()
* name = config.get("name")
* if name is None:
* name = "tf_example"
* default = random.index.Integer("default",
* min=10000,
* max=99999)
* example = alicloud.dcdn.WafPolicy("example",
* defense_scene="waf_group",
* policy_name=f"{name}_{default['result']}",
* policy_type="custom",
* status="on")
* example_waf_rule = alicloud.dcdn.WafRule("example",
* policy_id=example.id,
* rule_name=name,
* conditions=[
* {
* "key": "URI",
* "op_value": "ne",
* "values": "/login.php",
* },
* {
* "key": "Header",
* "sub_key": "a",
* "op_value": "eq",
* "values": "b",
* },
* ],
* status="on",
* action="monitor",
* rate_limit={
* "target": "IP",
* "interval": 5,
* "threshold": 5,
* "ttl": 1800,
* "status": {
* "code": "200",
* "ratio": 60,
* },
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AliCloud = Pulumi.AliCloud;
* using Random = Pulumi.Random;
* return await Deployment.RunAsync(() =>
* {
* var config = new Config();
* var name = config.Get("name") ?? "tf_example";
* var @default = new Random.Index.Integer("default", new()
* {
* Min = 10000,
* Max = 99999,
* });
* var example = new AliCloud.Dcdn.WafPolicy("example", new()
* {
* DefenseScene = "waf_group",
* PolicyName = $"{name}_{@default.Result}",
* PolicyType = "custom",
* Status = "on",
* });
* var exampleWafRule = new AliCloud.Dcdn.WafRule("example", new()
* {
* PolicyId = example.Id,
* RuleName = name,
* Conditions = new[]
* {
* new AliCloud.Dcdn.Inputs.WafRuleConditionArgs
* {
* Key = "URI",
* OpValue = "ne",
* Values = "/login.php",
* },
* new AliCloud.Dcdn.Inputs.WafRuleConditionArgs
* {
* Key = "Header",
* SubKey = "a",
* OpValue = "eq",
* Values = "b",
* },
* },
* Status = "on",
* Action = "monitor",
* RateLimit = new AliCloud.Dcdn.Inputs.WafRuleRateLimitArgs
* {
* Target = "IP",
* Interval = 5,
* Threshold = 5,
* Ttl = 1800,
* Status = new AliCloud.Dcdn.Inputs.WafRuleRateLimitStatusArgs
* {
* Code = "200",
* Ratio = 60,
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dcdn"
* "github.com/pulumi/pulumi-random/sdk/v4/go/random"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* cfg := config.New(ctx, "")
* name := "tf_example"
* if param := cfg.Get("name"); param != "" {
* name = param
* }
* _, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
* Min: 10000,
* Max: 99999,
* })
* if err != nil {
* return err
* }
* example, err := dcdn.NewWafPolicy(ctx, "example", &dcdn.WafPolicyArgs{
* DefenseScene: pulumi.String("waf_group"),
* PolicyName: pulumi.Sprintf("%v_%v", name, _default.Result),
* PolicyType: pulumi.String("custom"),
* Status: pulumi.String("on"),
* })
* if err != nil {
* return err
* }
* _, err = dcdn.NewWafRule(ctx, "example", &dcdn.WafRuleArgs{
* PolicyId: example.ID(),
* RuleName: pulumi.String(name),
* Conditions: dcdn.WafRuleConditionArray{
* &dcdn.WafRuleConditionArgs{
* Key: pulumi.String("URI"),
* OpValue: pulumi.String("ne"),
* Values: pulumi.String("/login.php"),
* },
* &dcdn.WafRuleConditionArgs{
* Key: pulumi.String("Header"),
* SubKey: pulumi.String("a"),
* OpValue: pulumi.String("eq"),
* Values: pulumi.String("b"),
* },
* },
* Status: pulumi.String("on"),
* Action: pulumi.String("monitor"),
* RateLimit: &dcdn.WafRuleRateLimitArgs{
* Target: pulumi.String("IP"),
* Interval: pulumi.Int(5),
* Threshold: pulumi.Int(5),
* Ttl: pulumi.Int(1800),
* Status: &dcdn.WafRuleRateLimitStatusArgs{
* Code: pulumi.String("200"),
* Ratio: pulumi.Int(60),
* },
* },
* })
* 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.random.integer;
* import com.pulumi.random.IntegerArgs;
* import com.pulumi.alicloud.dcdn.WafPolicy;
* import com.pulumi.alicloud.dcdn.WafPolicyArgs;
* import com.pulumi.alicloud.dcdn.WafRule;
* import com.pulumi.alicloud.dcdn.WafRuleArgs;
* import com.pulumi.alicloud.dcdn.inputs.WafRuleConditionArgs;
* import com.pulumi.alicloud.dcdn.inputs.WafRuleRateLimitArgs;
* import com.pulumi.alicloud.dcdn.inputs.WafRuleRateLimitStatusArgs;
* 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) {
* final var config = ctx.config();
* final var name = config.get("name").orElse("tf_example");
* var default_ = new Integer("default", IntegerArgs.builder()
* .min(10000)
* .max(99999)
* .build());
* var example = new WafPolicy("example", WafPolicyArgs.builder()
* .defenseScene("waf_group")
* .policyName(String.format("%s_%s", name,default_.result()))
* .policyType("custom")
* .status("on")
* .build());
* var exampleWafRule = new WafRule("exampleWafRule", WafRuleArgs.builder()
* .policyId(example.id())
* .ruleName(name)
* .conditions(
* WafRuleConditionArgs.builder()
* .key("URI")
* .opValue("ne")
* .values("/login.php")
* .build(),
* WafRuleConditionArgs.builder()
* .key("Header")
* .subKey("a")
* .opValue("eq")
* .values("b")
* .build())
* .status("on")
* .action("monitor")
* .rateLimit(WafRuleRateLimitArgs.builder()
* .target("IP")
* .interval("5")
* .threshold("5")
* .ttl("1800")
* .status(WafRuleRateLimitStatusArgs.builder()
* .code("200")
* .ratio("60")
* .build())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* configuration:
* name:
* type: string
* default: tf_example
* resources:
* default:
* type: random:integer
* properties:
* min: 10000
* max: 99999
* example:
* type: alicloud:dcdn:WafPolicy
* properties:
* defenseScene: waf_group
* policyName: ${name}_${default.result}
* policyType: custom
* status: on
* exampleWafRule:
* type: alicloud:dcdn:WafRule
* name: example
* properties:
* policyId: ${example.id}
* ruleName: ${name}
* conditions:
* - key: URI
* opValue: ne
* values: /login.php
* - key: Header
* subKey: a
* opValue: eq
* values: b
* status: on
* action: monitor
* rateLimit:
* target: IP
* interval: '5'
* threshold: '5'
* ttl: '1800'
* status:
* code: '200'
* ratio: '60'
* ```
*
* ## Import
* Dcdn Waf Rule can be imported using the id, e.g.
* ```sh
* $ pulumi import alicloud:dcdn/wafRule:WafRule example
* ```
*/
public class WafRule internal constructor(
override val javaResource: com.pulumi.alicloud.dcdn.WafRule,
) : KotlinCustomResource(javaResource, WafRuleMapper) {
/**
* Specifies the action of the rule. Valid values: `block`, `monitor`, `js`.
*/
public val action: Output?
get() = javaResource.action().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies whether to enable rate limiting. Valid values: `on` and `off`. **NOTE:** This parameter is required when policy is of type `custom_acl`.
*/
public val ccStatus: Output
get() = javaResource.ccStatus().applyValue({ args0 -> args0 })
/**
* The blocked regions in the Chinese mainland, separated by commas (,).
*/
public val cnRegionList: Output?
get() = javaResource.cnRegionList().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Conditions that trigger the rule. See `conditions` below. **NOTE:** This parameter is required when policy is of type `custom_acl` or `whitelist`.
*/
public val conditions: Output>?
get() = javaResource.conditions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> wafRuleConditionToKotlin(args0) })
})
}).orElse(null)
})
/**
* The type of protection policy. The following scenarios are supported:-waf_group:Web basic protection-custom_acl: Custom protection policy-whitelist: whitelist
*/
public val defenseScene: Output
get() = javaResource.defenseScene().applyValue({ args0 -> args0 })
/**
* The effective scope of the rate limiting blacklist. If you set ccStatus to on, you must configure this parameter. Valid values: `rule` (takes effect for the current rule) and `service` (takes effect globally).
*/
public val effect: Output?
get() = javaResource.effect().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Revised the time. The date format is based on ISO8601 notation and uses UTC +0 time in the format of yyyy-MM-ddTHH:mm:ssZ.
*/
public val gmtModified: Output
get() = javaResource.gmtModified().applyValue({ args0 -> args0 })
/**
* Blocked regions outside the Chinese mainland, separated by commas (,).
*/
public val otherRegionList: Output?
get() = javaResource.otherRegionList().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The protection policy ID.
*/
public val policyId: Output
get() = javaResource.policyId().applyValue({ args0 -> args0 })
/**
* The rules of rate limiting. If you set `cc_status` to on, you must configure this parameter. See `rate_limit` below.
*/
public val rateLimit: Output?
get() = javaResource.rateLimit().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
wafRuleRateLimitToKotlin(args0)
})
}).orElse(null)
})
/**
* The regular expression.e, when waf_group appears in tags, this value can be filled in, and only one list of six digits in string format can appear with regultypes.
*/
public val regularRules: Output>?
get() = javaResource.regularRules().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* Regular rule type, when waf_group appears in tags, this value can be filled in, optional values:["sqli", "xss", "code_exec", "crlf", "lfileii", "rfileii", "webshell", "vvip", "other"]
*/
public val regularTypes: Output>?
get() = javaResource.regularTypes().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* Filter by IP address.
*/
public val remoteAddrs: Output>?
get() = javaResource.remoteAddrs().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The name of the protection rule. The name can be up to 64 characters in length and can contain letters, digits, and underscores (_). **NOTE:** This parameter cannot be modified when policy is of type `region_block`.
*/
public val ruleName: Output
get() = javaResource.ruleName().applyValue({ args0 -> args0 })
/**
* The types of the protection policies.
*/
public val scenes: Output>?
get() = javaResource.scenes().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The status of the waf rule. Valid values: `on` and `off`. Default value: on.
*/
public val status: Output
get() = javaResource.status().applyValue({ args0 -> args0 })
/**
* The id of the waf rule group. The default value is "1012". Multiple rules are separated by commas.
*/
public val wafGroupIds: Output?
get() = javaResource.wafGroupIds().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object WafRuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.alicloud.dcdn.WafRule::class == javaResource::class
override fun map(javaResource: Resource): WafRule = WafRule(
javaResource as
com.pulumi.alicloud.dcdn.WafRule,
)
}
/**
* @see [WafRule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [WafRule].
*/
public suspend fun wafRule(name: String, block: suspend WafRuleResourceBuilder.() -> Unit): WafRule {
val builder = WafRuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [WafRule].
* @param name The _unique_ name of the resulting resource.
*/
public fun wafRule(name: String): WafRule {
val builder = WafRuleResourceBuilder()
builder.name(name)
return builder.build()
}