com.pulumi.cloudflare.kotlin.RateLimitArgs.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.RateLimitArgs.builder
import com.pulumi.cloudflare.kotlin.inputs.RateLimitActionArgs
import com.pulumi.cloudflare.kotlin.inputs.RateLimitActionArgsBuilder
import com.pulumi.cloudflare.kotlin.inputs.RateLimitCorrelateArgs
import com.pulumi.cloudflare.kotlin.inputs.RateLimitCorrelateArgsBuilder
import com.pulumi.cloudflare.kotlin.inputs.RateLimitMatchArgs
import com.pulumi.cloudflare.kotlin.inputs.RateLimitMatchArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Provides a Cloudflare rate limit resource for a given zone. This can
* be used to limit the traffic you receive zone-wide, or matching more
* specific types of requests/responses.
* > `cloudflare.RateLimit` is in a deprecation phase until January 15th, 2025.
* During this time period, this resource is still
* fully supported but you are strongly advised to move to the
* `cloudflare.Ruleset` resource. Full details can be found in the
* developer documentation.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
* const example = new cloudflare.RateLimit("example", {
* zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
* threshold: 2000,
* period: 2,
* match: {
* request: {
* urlPattern: `${cloudflareZone}/*`,
* schemes: [
* "HTTP",
* "HTTPS",
* ],
* methods: [
* "GET",
* "POST",
* "PUT",
* "DELETE",
* "PATCH",
* "HEAD",
* ],
* },
* response: {
* statuses: [
* 200,
* 201,
* 202,
* 301,
* 429,
* ],
* originTraffic: false,
* headers: [
* {
* name: "Host",
* op: "eq",
* value: "localhost",
* },
* {
* name: "X-Example",
* op: "ne",
* value: "my-example",
* },
* ],
* },
* },
* action: {
* mode: "simulate",
* timeout: 43200,
* response: {
* contentType: "text/plain",
* body: "custom response body",
* },
* },
* correlate: {
* by: "nat",
* },
* disabled: false,
* description: "example rate limit for a zone",
* bypassUrlPatterns: [
* "example.com/bypass1",
* "example.com/bypass2",
* ],
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.RateLimit("example",
* zone_id="0da42c8d2132a9ddaf714f9e7c920711",
* threshold=2000,
* period=2,
* match={
* "request": {
* "url_pattern": f"{cloudflare_zone}/*",
* "schemes": [
* "HTTP",
* "HTTPS",
* ],
* "methods": [
* "GET",
* "POST",
* "PUT",
* "DELETE",
* "PATCH",
* "HEAD",
* ],
* },
* "response": {
* "statuses": [
* 200,
* 201,
* 202,
* 301,
* 429,
* ],
* "origin_traffic": False,
* "headers": [
* {
* "name": "Host",
* "op": "eq",
* "value": "localhost",
* },
* {
* "name": "X-Example",
* "op": "ne",
* "value": "my-example",
* },
* ],
* },
* },
* action={
* "mode": "simulate",
* "timeout": 43200,
* "response": {
* "content_type": "text/plain",
* "body": "custom response body",
* },
* },
* correlate={
* "by": "nat",
* },
* disabled=False,
* description="example rate limit for a zone",
* bypass_url_patterns=[
* "example.com/bypass1",
* "example.com/bypass2",
* ])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Cloudflare = Pulumi.Cloudflare;
* return await Deployment.RunAsync(() =>
* {
* var example = new Cloudflare.RateLimit("example", new()
* {
* ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
* Threshold = 2000,
* Period = 2,
* Match = new Cloudflare.Inputs.RateLimitMatchArgs
* {
* Request = new Cloudflare.Inputs.RateLimitMatchRequestArgs
* {
* UrlPattern = $"{cloudflareZone}/*",
* Schemes = new[]
* {
* "HTTP",
* "HTTPS",
* },
* Methods = new[]
* {
* "GET",
* "POST",
* "PUT",
* "DELETE",
* "PATCH",
* "HEAD",
* },
* },
* Response = new Cloudflare.Inputs.RateLimitMatchResponseArgs
* {
* Statuses = new[]
* {
* 200,
* 201,
* 202,
* 301,
* 429,
* },
* OriginTraffic = false,
* Headers = new[]
* {
* {
* { "name", "Host" },
* { "op", "eq" },
* { "value", "localhost" },
* },
* {
* { "name", "X-Example" },
* { "op", "ne" },
* { "value", "my-example" },
* },
* },
* },
* },
* Action = new Cloudflare.Inputs.RateLimitActionArgs
* {
* Mode = "simulate",
* Timeout = 43200,
* Response = new Cloudflare.Inputs.RateLimitActionResponseArgs
* {
* ContentType = "text/plain",
* Body = "custom response body",
* },
* },
* Correlate = new Cloudflare.Inputs.RateLimitCorrelateArgs
* {
* By = "nat",
* },
* Disabled = false,
* Description = "example rate limit for a zone",
* BypassUrlPatterns = new[]
* {
* "example.com/bypass1",
* "example.com/bypass2",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "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.NewRateLimit(ctx, "example", &cloudflare.RateLimitArgs{
* ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
* Threshold: pulumi.Int(2000),
* Period: pulumi.Int(2),
* Match: &cloudflare.RateLimitMatchArgs{
* Request: &cloudflare.RateLimitMatchRequestArgs{
* UrlPattern: pulumi.Sprintf("%v/*", cloudflareZone),
* Schemes: pulumi.StringArray{
* pulumi.String("HTTP"),
* pulumi.String("HTTPS"),
* },
* Methods: pulumi.StringArray{
* pulumi.String("GET"),
* pulumi.String("POST"),
* pulumi.String("PUT"),
* pulumi.String("DELETE"),
* pulumi.String("PATCH"),
* pulumi.String("HEAD"),
* },
* },
* Response: &cloudflare.RateLimitMatchResponseArgs{
* Statuses: pulumi.IntArray{
* pulumi.Int(200),
* pulumi.Int(201),
* pulumi.Int(202),
* pulumi.Int(301),
* pulumi.Int(429),
* },
* OriginTraffic: pulumi.Bool(false),
* Headers: pulumi.StringMapArray{
* pulumi.StringMap{
* "name": pulumi.String("Host"),
* "op": pulumi.String("eq"),
* "value": pulumi.String("localhost"),
* },
* pulumi.StringMap{
* "name": pulumi.String("X-Example"),
* "op": pulumi.String("ne"),
* "value": pulumi.String("my-example"),
* },
* },
* },
* },
* Action: &cloudflare.RateLimitActionArgs{
* Mode: pulumi.String("simulate"),
* Timeout: pulumi.Int(43200),
* Response: &cloudflare.RateLimitActionResponseArgs{
* ContentType: pulumi.String("text/plain"),
* Body: pulumi.String("custom response body"),
* },
* },
* Correlate: &cloudflare.RateLimitCorrelateArgs{
* By: pulumi.String("nat"),
* },
* Disabled: pulumi.Bool(false),
* Description: pulumi.String("example rate limit for a zone"),
* BypassUrlPatterns: pulumi.StringArray{
* pulumi.String("example.com/bypass1"),
* pulumi.String("example.com/bypass2"),
* },
* })
* 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.RateLimit;
* import com.pulumi.cloudflare.RateLimitArgs;
* import com.pulumi.cloudflare.inputs.RateLimitMatchArgs;
* import com.pulumi.cloudflare.inputs.RateLimitMatchRequestArgs;
* import com.pulumi.cloudflare.inputs.RateLimitMatchResponseArgs;
* import com.pulumi.cloudflare.inputs.RateLimitActionArgs;
* import com.pulumi.cloudflare.inputs.RateLimitActionResponseArgs;
* import com.pulumi.cloudflare.inputs.RateLimitCorrelateArgs;
* 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 RateLimit("example", RateLimitArgs.builder()
* .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
* .threshold(2000)
* .period(2)
* .match(RateLimitMatchArgs.builder()
* .request(RateLimitMatchRequestArgs.builder()
* .urlPattern(String.format("%s/*", cloudflareZone))
* .schemes(
* "HTTP",
* "HTTPS")
* .methods(
* "GET",
* "POST",
* "PUT",
* "DELETE",
* "PATCH",
* "HEAD")
* .build())
* .response(RateLimitMatchResponseArgs.builder()
* .statuses(
* 200,
* 201,
* 202,
* 301,
* 429)
* .originTraffic(false)
* .headers(
* Map.ofEntries(
* Map.entry("name", "Host"),
* Map.entry("op", "eq"),
* Map.entry("value", "localhost")
* ),
* Map.ofEntries(
* Map.entry("name", "X-Example"),
* Map.entry("op", "ne"),
* Map.entry("value", "my-example")
* ))
* .build())
* .build())
* .action(RateLimitActionArgs.builder()
* .mode("simulate")
* .timeout(43200)
* .response(RateLimitActionResponseArgs.builder()
* .contentType("text/plain")
* .body("custom response body")
* .build())
* .build())
* .correlate(RateLimitCorrelateArgs.builder()
* .by("nat")
* .build())
* .disabled(false)
* .description("example rate limit for a zone")
* .bypassUrlPatterns(
* "example.com/bypass1",
* "example.com/bypass2")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:RateLimit
* properties:
* zoneId: 0da42c8d2132a9ddaf714f9e7c920711
* threshold: 2000
* period: 2
* match:
* request:
* urlPattern: ${cloudflareZone}/*
* schemes:
* - HTTP
* - HTTPS
* methods:
* - GET
* - POST
* - PUT
* - DELETE
* - PATCH
* - HEAD
* response:
* statuses:
* - 200
* - 201
* - 202
* - 301
* - 429
* originTraffic: false
* headers:
* - name: Host
* op: eq
* value: localhost
* - name: X-Example
* op: ne
* value: my-example
* action:
* mode: simulate
* timeout: 43200
* response:
* contentType: text/plain
* body: custom response body
* correlate:
* by: nat
* disabled: false
* description: example rate limit for a zone
* bypassUrlPatterns:
* - example.com/bypass1
* - example.com/bypass2
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/rateLimit:RateLimit example /
* ```
* @property action The action to be performed when the threshold of matched traffic within the period defined is exceeded.
* @property bypassUrlPatterns
* @property correlate Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.
* @property description A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.
* @property disabled Whether this ratelimit is currently disabled. Defaults to `false`.
* @property match Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone.
* @property period The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed.
* @property threshold The threshold that triggers the rate limit mitigations, combine with period.
* @property zoneId The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
* */*/*/*/*/*/
*/
public data class RateLimitArgs(
public val action: Output? = null,
public val bypassUrlPatterns: Output>? = null,
public val correlate: Output? = null,
public val description: Output? = null,
public val disabled: Output? = null,
public val match: Output? = null,
public val period: Output? = null,
public val threshold: Output? = null,
public val zoneId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.cloudflare.RateLimitArgs =
com.pulumi.cloudflare.RateLimitArgs.builder()
.action(action?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.bypassUrlPatterns(bypassUrlPatterns?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.correlate(correlate?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.description(description?.applyValue({ args0 -> args0 }))
.disabled(disabled?.applyValue({ args0 -> args0 }))
.match(match?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.period(period?.applyValue({ args0 -> args0 }))
.threshold(threshold?.applyValue({ args0 -> args0 }))
.zoneId(zoneId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [RateLimitArgs].
*/
@PulumiTagMarker
public class RateLimitArgsBuilder internal constructor() {
private var action: Output? = null
private var bypassUrlPatterns: Output>? = null
private var correlate: Output? = null
private var description: Output? = null
private var disabled: Output? = null
private var match: Output? = null
private var period: Output? = null
private var threshold: Output? = null
private var zoneId: Output? = null
/**
* @param value The action to be performed when the threshold of matched traffic within the period defined is exceeded.
*/
@JvmName("uaigxmjwmrmptgdq")
public suspend fun action(`value`: Output) {
this.action = value
}
/**
* @param value
*/
@JvmName("fmeocmxccabwxciw")
public suspend fun bypassUrlPatterns(`value`: Output>) {
this.bypassUrlPatterns = value
}
@JvmName("vlcwipimcyoacmds")
public suspend fun bypassUrlPatterns(vararg values: Output) {
this.bypassUrlPatterns = Output.all(values.asList())
}
/**
* @param values
*/
@JvmName("jqsjvfqadpxjxdrd")
public suspend fun bypassUrlPatterns(values: List>) {
this.bypassUrlPatterns = Output.all(values)
}
/**
* @param value Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.
*/
@JvmName("ugvbfovtmhutdmpo")
public suspend fun correlate(`value`: Output) {
this.correlate = value
}
/**
* @param value A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.
*/
@JvmName("ykhnxjlpfeteftrc")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Whether this ratelimit is currently disabled. Defaults to `false`.
*/
@JvmName("nqpnvqjrrmxcxxvh")
public suspend fun disabled(`value`: Output) {
this.disabled = value
}
/**
* @param value Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone.
*/
@JvmName("auiepelbtngvgjqx")
public suspend fun match(`value`: Output) {
this.match = value
}
/**
* @param value The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed.
*/
@JvmName("iqwclqifxbeiliuo")
public suspend fun period(`value`: Output) {
this.period = value
}
/**
* @param value The threshold that triggers the rate limit mitigations, combine with period.
*/
@JvmName("fusnemffspubemas")
public suspend fun threshold(`value`: Output) {
this.threshold = value
}
/**
* @param value The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
@JvmName("gtmplemdeoplfqrh")
public suspend fun zoneId(`value`: Output) {
this.zoneId = value
}
/**
* @param value The action to be performed when the threshold of matched traffic within the period defined is exceeded.
*/
@JvmName("xihosnaieoainslp")
public suspend fun action(`value`: RateLimitActionArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.action = mapped
}
/**
* @param argument The action to be performed when the threshold of matched traffic within the period defined is exceeded.
*/
@JvmName("tvpilhyugnejcnxe")
public suspend fun action(argument: suspend RateLimitActionArgsBuilder.() -> Unit) {
val toBeMapped = RateLimitActionArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.action = mapped
}
/**
* @param value
*/
@JvmName("dbfibhpxgulpwkts")
public suspend fun bypassUrlPatterns(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.bypassUrlPatterns = mapped
}
/**
* @param values
*/
@JvmName("vewierfqcnrvtirp")
public suspend fun bypassUrlPatterns(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.bypassUrlPatterns = mapped
}
/**
* @param value Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.
*/
@JvmName("mgtfjshslfrtfdlr")
public suspend fun correlate(`value`: RateLimitCorrelateArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.correlate = mapped
}
/**
* @param argument Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.
*/
@JvmName("wfjgsyuyixehgqbm")
public suspend fun correlate(argument: suspend RateLimitCorrelateArgsBuilder.() -> Unit) {
val toBeMapped = RateLimitCorrelateArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.correlate = mapped
}
/**
* @param value A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.
*/
@JvmName("wgtbteudjxonkqrt")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Whether this ratelimit is currently disabled. Defaults to `false`.
*/
@JvmName("pbiaprvkofxnbnwk")
public suspend fun disabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.disabled = mapped
}
/**
* @param value Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone.
*/
@JvmName("ifyuuvmabmqoijko")
public suspend fun match(`value`: RateLimitMatchArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.match = mapped
}
/**
* @param argument Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone.
*/
@JvmName("owtucmklmrpanvre")
public suspend fun match(argument: suspend RateLimitMatchArgsBuilder.() -> Unit) {
val toBeMapped = RateLimitMatchArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.match = mapped
}
/**
* @param value The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed.
*/
@JvmName("xyycvsxdeyoqibkc")
public suspend fun period(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.period = mapped
}
/**
* @param value The threshold that triggers the rate limit mitigations, combine with period.
*/
@JvmName("dlrcahjqdxnyscpw")
public suspend fun threshold(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.threshold = mapped
}
/**
* @param value The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
@JvmName("wxorraxbnmprxfbr")
public suspend fun zoneId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.zoneId = mapped
}
internal fun build(): RateLimitArgs = RateLimitArgs(
action = action,
bypassUrlPatterns = bypassUrlPatterns,
correlate = correlate,
description = description,
disabled = disabled,
match = match,
period = period,
threshold = threshold,
zoneId = zoneId,
)
}