Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.EmailRoutingCatchAll

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

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: forward
          value:
            - destinationaddress@example.net
      matchers:
        - type: all
      enabled: true
      name: Send to user@example.net rule.

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 string: The unique name of the resource.
args EmailRoutingCatchAllArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args EmailRoutingCatchAllArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EmailRoutingCatchAllArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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",
});

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"),
})

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());

email_routing_catch_all_resource = cloudflare.EmailRoutingCatchAll("emailRoutingCatchAllResource",
    actions=[{
        "type": "string",
        "values": ["string"],
    }],
    matchers=[{
        "type": "string",
    }],
    zone_id="string",
    enabled=False,
    name="string")

const emailRoutingCatchAllResource = new cloudflare.EmailRoutingCatchAll("emailRoutingCatchAllResource", {
    actions: [{
        type: "string",
        values: ["string"],
    }],
    matchers: [{
        type: "string",
    }],
    zoneId: "string",
    enabled: false,
    name: "string",
});

type: cloudflare:EmailRoutingCatchAll
properties:
    actions:
        - type: string
          values:
            - string
    enabled: false
    matchers:
        - type: string
    name: string
    zoneId: string

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 List<EmailRoutingCatchAllAction>: List actions for the catch-all routing rule.
Matchers List<EmailRoutingCatchAllMatcher>: List of matchers for the catch-all routing rule.
ZoneId string: Identifier
Enabled bool: Routing rule status.
Name string: Routing rule name.

Actions []EmailRoutingCatchAllActionArgs: List actions for the catch-all routing rule.
Matchers []EmailRoutingCatchAllMatcherArgs: List of matchers for the catch-all routing rule.
ZoneId string: Identifier
Enabled bool: Routing rule status.
Name string: Routing rule name.

actions List<EmailRoutingCatchAllAction>: List actions for the catch-all routing rule.
matchers List<EmailRoutingCatchAllMatcher>: List of matchers for the catch-all routing rule.
zoneId String: Identifier
enabled Boolean: Routing rule status.
name String: Routing rule name.

actions EmailRoutingCatchAllAction[]: List actions for the catch-all routing rule.
matchers EmailRoutingCatchAllMatcher[]: List of matchers for the catch-all routing rule.
zoneId string: Identifier
enabled boolean: Routing rule status.
name string: Routing rule name.

actions Sequence[EmailRoutingCatchAllActionArgs]: List actions for the catch-all routing rule.
matchers Sequence[EmailRoutingCatchAllMatcherArgs]: List of matchers for the catch-all routing rule.
zone_id str: Identifier
enabled bool: Routing rule status.
name str: Routing rule name.

actions List<Property Map>: List actions for the catch-all routing rule.
matchers List<Property Map>: List of matchers for the catch-all routing rule.
zoneId 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)
Deprecated: This attribute is deprecated.

Id string: The provider-assigned unique ID for this managed resource.
Tag string: Routing rule tag. (Deprecated, replaced by routing rule identifier)
Deprecated: This attribute is deprecated.

id String: The provider-assigned unique ID for this managed resource.
tag String: Routing rule tag. (Deprecated, replaced by routing rule identifier)
Deprecated: This attribute is deprecated.

id string: The provider-assigned unique ID for this managed resource.
tag string: Routing rule tag. (Deprecated, replaced by routing rule identifier)
Deprecated: This attribute is deprecated.

id str: The provider-assigned unique ID for this managed resource.
tag str: Routing rule tag. (Deprecated, replaced by routing rule identifier)
Deprecated: This attribute is deprecated.

id String: The provider-assigned unique ID for this managed resource.
tag String: Routing rule tag. (Deprecated, replaced by routing rule identifier)
Deprecated: This attribute is deprecated.

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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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)
Deprecated: This attribute is deprecated.
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)
Deprecated: This attribute is deprecated.
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)
Deprecated: This attribute is deprecated.
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)
Deprecated: This attribute is deprecated.
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)
Deprecated: This attribute is deprecated.
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)
Deprecated: This attribute is deprecated.
zoneId String: Identifier

Supporting Types

EmailRoutingCatchAllAction, EmailRoutingCatchAllActionArgs

Type string: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
Values List<string>

Type string: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
Values []string

type String: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values List<String>

type string: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values string[]

type str: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values Sequence[str]

type String: Type of action for catch-all rule. Available values: "drop", "forward", "worker".
values List<String>

EmailRoutingCatchAllMatcher, EmailRoutingCatchAllMatcherArgs

Type string: Type of matcher. Default is 'all'. Available values: "all".

Type string: Type of matcher. Default is 'all'. Available values: "all".

type String: Type of matcher. Default is 'all'. Available values: "all".

type string: Type of matcher. Default is 'all'. Available values: "all".

type str: Type of matcher. Default is 'all'. Available values: "all".

type String: Type of matcher. Default is 'all'. Available values: "all".

Import

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

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.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.EmailRoutingCatchAll

On this page

On this page

Example Usage

Create EmailRoutingCatchAll Resource

Constructor syntax

Parameters

Constructor example

EmailRoutingCatchAll Resource Properties

Inputs

Outputs

Look up Existing EmailRoutingCatchAll Resource

Supporting Types

EmailRoutingCatchAllAction, EmailRoutingCatchAllActionArgs

EmailRoutingCatchAllMatcher, EmailRoutingCatchAllMatcherArgs

Import

Package Details

On this page

On this page