1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. EmailRoutingSettings
Cloudflare v6.0.0 published on Monday, Apr 14, 2025 by Pulumi

cloudflare.EmailRoutingSettings

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleEmailRoutingSettings = new cloudflare.EmailRoutingSettings("example_email_routing_settings", {zoneId: "023e105f4ecef8ad9ca31a8372d0c353"});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_email_routing_settings = cloudflare.EmailRoutingSettings("example_email_routing_settings", zone_id="023e105f4ecef8ad9ca31a8372d0c353")
Copy
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.NewEmailRoutingSettings(ctx, "example_email_routing_settings", &cloudflare.EmailRoutingSettingsArgs{
			ZoneId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleEmailRoutingSettings = new Cloudflare.EmailRoutingSettings("example_email_routing_settings", new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.EmailRoutingSettings;
import com.pulumi.cloudflare.EmailRoutingSettingsArgs;
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 exampleEmailRoutingSettings = new EmailRoutingSettings("exampleEmailRoutingSettings", EmailRoutingSettingsArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}
Copy
resources:
  exampleEmailRoutingSettings:
    type: cloudflare:EmailRoutingSettings
    name: example_email_routing_settings
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
Copy

Create EmailRoutingSettings Resource

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

Constructor syntax

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

@overload
def EmailRoutingSettings(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         zone_id: Optional[str] = None)
func NewEmailRoutingSettings(ctx *Context, name string, args EmailRoutingSettingsArgs, opts ...ResourceOption) (*EmailRoutingSettings, error)
public EmailRoutingSettings(string name, EmailRoutingSettingsArgs args, CustomResourceOptions? opts = null)
public EmailRoutingSettings(String name, EmailRoutingSettingsArgs args)
public EmailRoutingSettings(String name, EmailRoutingSettingsArgs args, CustomResourceOptions options)
type: cloudflare:EmailRoutingSettings
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. EmailRoutingSettingsArgs
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. EmailRoutingSettingsArgs
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. EmailRoutingSettingsArgs
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. EmailRoutingSettingsArgs
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. EmailRoutingSettingsArgs
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 emailRoutingSettingsResource = new Cloudflare.EmailRoutingSettings("emailRoutingSettingsResource", new()
{
    ZoneId = "string",
});
Copy
example, err := cloudflare.NewEmailRoutingSettings(ctx, "emailRoutingSettingsResource", &cloudflare.EmailRoutingSettingsArgs{
	ZoneId: pulumi.String("string"),
})
Copy
var emailRoutingSettingsResource = new EmailRoutingSettings("emailRoutingSettingsResource", EmailRoutingSettingsArgs.builder()
    .zoneId("string")
    .build());
Copy
email_routing_settings_resource = cloudflare.EmailRoutingSettings("emailRoutingSettingsResource", zone_id="string")
Copy
const emailRoutingSettingsResource = new cloudflare.EmailRoutingSettings("emailRoutingSettingsResource", {zoneId: "string"});
Copy
type: cloudflare:EmailRoutingSettings
properties:
    zoneId: string
Copy

EmailRoutingSettings 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 EmailRoutingSettings resource accepts the following input properties:

ZoneId This property is required. string
Identifier
ZoneId This property is required. string
Identifier
zoneId This property is required. String
Identifier
zoneId This property is required. string
Identifier
zone_id This property is required. str
Identifier
zoneId This property is required. String
Identifier

Outputs

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

Created string
The date and time the settings have been created.
Enabled bool
State of the zone settings for Email Routing.
Id string
The provider-assigned unique ID for this managed resource.
Modified string
The date and time the settings have been modified.
Name string
Domain of your zone.
SkipWizard bool
Flag to check if the user skipped the configuration wizard.
Status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
Tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
Created string
The date and time the settings have been created.
Enabled bool
State of the zone settings for Email Routing.
Id string
The provider-assigned unique ID for this managed resource.
Modified string
The date and time the settings have been modified.
Name string
Domain of your zone.
SkipWizard bool
Flag to check if the user skipped the configuration wizard.
Status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
Tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
created String
The date and time the settings have been created.
enabled Boolean
State of the zone settings for Email Routing.
id String
The provider-assigned unique ID for this managed resource.
modified String
The date and time the settings have been modified.
name String
Domain of your zone.
skipWizard Boolean
Flag to check if the user skipped the configuration wizard.
status String
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag String
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
created string
The date and time the settings have been created.
enabled boolean
State of the zone settings for Email Routing.
id string
The provider-assigned unique ID for this managed resource.
modified string
The date and time the settings have been modified.
name string
Domain of your zone.
skipWizard boolean
Flag to check if the user skipped the configuration wizard.
status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
created str
The date and time the settings have been created.
enabled bool
State of the zone settings for Email Routing.
id str
The provider-assigned unique ID for this managed resource.
modified str
The date and time the settings have been modified.
name str
Domain of your zone.
skip_wizard bool
Flag to check if the user skipped the configuration wizard.
status str
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag str
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
created String
The date and time the settings have been created.
enabled Boolean
State of the zone settings for Email Routing.
id String
The provider-assigned unique ID for this managed resource.
modified String
The date and time the settings have been modified.
name String
Domain of your zone.
skipWizard Boolean
Flag to check if the user skipped the configuration wizard.
status String
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag String
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)

Look up Existing EmailRoutingSettings Resource

Get an existing EmailRoutingSettings 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?: EmailRoutingSettingsState, opts?: CustomResourceOptions): EmailRoutingSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        enabled: Optional[bool] = None,
        modified: Optional[str] = None,
        name: Optional[str] = None,
        skip_wizard: Optional[bool] = None,
        status: Optional[str] = None,
        tag: Optional[str] = None,
        zone_id: Optional[str] = None) -> EmailRoutingSettings
