Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. EmailRoutingCatchAll
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.EmailRoutingCatchAll

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleEmailRoutingCatchAll:
    type: cloudflare:EmailRoutingCatchAll
    name: example_email_routing_catch_all
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      actions:
        - type: drop
          value:
            - destinationaddress@example.net
      matchers:
        - type: all
      enabled: true
      name: Send to user@example.net rule.
Copy

Create EmailRoutingCatchAll Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EmailRoutingCatchAll(name: string, args: EmailRoutingCatchAllArgs, opts?: CustomResourceOptions);
@overload
def EmailRoutingCatchAll(resource_name: str,
                         args: EmailRoutingCatchAllArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def EmailRoutingCatchAll(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         actions: Optional[Sequence[EmailRoutingCatchAllActionArgs]] = None,
                         matchers: Optional[Sequence[EmailRoutingCatchAllMatcherArgs]] = None,
                         zone_id: Optional[str] = None,
                         enabled: Optional[bool] = None,
                         name: Optional[str] = None)
func NewEmailRoutingCatchAll(ctx *Context, name string, args EmailRoutingCatchAllArgs, opts ...ResourceOption) (*EmailRoutingCatchAll, error)
public EmailRoutingCatchAll(string name, EmailRoutingCatchAllArgs args, CustomResourceOptions? opts = null)
public EmailRoutingCatchAll(String name, EmailRoutingCatchAllArgs args)
public EmailRoutingCatchAll(String name, EmailRoutingCatchAllArgs args, CustomResourceOptions options)

type: cloudflare:EmailRoutingCatchAll
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EmailRoutingCatchAllArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EmailRoutingCatchAllArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EmailRoutingCatchAllArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EmailRoutingCatchAllArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EmailRoutingCatchAllArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var emailRoutingCatchAllResource = new Cloudflare.EmailRoutingCatchAll("emailRoutingCatchAllResource", new()
{
    Actions = new[]
    {
        new Cloudflare.Inputs.EmailRoutingCatchAllActionArgs
        {
            Type = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    Matchers = new[]
    {
        new Cloudflare.Inputs.EmailRoutingCatchAllMatcherArgs
        {
            Type = "string",
        },
    },
    ZoneId = "string",
    Enabled = false,
    Name = "string",
});
Copy
example, err := cloudflare.NewEmailRoutingCatchAll(ctx, "emailRoutingCatchAllResource", &cloudflare.EmailRoutingCatchAllArgs{
	Actions: cloudflare.EmailRoutingCatchAllActionArray{
		&cloudflare.EmailRoutingCatchAllActionArgs{
			Type: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Matchers: cloudflare.EmailRoutingCatchAllMatcherArray{
		&cloudflare.EmailRoutingCatchAllMatcherArgs{
			Type: pulumi.String("string"),
		},
	},
	ZoneId:  pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	Name:    pulumi.String("string"),
})
Copy
var emailRoutingCatchAllResource = new EmailRoutingCatchAll("emailRoutingCatchAllResource", EmailRoutingCatchAllArgs.builder()
    .actions(EmailRoutingCatchAllActionArgs.builder()
        .type("string")
        .values("string")
        .build())
    .matchers(EmailRoutingCatchAllMatcherArgs.builder()
        .type("string")
        .build())
    .zoneId("string")
    .enabled(false)
    .name("string")
    .build());
Copy
email_routing_catch_all_resource = cloudflare.EmailRoutingCatchAll("emailRoutingCatchAllResource",
    actions=[{
        "type": "string",
        "values": ["string"],
    }],
    matchers=[{
        "type": "string",
    }],
    zone_id="string",
    enabled=False,
    name="string")
Copy
const emailRoutingCatchAllResource = new cloudflare.EmailRoutingCatchAll("emailRoutingCatchAllResource", {
    actions: [{
        type: "string",
        values: ["string"],
    }],
    matchers: [{
        type: "string",
    }],
    zoneId: "string",
    enabled: false,
    name: "string",
});
Copy
type: cloudflare:EmailRoutingCatchAll
properties:
    actions:
        - type: string
          values:
            - string
    enabled: false
    matchers:
        - type: string
    name: string
    zoneId: string
Copy

EmailRoutingCatchAll Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EmailRoutingCatchAll resource accepts the following input properties:

Actions This property is required. List<EmailRoutingCatchAllAction>
List actions for the catch-all routing rule.
Matchers This property is required. List<EmailRoutingCatchAllMatcher>
List of matchers for the catch-all routing rule.
ZoneId This property is required. string
Identifier
Enabled bool
Routing rule status.
Name string
Routing rule name.
Actions This property is required. []EmailRoutingCatchAllActionArgs
List actions for the catch-all routing rule.
Matchers This property is required. []EmailRoutingCatchAllMatcherArgs
List of matchers for the catch-all routing rule.
ZoneId This property is required. string
Identifier
Enabled bool
Routing rule status.
Name string
Routing rule name.
actions This property is required. List<EmailRoutingCatchAllAction>
List actions for the catch-all routing rule.
matchers This property is required. List<EmailRoutingCatchAllMatcher>
List of matchers for the catch-all routing rule.
zoneId This property is required. String
Identifier
enabled Boolean
Routing rule status.
name String
Routing rule name.
actions This property is required. EmailRoutingCatchAllAction[]
List actions for the catch-all routing rule.
matchers This property is required. EmailRoutingCatchAllMatcher[]
List of matchers for the catch-all routing rule.
zoneId This property is required. string
Identifier
enabled boolean
Routing rule status.
name string
Routing rule name.
actions This property is required. Sequence[EmailRoutingCatchAllActionArgs]
List actions for the catch-all routing rule.
matchers This property is required. Sequence[EmailRoutingCatchAllMatcherArgs]
List of matchers for the catch-all routing rule.
zone_id This property is required. str
Identifier
enabled bool
Routing rule status.
name str
Routing rule name.
actions This property is required. List<Property Map>
List actions for the catch-all routing rule.
matchers This property is required. List<Property Map>
List of matchers for the catch-all routing rule.
zoneId This property is required. String
Identifier
enabled Boolean
Routing rule status.
name String
Routing rule name.

Outputs

All input properties are implicitly available as output properties. Additionally, the EmailRoutingCatchAll resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
Id string
The provider-assigned unique ID for this managed resource.
Tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
id String
The provider-assigned unique ID for this managed resource.
tag String
Routing rule tag. (Deprecated, replaced by routing rule identifier)
id string
The provider-assigned unique ID for this managed resource.
tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
id str
The provider-assigned unique ID for this managed resource.
tag str
Routing rule tag. (Deprecated, replaced by routing rule identifier)
id String
The provider-assigned unique ID for this managed resource.
tag String
Routing rule tag. (Deprecated, replaced by routing rule identifier)

Look up Existing EmailRoutingCatchAll Resource

Get an existing EmailRoutingCatchAll resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EmailRoutingCatchAllState, opts?: CustomResourceOptions): EmailRoutingCatchAll
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actions: Optional[Sequence[EmailRoutingCatchAllActionArgs]] = None,
        enabled: Optional[bool] = None,
        matchers: Optional[Sequence[EmailRoutingCatchAllMatcherArgs]] = None,
        name: Optional[str] = None,
        tag: Optional[str] = None,
        zone_id: Optional[str] = None) -> EmailRoutingCatchAll
func GetEmailRoutingCatchAll(ctx *Context, name string, id IDInput, state *EmailRoutingCatchAllState, opts ...ResourceOption) (*EmailRoutingCatchAll, error)
public static EmailRoutingCatchAll Get(string name, Input<string> id, EmailRoutingCatchAllState? state, CustomResourceOptions? opts = null)
public static EmailRoutingCatchAll get(String name, Output<String> id, EmailRoutingCatchAllState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:EmailRoutingCatchAll    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Actions List<EmailRoutingCatchAllAction>
List actions for the catch-all routing rule.
Enabled bool
Routing rule status.
Matchers List<EmailRoutingCatchAllMatcher>
List of matchers for the catch-all routing rule.
Name string
Routing rule name.
Tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
ZoneId string
Identifier
Actions []EmailRoutingCatchAllActionArgs
List actions for the catch-all routing rule.
Enabled bool
Routing rule status.
Matchers []EmailRoutingCatchAllMatcherArgs
List of matchers for the catch-all routing rule.
Name string
Routing rule name.
Tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
ZoneId string
Identifier
actions List<EmailRoutingCatchAllAction>
List actions for the catch-all routing rule.
enabled Boolean
Routing rule status.
matchers List<EmailRoutingCatchAllMatcher>
List of matchers for the catch-all routing rule.
name String
Routing rule name.
tag String
Routing rule tag. (Deprecated, replaced by routing rule identifier)
zoneId String
Identifier
actions EmailRoutingCatchAllAction[]
List actions for the catch-all routing rule.
enabled boolean
Routing rule status.
matchers EmailRoutingCatchAllMatcher[]
List of matchers for the catch-all routing rule.
name string
Routing rule name.
tag string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
zoneId string
Identifier
actions Sequence[EmailRoutingCatchAllActionArgs]
List actions for the catch-all routing rule.
enabled bool
Routing rule status.
matchers Sequence[EmailRoutingCatchAllMatcherArgs]
List of matchers for the catch-all routing rule.
name str
Routing rule name.
tag str
Routing rule tag. (Deprecated, replaced by routing rule identifier)
zone_id str
Identifier
actions List<Property Map>
List actions for the catch-all routing rule.
enabled Boolean
Routing rule status.
matchers List<Property Map>
List of matchers for the catch-all routing rule.
name String
Routing rule name.
tag String
Routing rule tag. (Deprecated, replaced by routing rule identifier)
zoneId String
Identifier

Supporting Types

EmailRoutingCatchAllAction
, EmailRoutingCatchAllActionArgs

Type This property is required. string
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
Values List<string>
Type This property is required. string
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
Values []string
type This property is required. String
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values List<String>
type This property is required. string
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values string[]
type This property is required. str
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values Sequence[str]
type This property is required. String
Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values List<String>

EmailRoutingCatchAllMatcher
, EmailRoutingCatchAllMatcherArgs

Type This property is required. string
Type of matcher. Default is 'all'. Available values: "all".
Type This property is required. string
Type of matcher. Default is 'all'. Available values: "all".
type This property is required. String
Type of matcher. Default is 'all'. Available values: "all".
type This property is required. string
Type of matcher. Default is 'all'. Available values: "all".
type This property is required. str
Type of matcher. Default is 'all'. Available values: "all".
type This property is required. String
Type of matcher. Default is 'all'. Available values: "all".

Import

$ pulumi import cloudflare:index/emailRoutingCatchAll:EmailRoutingCatchAll example '<zone_id>'
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare