@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
109 lines (108 loc) • 3.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DNSimple email forward resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* const foobar = new dnsimple.EmailForward("foobar", {
* domain: dnsimpleDomain.name,
* aliasName: "sales",
* destinationEmail: "alice.appleseed@example.com",
* });
* ```
*
* ## Import
*
* DNSimple resources can be imported using the domain name and numeric email forward ID.
*
* **Importing email forward for example.com with email forward ID 1234**
*
* bash
*
* ```sh
* $ pulumi import dnsimple:index/emailForward:EmailForward resource_name example.com_1234
* ```
*/
export declare class EmailForward extends pulumi.CustomResource {
/**
* Get an existing EmailForward resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EmailForwardState, opts?: pulumi.CustomResourceOptions): EmailForward;
/**
* Returns true if the given object is an instance of EmailForward. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is EmailForward;
/**
* The source email address on the domain, in full form. This is a computed attribute.
*/
readonly aliasEmail: pulumi.Output<string>;
/**
* The name part (the part before the @) of the source email address on the domain
*/
readonly aliasName: pulumi.Output<string>;
/**
* The destination email address
*/
readonly destinationEmail: pulumi.Output<string>;
/**
* The domain name to add the email forwarding rule to
*/
readonly domain: pulumi.Output<string>;
/**
* Create a EmailForward resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EmailForwardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EmailForward resources.
*/
export interface EmailForwardState {
/**
* The source email address on the domain, in full form. This is a computed attribute.
*/
aliasEmail?: pulumi.Input<string>;
/**
* The name part (the part before the @) of the source email address on the domain
*/
aliasName?: pulumi.Input<string>;
/**
* The destination email address
*/
destinationEmail?: pulumi.Input<string>;
/**
* The domain name to add the email forwarding rule to
*/
domain?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EmailForward resource.
*/
export interface EmailForwardArgs {
/**
* The name part (the part before the @) of the source email address on the domain
*/
aliasName: pulumi.Input<string>;
/**
* The destination email address
*/
destinationEmail: pulumi.Input<string>;
/**
* The domain name to add the email forwarding rule to
*/
domain: pulumi.Input<string>;
}