1. Packages
  2. Gandi
  3. API Docs
  4. email
  5. Forwarding
Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse

gandi.email.Forwarding

Explore with Pulumi AI

gandi logo
Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse

    Create Forwarding Resource

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

    Constructor syntax

    new Forwarding(name: string, args: ForwardingArgs, opts?: CustomResourceOptions);
    @overload
    def Forwarding(resource_name: str,
                   args: ForwardingArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Forwarding(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   destinations: Optional[Sequence[str]] = None,
                   source: Optional[str] = None)
    func NewForwarding(ctx *Context, name string, args ForwardingArgs, opts ...ResourceOption) (*Forwarding, error)
    public Forwarding(string name, ForwardingArgs args, CustomResourceOptions? opts = null)
    public Forwarding(String name, ForwardingArgs args)
    public Forwarding(String name, ForwardingArgs args, CustomResourceOptions options)
    
    type: gandi:email:Forwarding
    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 ForwardingArgs
    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 ForwardingArgs
    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 ForwardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForwardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForwardingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var forwardingResource = new Gandi.Email.Forwarding("forwardingResource", new()
    {
        Destinations = new[]
        {
            "string",
        },
        Source = "string",
    });
    
    example, err := email.NewForwarding(ctx, "forwardingResource", &email.ForwardingArgs{
    	Destinations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Source: pulumi.String("string"),
    })
    
    var forwardingResource = new Forwarding("forwardingResource", ForwardingArgs.builder()        
        .destinations("string")
        .source("string")
        .build());
    
    forwarding_resource = gandi.email.Forwarding("forwardingResource",
        destinations=["string"],
        source="string")
    
    const forwardingResource = new gandi.email.Forwarding("forwardingResource", {
        destinations: ["string"],
        source: "string",
    });
    
    type: gandi:email:Forwarding
    properties:
        destinations:
            - string
        source: string
    

    Forwarding Resource Properties

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

    Inputs

    The Forwarding resource accepts the following input properties:

    Destinations List<string>
    Forwards to email addresses
    Source string
    Account alias name
    Destinations []string
    Forwards to email addresses
    Source string
    Account alias name
    destinations List<String>
    Forwards to email addresses
    source String
    Account alias name
    destinations string[]
    Forwards to email addresses
    source string
    Account alias name
    destinations Sequence[str]
    Forwards to email addresses
    source str
    Account alias name
    destinations List<String>
    Forwards to email addresses
    source String
    Account alias name

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Forwarding Resource

    Get an existing Forwarding 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?: ForwardingState, opts?: CustomResourceOptions): Forwarding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            destinations: Optional[Sequence[str]] = None,
            source: Optional[str] = None) -> Forwarding
    func GetForwarding(ctx *Context, name string, id IDInput, state *ForwardingState, opts ...ResourceOption) (*Forwarding, error)
    public static Forwarding Get(string name, Input<string> id, ForwardingState? state, CustomResourceOptions? opts = null)
    public static Forwarding get(String name, Output<String> id, ForwardingState 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:
    Destinations List<string>
    Forwards to email addresses
    Source string
    Account alias name
    Destinations []string
    Forwards to email addresses
    Source string
    Account alias name
    destinations List<String>
    Forwards to email addresses
    source String
    Account alias name
    destinations string[]
    Forwards to email addresses
    source string
    Account alias name
    destinations Sequence[str]
    Forwards to email addresses
    source str
    Account alias name
    destinations List<String>
    Forwards to email addresses
    source String
    Account alias name

    Package Details

    Repository
    gandi pulumiverse/pulumi-gandi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gandi Terraform Provider.
    gandi logo
    Gandi v0.0.14 published on Saturday, Dec 17, 2022 by Pulumiverse