func GetEmailRoutingSettings(ctx *Context, name string, id IDInput, state *EmailRoutingSettingsState, opts ...ResourceOption) (*EmailRoutingSettings, error)
public static EmailRoutingSettings Get(string name, Input<string> id, EmailRoutingSettingsState? state, CustomResourceOptions? opts = null)
public static EmailRoutingSettings get(String name, Output<String> id, EmailRoutingSettingsState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:EmailRoutingSettings    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:
Created string
The date and time the settings have been created.
Enabled bool
State of the zone settings for Email Routing.
Modified string
The date and time the settings have been modified.
Name string
Domain of your zone.
SkipWizard bool
Flag to check if the user skipped the configuration wizard.
Status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
Tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
ZoneId string
Identifier
Created string
The date and time the settings have been created.
Enabled bool
State of the zone settings for Email Routing.
Modified string
The date and time the settings have been modified.
Name string
Domain of your zone.
SkipWizard bool
Flag to check if the user skipped the configuration wizard.
Status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
Tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
ZoneId string
Identifier
created String
The date and time the settings have been created.
enabled Boolean
State of the zone settings for Email Routing.
modified String
The date and time the settings have been modified.
name String
Domain of your zone.
skipWizard Boolean
Flag to check if the user skipped the configuration wizard.
status String
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag String
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
zoneId String
Identifier
created string
The date and time the settings have been created.
enabled boolean
State of the zone settings for Email Routing.
modified string
The date and time the settings have been modified.
name string
Domain of your zone.
skipWizard boolean
Flag to check if the user skipped the configuration wizard.
status string
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag string
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
zoneId string
Identifier
created str
The date and time the settings have been created.
enabled bool
State of the zone settings for Email Routing.
modified str
The date and time the settings have been modified.
name str
Domain of your zone.
skip_wizard bool
Flag to check if the user skipped the configuration wizard.
status str
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag str
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
zone_id str
Identifier
created String
The date and time the settings have been created.
enabled Boolean
State of the zone settings for Email Routing.
modified String
The date and time the settings have been modified.
name String
Domain of your zone.
skipWizard Boolean
Flag to check if the user skipped the configuration wizard.
status String
Show the state of your account, and the type or configuration error. Available values: "ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked".
tag String
Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
zoneId String
Identifier

Import

$ pulumi import cloudflare:index/emailRoutingSettings:EmailRoutingSettings 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.