mailgun

package
v2.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing Mailgun resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PkgVersion added in v2.4.0 

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package.

Types

type Domain 

type Domain struct {
	pulumi.CustomResourceState

	// The domain to add to Mailgun
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of DNS records for receiving validation.
	ReceivingRecords DomainReceivingRecordArrayOutput `pulumi:"receivingRecords"`
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrOutput `pulumi:"region"`
	// A list of DNS records for sending validation.
	SendingRecords DomainSendingRecordArrayOutput `pulumi:"sendingRecords"`
	// The login email for the SMTP server.
	SmtpLogin pulumi.StringOutput `pulumi:"smtpLogin"`
	// Password for SMTP authentication
	SmtpPassword pulumi.StringPtrOutput `pulumi:"smtpPassword"`
	// `disabled` or `tag` Disable, no spam
	// filtering will occur for inbound messages. Tag, messages
	// will be tagged with a spam header.
	SpamAction pulumi.StringPtrOutput `pulumi:"spamAction"`
	// Boolean that determines whether
	// the domain will accept email for sub-domains.
	Wildcard pulumi.BoolPtrOutput `pulumi:"wildcard"`
}

Provides a Mailgun App resource. This can be used to create and manage applications on Mailgun.

After DNS records are set, domain verification should be triggered manually using [PUT /domains/\<domain\>/verify](https://documentation.mailgun.com/en/latest/api-domains.html#domains)

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-mailgun/sdk/v2/go/mailgun"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mailgun.NewDomain(ctx, "_default", &mailgun.DomainArgs{
			Region:       pulumi.String("us"),
			SmtpPassword: pulumi.String("supersecretpassword1234"),
			SpamAction:   pulumi.String("disabled"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Domains can be imported using `region:domain_name` via `import` command. Region has to be chosen from `eu` or `us` (when no selection `us` is applied).

hcl

```sh 

$ pulumi import mailgun:index/domain:Domain test us:example.domain.com

```

func GetDomain 

func GetDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainState, opts ...pulumi.ResourceOption) (*Domain, error)

GetDomain gets an existing Domain resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDomain 

func NewDomain(ctx *pulumi.Context,
	name string, args *DomainArgs, opts ...pulumi.ResourceOption) (*Domain, error)

NewDomain registers a new resource with the given unique name, arguments, and options.

func (*Domain) ElementType added in v2.3.1 

func (*Domain) ElementType() reflect.Type

func (*Domain) ToDomainOutput added in v2.3.1 

func (i *Domain) ToDomainOutput() DomainOutput

func (*Domain) ToDomainOutputWithContext added in v2.3.1 

func (i *Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput

func (*Domain) ToDomainPtrOutput added in v2.4.1 

func (i *Domain) ToDomainPtrOutput() DomainPtrOutput

func (*Domain) ToDomainPtrOutputWithContext added in v2.4.1 

func (i *Domain) ToDomainPtrOutputWithContext(ctx context.Context) DomainPtrOutput

type DomainArgs 

type DomainArgs struct {
	// The domain to add to Mailgun
	Name pulumi.StringPtrInput
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrInput
	// Password for SMTP authentication
	SmtpPassword pulumi.StringPtrInput
	// `disabled` or `tag` Disable, no spam
	// filtering will occur for inbound messages. Tag, messages
	// will be tagged with a spam header.
	SpamAction pulumi.StringPtrInput
	// Boolean that determines whether
	// the domain will accept email for sub-domains.
	Wildcard pulumi.BoolPtrInput
}

The set of arguments for constructing a Domain resource.

func (DomainArgs) ElementType 

func (DomainArgs) ElementType() reflect.Type

type DomainArray added in v2.4.1 

type DomainArray []DomainInput

func (DomainArray) ElementType added in v2.4.1 

func (DomainArray) ElementType() reflect.Type

func (DomainArray) ToDomainArrayOutput added in v2.4.1 

func (i DomainArray) ToDomainArrayOutput() DomainArrayOutput

func (DomainArray) ToDomainArrayOutputWithContext added in v2.4.1 

func (i DomainArray) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput

type DomainArrayInput added in v2.4.1 

type DomainArrayInput interface {
	pulumi.Input

	ToDomainArrayOutput() DomainArrayOutput
	ToDomainArrayOutputWithContext(context.Context) DomainArrayOutput
}

DomainArrayInput is an input type that accepts DomainArray and DomainArrayOutput values. You can construct a concrete instance of `DomainArrayInput` via: 

DomainArray{ DomainArgs{...} }

type DomainArrayOutput added in v2.4.1 

type DomainArrayOutput struct{ *pulumi.OutputState }

func (DomainArrayOutput) ElementType added in v2.4.1 

func (DomainArrayOutput) ElementType() reflect.Type

func (DomainArrayOutput) Index added in v2.4.1 

func (o DomainArrayOutput) Index(i pulumi.IntInput) DomainOutput

func (DomainArrayOutput) ToDomainArrayOutput added in v2.4.1 

func (o DomainArrayOutput) ToDomainArrayOutput() DomainArrayOutput

func (DomainArrayOutput) ToDomainArrayOutputWithContext added in v2.4.1 

func (o DomainArrayOutput) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput

type DomainInput added in v2.3.1 

type DomainInput interface {
	pulumi.Input

	ToDomainOutput() DomainOutput
	ToDomainOutputWithContext(ctx context.Context) DomainOutput
}

type DomainMap added in v2.4.1 

type DomainMap map[string]DomainInput

func (DomainMap) ElementType added in v2.4.1 

func (DomainMap) ElementType() reflect.Type

func (DomainMap) ToDomainMapOutput added in v2.4.1 

func (i DomainMap) ToDomainMapOutput() DomainMapOutput

func (DomainMap) ToDomainMapOutputWithContext added in v2.4.1 

func (i DomainMap) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput

type DomainMapInput added in v2.4.1 

type DomainMapInput interface {
	pulumi.Input

	ToDomainMapOutput() DomainMapOutput
	ToDomainMapOutputWithContext(context.Context) DomainMapOutput
}

DomainMapInput is an input type that accepts DomainMap and DomainMapOutput values. You can construct a concrete instance of `DomainMapInput` via: 

DomainMap{ "key": DomainArgs{...} }

type DomainMapOutput added in v2.4.1 

type DomainMapOutput struct{ *pulumi.OutputState }

func (DomainMapOutput) ElementType added in v2.4.1 

func (DomainMapOutput) ElementType() reflect.Type

func (DomainMapOutput) MapIndex added in v2.4.1 

func (o DomainMapOutput) MapIndex(k pulumi.StringInput) DomainOutput

func (DomainMapOutput) ToDomainMapOutput added in v2.4.1 

func (o DomainMapOutput) ToDomainMapOutput() DomainMapOutput

func (DomainMapOutput) ToDomainMapOutputWithContext added in v2.4.1 

func (o DomainMapOutput) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput

type DomainOutput added in v2.3.1 

type DomainOutput struct {
	*pulumi.OutputState
}

func (DomainOutput) ElementType added in v2.3.1 

func (DomainOutput) ElementType() reflect.Type

func (DomainOutput) ToDomainOutput added in v2.3.1 

func (o DomainOutput) ToDomainOutput() DomainOutput

func (DomainOutput) ToDomainOutputWithContext added in v2.3.1 

func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput

func (DomainOutput) ToDomainPtrOutput added in v2.4.1 

func (o DomainOutput) ToDomainPtrOutput() DomainPtrOutput

func (DomainOutput) ToDomainPtrOutputWithContext added in v2.4.1 

func (o DomainOutput) ToDomainPtrOutputWithContext(ctx context.Context) DomainPtrOutput

type DomainPtrInput added in v2.4.1 

type DomainPtrInput interface {
	pulumi.Input

	ToDomainPtrOutput() DomainPtrOutput
	ToDomainPtrOutputWithContext(ctx context.Context) DomainPtrOutput
}

type DomainPtrOutput added in v2.4.1 

type DomainPtrOutput struct {
	*pulumi.OutputState
}

func (DomainPtrOutput) ElementType added in v2.4.1 

func (DomainPtrOutput) ElementType() reflect.Type

func (DomainPtrOutput) ToDomainPtrOutput added in v2.4.1 

func (o DomainPtrOutput) ToDomainPtrOutput() DomainPtrOutput

func (DomainPtrOutput) ToDomainPtrOutputWithContext added in v2.4.1 

func (o DomainPtrOutput) ToDomainPtrOutputWithContext(ctx context.Context) DomainPtrOutput

type DomainReceivingRecord 

type DomainReceivingRecord struct {
	// The priority of the record.
	Priority *string `pulumi:"priority"`
	// The record type.
	RecordType *string `pulumi:"recordType"`
	// `"valid"` if the record is valid.
	Valid *string `pulumi:"valid"`
	// The value of the record.
	Value *string `pulumi:"value"`
}

type DomainReceivingRecordArgs 

type DomainReceivingRecordArgs struct {
	// The priority of the record.
	Priority pulumi.StringPtrInput `pulumi:"priority"`
	// The record type.
	RecordType pulumi.StringPtrInput `pulumi:"recordType"`
	// `"valid"` if the record is valid.
	Valid pulumi.StringPtrInput `pulumi:"valid"`
	// The value of the record.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (DomainReceivingRecordArgs) ElementType 

func (DomainReceivingRecordArgs) ElementType() reflect.Type

func (DomainReceivingRecordArgs) ToDomainReceivingRecordOutput 

func (i DomainReceivingRecordArgs) ToDomainReceivingRecordOutput() DomainReceivingRecordOutput

func (DomainReceivingRecordArgs) ToDomainReceivingRecordOutputWithContext 

func (i DomainReceivingRecordArgs) ToDomainReceivingRecordOutputWithContext(ctx context.Context) DomainReceivingRecordOutput

type DomainReceivingRecordArray 

type DomainReceivingRecordArray []DomainReceivingRecordInput

func (DomainReceivingRecordArray) ElementType 

func (DomainReceivingRecordArray) ElementType() reflect.Type

func (DomainReceivingRecordArray) ToDomainReceivingRecordArrayOutput 

func (i DomainReceivingRecordArray) ToDomainReceivingRecordArrayOutput() DomainReceivingRecordArrayOutput

func (DomainReceivingRecordArray) ToDomainReceivingRecordArrayOutputWithContext 

func (i DomainReceivingRecordArray) ToDomainReceivingRecordArrayOutputWithContext(ctx context.Context) DomainReceivingRecordArrayOutput

type DomainReceivingRecordArrayInput 

type DomainReceivingRecordArrayInput interface {
	pulumi.Input

	ToDomainReceivingRecordArrayOutput() DomainReceivingRecordArrayOutput
	ToDomainReceivingRecordArrayOutputWithContext(context.Context) DomainReceivingRecordArrayOutput
}

DomainReceivingRecordArrayInput is an input type that accepts DomainReceivingRecordArray and DomainReceivingRecordArrayOutput values. You can construct a concrete instance of `DomainReceivingRecordArrayInput` via: 

DomainReceivingRecordArray{ DomainReceivingRecordArgs{...} }

type DomainReceivingRecordArrayOutput 

type DomainReceivingRecordArrayOutput struct{ *pulumi.OutputState }

func (DomainReceivingRecordArrayOutput) ElementType 

func (DomainReceivingRecordArrayOutput) ElementType() reflect.Type

func (DomainReceivingRecordArrayOutput) Index 

func (o DomainReceivingRecordArrayOutput) Index(i pulumi.IntInput) DomainReceivingRecordOutput

func (DomainReceivingRecordArrayOutput) ToDomainReceivingRecordArrayOutput 

func (o DomainReceivingRecordArrayOutput) ToDomainReceivingRecordArrayOutput() DomainReceivingRecordArrayOutput

func (DomainReceivingRecordArrayOutput) ToDomainReceivingRecordArrayOutputWithContext 

func (o DomainReceivingRecordArrayOutput) ToDomainReceivingRecordArrayOutputWithContext(ctx context.Context) DomainReceivingRecordArrayOutput

type DomainReceivingRecordInput 

type DomainReceivingRecordInput interface {
	pulumi.Input

	ToDomainReceivingRecordOutput() DomainReceivingRecordOutput
	ToDomainReceivingRecordOutputWithContext(context.Context) DomainReceivingRecordOutput
}

DomainReceivingRecordInput is an input type that accepts DomainReceivingRecordArgs and DomainReceivingRecordOutput values. You can construct a concrete instance of `DomainReceivingRecordInput` via: 

DomainReceivingRecordArgs{...}

type DomainReceivingRecordOutput 

type DomainReceivingRecordOutput struct{ *pulumi.OutputState }

func (DomainReceivingRecordOutput) ElementType 

func (DomainReceivingRecordOutput) ElementType() reflect.Type

func (DomainReceivingRecordOutput) Priority 

func (o DomainReceivingRecordOutput) Priority() pulumi.StringPtrOutput

The priority of the record.

func (DomainReceivingRecordOutput) RecordType 

func (o DomainReceivingRecordOutput) RecordType() pulumi.StringPtrOutput

The record type.

func (DomainReceivingRecordOutput) ToDomainReceivingRecordOutput 

func (o DomainReceivingRecordOutput) ToDomainReceivingRecordOutput() DomainReceivingRecordOutput

func (DomainReceivingRecordOutput) ToDomainReceivingRecordOutputWithContext 

func (o DomainReceivingRecordOutput) ToDomainReceivingRecordOutputWithContext(ctx context.Context) DomainReceivingRecordOutput

func (DomainReceivingRecordOutput) Valid 

func (o DomainReceivingRecordOutput) Valid() pulumi.StringPtrOutput

`"valid"` if the record is valid.

func (DomainReceivingRecordOutput) Value 

func (o DomainReceivingRecordOutput) Value() pulumi.StringPtrOutput

The value of the record.

type DomainSendingRecord 

type DomainSendingRecord struct {
	// The domain to add to Mailgun
	Name *string `pulumi:"name"`
	// The record type.
	RecordType *string `pulumi:"recordType"`
	// `"valid"` if the record is valid.
	Valid *string `pulumi:"valid"`
	// The value of the record.
	Value *string `pulumi:"value"`
}

type DomainSendingRecordArgs 

type DomainSendingRecordArgs struct {
	// The domain to add to Mailgun
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The record type.
	RecordType pulumi.StringPtrInput `pulumi:"recordType"`
	// `"valid"` if the record is valid.
	Valid pulumi.StringPtrInput `pulumi:"valid"`
	// The value of the record.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

func (DomainSendingRecordArgs) ElementType 

func (DomainSendingRecordArgs) ElementType() reflect.Type

func (DomainSendingRecordArgs) ToDomainSendingRecordOutput 

func (i DomainSendingRecordArgs) ToDomainSendingRecordOutput() DomainSendingRecordOutput

func (DomainSendingRecordArgs) ToDomainSendingRecordOutputWithContext 

func (i DomainSendingRecordArgs) ToDomainSendingRecordOutputWithContext(ctx context.Context) DomainSendingRecordOutput

type DomainSendingRecordArray 

type DomainSendingRecordArray []DomainSendingRecordInput

func (DomainSendingRecordArray) ElementType 

func (DomainSendingRecordArray) ElementType() reflect.Type

func (DomainSendingRecordArray) ToDomainSendingRecordArrayOutput 

func (i DomainSendingRecordArray) ToDomainSendingRecordArrayOutput() DomainSendingRecordArrayOutput

func (DomainSendingRecordArray) ToDomainSendingRecordArrayOutputWithContext 

func (i DomainSendingRecordArray) ToDomainSendingRecordArrayOutputWithContext(ctx context.Context) DomainSendingRecordArrayOutput

type DomainSendingRecordArrayInput 

type DomainSendingRecordArrayInput interface {
	pulumi.Input

	ToDomainSendingRecordArrayOutput() DomainSendingRecordArrayOutput
	ToDomainSendingRecordArrayOutputWithContext(context.Context) DomainSendingRecordArrayOutput
}

DomainSendingRecordArrayInput is an input type that accepts DomainSendingRecordArray and DomainSendingRecordArrayOutput values. You can construct a concrete instance of `DomainSendingRecordArrayInput` via: 

DomainSendingRecordArray{ DomainSendingRecordArgs{...} }

type DomainSendingRecordArrayOutput 

type DomainSendingRecordArrayOutput struct{ *pulumi.OutputState }

func (DomainSendingRecordArrayOutput) ElementType 

func (DomainSendingRecordArrayOutput) ElementType() reflect.Type

func (DomainSendingRecordArrayOutput) Index 

func (o DomainSendingRecordArrayOutput) Index(i pulumi.IntInput) DomainSendingRecordOutput

func (DomainSendingRecordArrayOutput) ToDomainSendingRecordArrayOutput 

func (o DomainSendingRecordArrayOutput) ToDomainSendingRecordArrayOutput() DomainSendingRecordArrayOutput

func (DomainSendingRecordArrayOutput) ToDomainSendingRecordArrayOutputWithContext 

func (o DomainSendingRecordArrayOutput) ToDomainSendingRecordArrayOutputWithContext(ctx context.Context) DomainSendingRecordArrayOutput

type DomainSendingRecordInput 

type DomainSendingRecordInput interface {
	pulumi.Input

	ToDomainSendingRecordOutput() DomainSendingRecordOutput
	ToDomainSendingRecordOutputWithContext(context.Context) DomainSendingRecordOutput
}

DomainSendingRecordInput is an input type that accepts DomainSendingRecordArgs and DomainSendingRecordOutput values. You can construct a concrete instance of `DomainSendingRecordInput` via: 

DomainSendingRecordArgs{...}

type DomainSendingRecordOutput 

type DomainSendingRecordOutput struct{ *pulumi.OutputState }

func (DomainSendingRecordOutput) ElementType 

func (DomainSendingRecordOutput) ElementType() reflect.Type

func (DomainSendingRecordOutput) Name 

func (o DomainSendingRecordOutput) Name() pulumi.StringPtrOutput

The domain to add to Mailgun

func (DomainSendingRecordOutput) RecordType 

func (o DomainSendingRecordOutput) RecordType() pulumi.StringPtrOutput

The record type.

func (DomainSendingRecordOutput) ToDomainSendingRecordOutput 

func (o DomainSendingRecordOutput) ToDomainSendingRecordOutput() DomainSendingRecordOutput

func (DomainSendingRecordOutput) ToDomainSendingRecordOutputWithContext 

func (o DomainSendingRecordOutput) ToDomainSendingRecordOutputWithContext(ctx context.Context) DomainSendingRecordOutput

func (DomainSendingRecordOutput) Valid 

func (o DomainSendingRecordOutput) Valid() pulumi.StringPtrOutput

`"valid"` if the record is valid.

func (DomainSendingRecordOutput) Value 

func (o DomainSendingRecordOutput) Value() pulumi.StringPtrOutput

The value of the record.

type DomainState 

type DomainState struct {
	// The domain to add to Mailgun
	Name pulumi.StringPtrInput
	// A list of DNS records for receiving validation.
	ReceivingRecords DomainReceivingRecordArrayInput
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrInput
	// A list of DNS records for sending validation.
	SendingRecords DomainSendingRecordArrayInput
	// The login email for the SMTP server.
	SmtpLogin pulumi.StringPtrInput
	// Password for SMTP authentication
	SmtpPassword pulumi.StringPtrInput
	// `disabled` or `tag` Disable, no spam
	// filtering will occur for inbound messages. Tag, messages
	// will be tagged with a spam header.
	SpamAction pulumi.StringPtrInput
	// Boolean that determines whether
	// the domain will accept email for sub-domains.
	Wildcard pulumi.BoolPtrInput
}

func (DomainState) ElementType 

func (DomainState) ElementType() reflect.Type

type Provider 

type Provider struct {
	pulumi.ProviderResourceState
}

The provider type for the mailgun package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType added in v2.3.1 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput added in v2.3.1 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext added in v2.3.1 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (*Provider) ToProviderPtrOutput added in v2.4.1 

func (i *Provider) ToProviderPtrOutput() ProviderPtrOutput

func (*Provider) ToProviderPtrOutputWithContext added in v2.4.1 

func (i *Provider) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderArgs 

type ProviderArgs struct {
	ApiKey pulumi.StringInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput added in v2.3.1 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput added in v2.3.1 

type ProviderOutput struct {
	*pulumi.OutputState
}

func (ProviderOutput) ElementType added in v2.3.1 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput added in v2.3.1 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext added in v2.3.1 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

func (ProviderOutput) ToProviderPtrOutput added in v2.4.1 

func (o ProviderOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderOutput) ToProviderPtrOutputWithContext added in v2.4.1 

func (o ProviderOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type ProviderPtrInput added in v2.4.1 

type ProviderPtrInput interface {
	pulumi.Input

	ToProviderPtrOutput() ProviderPtrOutput
	ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput
}

type ProviderPtrOutput added in v2.4.1 

type ProviderPtrOutput struct {
	*pulumi.OutputState
}

func (ProviderPtrOutput) ElementType added in v2.4.1 

func (ProviderPtrOutput) ElementType() reflect.Type

func (ProviderPtrOutput) ToProviderPtrOutput added in v2.4.1 

func (o ProviderPtrOutput) ToProviderPtrOutput() ProviderPtrOutput

func (ProviderPtrOutput) ToProviderPtrOutputWithContext added in v2.4.1 

func (o ProviderPtrOutput) ToProviderPtrOutputWithContext(ctx context.Context) ProviderPtrOutput

type Route 

type Route struct {
	pulumi.CustomResourceState

	Actions     pulumi.StringArrayOutput `pulumi:"actions"`
	Description pulumi.StringPtrOutput   `pulumi:"description"`
	// A filter expression like `match_recipient('.*@gmail.com')`
	Expression pulumi.StringOutput `pulumi:"expression"`
	// Smaller number indicates higher priority. Higher priority routes are handled first.
	Priority pulumi.IntOutput `pulumi:"priority"`
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrOutput `pulumi:"region"`
}

Provides a Mailgun Route resource. This can be used to create and manage routes on Mailgun.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-mailgun/sdk/v2/go/mailgun"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mailgun.NewRoute(ctx, "_default", &mailgun.RouteArgs{
			Actions: pulumi.StringArray{
				pulumi.String("forward('http://example.com/api/v1/foos/')"),
				pulumi.String("stop()"),
			},
			Description: pulumi.String("inbound"),
			Expression:  pulumi.String("match_recipient('.*@foo.example.com')"),
			Priority:    pulumi.Int(0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Routes can be imported using `ROUTE_ID` and `region` via `import` command. Route ID can be found on Mailgun portal in section `Receiving/Routes`. Region has to be chosen from `eu` or `us` (when no selection `us` is applied).

hcl

```sh 

$ pulumi import mailgun:index/route:Route test eu:123456789

```

func GetRoute 

func GetRoute(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *RouteState, opts ...pulumi.ResourceOption) (*Route, error)

GetRoute gets an existing Route resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewRoute 

func NewRoute(ctx *pulumi.Context,
	name string, args *RouteArgs, opts ...pulumi.ResourceOption) (*Route, error)

NewRoute registers a new resource with the given unique name, arguments, and options.

func (*Route) ElementType added in v2.3.1 

func (*Route) ElementType() reflect.Type

func (*Route) ToRouteOutput added in v2.3.1 

func (i *Route) ToRouteOutput() RouteOutput

func (*Route) ToRouteOutputWithContext added in v2.3.1 

func (i *Route) ToRouteOutputWithContext(ctx context.Context) RouteOutput

func (*Route) ToRoutePtrOutput added in v2.4.1 

func (i *Route) ToRoutePtrOutput() RoutePtrOutput

func (*Route) ToRoutePtrOutputWithContext added in v2.4.1 

func (i *Route) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput

type RouteArgs 

type RouteArgs struct {
	Actions     pulumi.StringArrayInput
	Description pulumi.StringPtrInput
	// A filter expression like `match_recipient('.*@gmail.com')`
	Expression pulumi.StringInput
	// Smaller number indicates higher priority. Higher priority routes are handled first.
	Priority pulumi.IntInput
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrInput
}

The set of arguments for constructing a Route resource.

func (RouteArgs) ElementType 

func (RouteArgs) ElementType() reflect.Type

type RouteArray added in v2.4.1 

type RouteArray []RouteInput

func (RouteArray) ElementType added in v2.4.1 

func (RouteArray) ElementType() reflect.Type

func (RouteArray) ToRouteArrayOutput added in v2.4.1 

func (i RouteArray) ToRouteArrayOutput() RouteArrayOutput

func (RouteArray) ToRouteArrayOutputWithContext added in v2.4.1 

func (i RouteArray) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput

type RouteArrayInput added in v2.4.1 

type RouteArrayInput interface {
	pulumi.Input

	ToRouteArrayOutput() RouteArrayOutput
	ToRouteArrayOutputWithContext(context.Context) RouteArrayOutput
}

RouteArrayInput is an input type that accepts RouteArray and RouteArrayOutput values. You can construct a concrete instance of `RouteArrayInput` via: 

RouteArray{ RouteArgs{...} }

type RouteArrayOutput added in v2.4.1 

type RouteArrayOutput struct{ *pulumi.OutputState }

func (RouteArrayOutput) ElementType added in v2.4.1 

func (RouteArrayOutput) ElementType() reflect.Type

func (RouteArrayOutput) Index added in v2.4.1 

func (o RouteArrayOutput) Index(i pulumi.IntInput) RouteOutput

func (RouteArrayOutput) ToRouteArrayOutput added in v2.4.1 

func (o RouteArrayOutput) ToRouteArrayOutput() RouteArrayOutput

func (RouteArrayOutput) ToRouteArrayOutputWithContext added in v2.4.1 

func (o RouteArrayOutput) ToRouteArrayOutputWithContext(ctx context.Context) RouteArrayOutput

type RouteInput added in v2.3.1 

type RouteInput interface {
	pulumi.Input

	ToRouteOutput() RouteOutput
	ToRouteOutputWithContext(ctx context.Context) RouteOutput
}

type RouteMap added in v2.4.1 

type RouteMap map[string]RouteInput

func (RouteMap) ElementType added in v2.4.1 

func (RouteMap) ElementType() reflect.Type

func (RouteMap) ToRouteMapOutput added in v2.4.1 

func (i RouteMap) ToRouteMapOutput() RouteMapOutput

func (RouteMap) ToRouteMapOutputWithContext added in v2.4.1 

func (i RouteMap) ToRouteMapOutputWithContext(ctx context.Context) RouteMapOutput

type RouteMapInput added in v2.4.1 

type RouteMapInput interface {
	pulumi.Input

	ToRouteMapOutput() RouteMapOutput
	ToRouteMapOutputWithContext(context.Context) RouteMapOutput
}

RouteMapInput is an input type that accepts RouteMap and RouteMapOutput values. You can construct a concrete instance of `RouteMapInput` via: 

RouteMap{ "key": RouteArgs{...} }

type RouteMapOutput added in v2.4.1 

type RouteMapOutput struct{ *pulumi.OutputState }

func (RouteMapOutput) ElementType added in v2.4.1 

func (RouteMapOutput) ElementType() reflect.Type

func (RouteMapOutput) MapIndex added in v2.4.1 

func (o RouteMapOutput) MapIndex(k pulumi.StringInput) RouteOutput

func (RouteMapOutput) ToRouteMapOutput added in v2.4.1 

func (o RouteMapOutput) ToRouteMapOutput() RouteMapOutput

func (RouteMapOutput) ToRouteMapOutputWithContext added in v2.4.1 

func (o RouteMapOutput) ToRouteMapOutputWithContext(ctx context.Context) RouteMapOutput

type RouteOutput added in v2.3.1 

type RouteOutput struct {
	*pulumi.OutputState
}

func (RouteOutput) ElementType added in v2.3.1 

func (RouteOutput) ElementType() reflect.Type

func (RouteOutput) ToRouteOutput added in v2.3.1 

func (o RouteOutput) ToRouteOutput() RouteOutput

func (RouteOutput) ToRouteOutputWithContext added in v2.3.1 

func (o RouteOutput) ToRouteOutputWithContext(ctx context.Context) RouteOutput

func (RouteOutput) ToRoutePtrOutput added in v2.4.1 

func (o RouteOutput) ToRoutePtrOutput() RoutePtrOutput

func (RouteOutput) ToRoutePtrOutputWithContext added in v2.4.1 

func (o RouteOutput) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput

type RoutePtrInput added in v2.4.1 

type RoutePtrInput interface {
	pulumi.Input

	ToRoutePtrOutput() RoutePtrOutput
	ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput
}

type RoutePtrOutput added in v2.4.1 

type RoutePtrOutput struct {
	*pulumi.OutputState
}

func (RoutePtrOutput) ElementType added in v2.4.1 

func (RoutePtrOutput) ElementType() reflect.Type

func (RoutePtrOutput) ToRoutePtrOutput added in v2.4.1 

func (o RoutePtrOutput) ToRoutePtrOutput() RoutePtrOutput

func (RoutePtrOutput) ToRoutePtrOutputWithContext added in v2.4.1 

func (o RoutePtrOutput) ToRoutePtrOutputWithContext(ctx context.Context) RoutePtrOutput

type RouteState 

type RouteState struct {
	Actions     pulumi.StringArrayInput
	Description pulumi.StringPtrInput
	// A filter expression like `match_recipient('.*@gmail.com')`
	Expression pulumi.StringPtrInput
	// Smaller number indicates higher priority. Higher priority routes are handled first.
	Priority pulumi.IntPtrInput
	// The region where domain will be created. Default value is `us`.
	Region pulumi.StringPtrInput
}

func (RouteState) ElementType 

func (RouteState) ElementType() reflect.Type

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.