Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. EmailRoutingSettings
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.EmailRoutingSettings

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

    Provides a resource for managing Email Routing settings.

    Example Usage

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

const myZone = new cloudflare.EmailRoutingSettings("my_zone", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    enabled: true,
});

    import pulumi
import pulumi_cloudflare as cloudflare

my_zone = cloudflare.EmailRoutingSettings("my_zone",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    enabled=True)

    package main

import (
	"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.NewEmailRoutingSettings(ctx, "my_zone", &cloudflare.EmailRoutingSettingsArgs{
			ZoneId:  pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var myZone = new Cloudflare.EmailRoutingSettings("my_zone", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Enabled = true,
    });

});

    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 myZone = new EmailRoutingSettings("myZone", EmailRoutingSettingsArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .enabled("true")
            .build());

    }
}

    resources:
  myZone:
    type: cloudflare:EmailRoutingSettings
    name: my_zone
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      enabled: 'true'

    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,
                         enabled: Optional[bool] = None,
                         zone_id: Optional[str] = None,
                         skip_wizard: Optional[bool] = 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 string
    The unique name of the resource.
    args EmailRoutingSettingsArgs
    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 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 string
    The unique name of the resource.
    args EmailRoutingSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailRoutingSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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()
{
    Enabled = false,
    ZoneId = "string",
    SkipWizard = false,
});

    example, err := cloudflare.NewEmailRoutingSettings(ctx, "emailRoutingSettingsResource", &cloudflare.EmailRoutingSettingsArgs{
	Enabled:    pulumi.Bool(false),
	ZoneId:     pulumi.String("string"),
	SkipWizard: pulumi.Bool(false),
})

    var emailRoutingSettingsResource = new EmailRoutingSettings("emailRoutingSettingsResource", EmailRoutingSettingsArgs.builder()
    .enabled(false)
    .zoneId("string")
    .skipWizard(false)
    .build());

    email_routing_settings_resource = cloudflare.EmailRoutingSettings("emailRoutingSettingsResource",
    enabled=False,
    zone_id="string",
    skip_wizard=False)

    const emailRoutingSettingsResource = new cloudflare.EmailRoutingSettings("emailRoutingSettingsResource", {
    enabled: false,
    zoneId: "string",
    skipWizard: false,
});

    type: cloudflare:EmailRoutingSettings
properties:
    enabled: false
    skipWizard: false
    zoneId: string

    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:

    Enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    SkipWizard bool
    Flag to check if the user skipped the configuration wizard.
    Enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    SkipWizard bool
    Flag to check if the user skipped the configuration wizard.
    enabled Boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    skipWizard Boolean
    Flag to check if the user skipped the configuration wizard.
    enabled boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    skipWizard boolean
    Flag to check if the user skipped the configuration wizard.
    enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    skip_wizard bool
    Flag to check if the user skipped the configuration wizard.
    enabled Boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new resource.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    skipWizard Boolean
    Flag to check if the user skipped the configuration wizard.

    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.
    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.
    Status string
    Show the state of your account, and the type or configuration error.
    Tag string
    Email Routing settings identifier.
    Created string
    The date and time the settings have been created.
    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.
    Status string
    Show the state of your account, and the type or configuration error.
    Tag string
    Email Routing settings identifier.
    created String
    The date and time the settings have been created.
    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.
    status String
    Show the state of your account, and the type or configuration error.
    tag String
    Email Routing settings identifier.
    created string
    The date and time the settings have been created.
    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.
    status string
    Show the state of your account, and the type or configuration error.
    tag string
    Email Routing settings identifier.
    created str
    The date and time the settings have been created.
    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.
    status str
    Show the state of your account, and the type or configuration error.
    tag str
    Email Routing settings identifier.
    created String
    The date and time the settings have been created.
    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.
    status String
    Show the state of your account, and the type or configuration error.
    tag String
    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)
    Resource lookup is not supported in YAML
    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:
    Created string
    The date and time the settings have been created.
    Enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    Tag string
    Email Routing settings identifier.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    Created string
    The date and time the settings have been created.
    Enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    Tag string
    Email Routing settings identifier.
    ZoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    created String
    The date and time the settings have been created.
    enabled Boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    tag String
    Email Routing settings identifier.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    created string
    The date and time the settings have been created.
    enabled boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    tag string
    Email Routing settings identifier.
    zoneId string
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    created str
    The date and time the settings have been created.
    enabled bool
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    tag str
    Email Routing settings identifier.
    zone_id str
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
    created String
    The date and time the settings have been created.
    enabled Boolean
    State of the zone settings for Email Routing. Modifying this attribute will force creation of a new 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.
    tag String
    Email Routing settings identifier.
    zoneId String
    The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
    pulumi/pulumi-cloudflare