AccessRule

class AccessRule : KotlinCustomResource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleAccessRule = new cloudflare.AccessRule("example_access_rule", {
configuration: {
target: "ip",
value: "198.51.100.4",
},
mode: "block",
zoneId: "zone_id",
notes: "This rule is enabled because of an event that occurred on date X.",
});
import pulumi
import pulumi_cloudflare as cloudflare
example_access_rule = cloudflare.AccessRule("example_access_rule",
configuration={
"target": "ip",
"value": "198.51.100.4",
},
mode="block",
zone_id="zone_id",
notes="This rule is enabled because of an event that occurred on date X.")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var exampleAccessRule = new Cloudflare.AccessRule("example_access_rule", new()
{
Configuration = new Cloudflare.Inputs.AccessRuleConfigurationArgs
{
Target = "ip",
Value = "198.51.100.4",
},
Mode = "block",
ZoneId = "zone_id",
Notes = "This rule is enabled because of an event that occurred on date X.",
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewAccessRule(ctx, "example_access_rule", &cloudflare.AccessRuleArgs{
Configuration: &cloudflare.AccessRuleConfigurationArgs{
Target: pulumi.String("ip"),
Value: pulumi.String("198.51.100.4"),
},
Mode: pulumi.String("block"),
ZoneId: pulumi.String("zone_id"),
Notes: pulumi.String("This rule is enabled because of an event that occurred on date X."),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.AccessRule;
import com.pulumi.cloudflare.AccessRuleArgs;
import com.pulumi.cloudflare.inputs.AccessRuleConfigurationArgs;
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 exampleAccessRule = new AccessRule("exampleAccessRule", AccessRuleArgs.builder()
.configuration(AccessRuleConfigurationArgs.builder()
.target("ip")
.value("198.51.100.4")
.build())
.mode("block")
.zoneId("zone_id")
.notes("This rule is enabled because of an event that occurred on date X.")
.build());
}
}
resources:
exampleAccessRule:
type: cloudflare:AccessRule
name: example_access_rule
properties:
configuration:
target: ip
value: 198.51.100.4
mode: block
zoneId: zone_id
notes: This rule is enabled because of an event that occurred on date X.

Import

$ pulumi import cloudflare:index/accessRule:AccessRule example '<{accounts|zones}/{account_id|zone_id}>/<rule_id>'

Properties

Link copied to clipboard
val accountId: Output<String>?

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

Link copied to clipboard
val allowedModes: Output<List<String>>

The available actions that a rule can apply to a matched request.

Link copied to clipboard

The rule configuration.

Link copied to clipboard
val createdOn: Output<String>

The timestamp of when the rule was created.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val mode: Output<String>

The action to apply to a matched request. Available values: "block", "challenge", "whitelist", "jschallenge", "managedchallenge".

Link copied to clipboard
val modifiedOn: Output<String>

The timestamp of when the rule was last modified.

Link copied to clipboard
val notes: Output<String>?

An informative summary of the rule, typically used as a reminder or explanation.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val scope: Output<AccessRuleScope>

All zones owned by the user will have the rule applied.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val zoneId: Output<String>?

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.