Class Route
Provides a Mailgun Route resource. This can be used to create and manage routes on Mailgun.
Example Usage
using Pulumi;
using Mailgun = Pulumi.Mailgun;
class MyStack : Stack
{
public MyStack()
{
// Create a new Mailgun route
var @default = new Mailgun.Route("default", new Mailgun.RouteArgs
{
Actions =
{
"forward('http://example.com/api/v1/foos/')",
"stop()",
},
Description = "inbound",
Expression = "match_recipient('.*@foo.example.com')",
Priority = "0",
});
}
}
Inherited Members
Namespace: Pulumi.Mailgun
Assembly: Pulumi.Mailgun.dll
Syntax
public class Route : CustomResource
Constructors
View SourceRoute(String, RouteArgs, CustomResourceOptions)
Create a Route resource with the given unique name, arguments, and options.
Declaration
public Route(string name, RouteArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| RouteArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceActions
Declaration
public Output<ImmutableArray<string>> Actions { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<System.String>> |
Description
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Expression
A filter expression like match_recipient('.*@gmail.com')
Declaration
public Output<string> Expression { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Priority
Smaller number indicates higher priority. Higher priority routes are handled first.
Declaration
public Output<int> Priority { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
Region
The region where domain will be created. Default value is us.
Declaration
public Output<string> Region { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, RouteState, CustomResourceOptions)
Get an existing Route resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Route Get(string name, Input<string> id, RouteState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| RouteState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Route |