import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides an SES receipt rule resource * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * // Add a header to the email and store it in S3 * const store = new aws.ses.ReceiptRule("store", { * addHeaderActions: [{ * headerName: "Custom-Header", * headerValue: "Added by SES", * position: 1, * }], * s3Actions: [{ * bucketName: "emails", * position: 2, * }], * name: "store", * ruleSetName: "default-rule-set", * recipients: ["karen@example.com"], * enabled: true, * scanEnabled: true, * }); * ``` * * ## Import * * Using `pulumi import`, import SES receipt rules using the ruleset name and rule name separated by `:`. For example: * * ```sh * $ pulumi import aws:ses/receiptRule:ReceiptRule my_rule my_rule_set:my_rule * ``` */ export declare class ReceiptRule extends pulumi.CustomResource { /** * Get an existing ReceiptRule 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, state?: ReceiptRuleState, opts?: pulumi.CustomResourceOptions): ReceiptRule; /** * Returns true if the given object is an instance of ReceiptRule. 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 ReceiptRule; /** * Configuration block for adding a header to received emails. Detailed below. */ readonly addHeaderActions: pulumi.Output; /** * Name of the rule to place this rule after. */ readonly after: pulumi.Output; /** * SES receipt rule ARN. */ readonly arn: pulumi.Output; /** * Configuration block for rejecting received emails. Detailed below. */ readonly bounceActions: pulumi.Output; /** * If true, the rule will be enabled. */ readonly enabled: pulumi.Output; /** * Configuration block for calling an AWS Lambda function. Detailed below. */ readonly lambdaActions: pulumi.Output; /** * Name of the rule. */ readonly name: pulumi.Output; /** * List of email addresses. */ readonly recipients: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Name of the rule set. * * The following arguments are optional: */ readonly ruleSetName: pulumi.Output; /** * Configuration block for storing received emails in an S3 bucket. Detailed below. */ readonly s3Actions: pulumi.Output; /** * If true, incoming emails will be scanned for spam and viruses. */ readonly scanEnabled: pulumi.Output; /** * Configuration block for publishing to an SNS topic. Detailed below. */ readonly snsActions: pulumi.Output; /** * Configuration block for terminating the evaluation of the receipt rule set. Detailed below. */ readonly stopActions: pulumi.Output; /** * `Require` or `Optional`. */ readonly tlsPolicy: pulumi.Output; /** * Configuration block for calling Amazon WorkMail. Detailed below. */ readonly workmailActions: pulumi.Output; /** * Create a ReceiptRule 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: ReceiptRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ReceiptRule resources. */ export interface ReceiptRuleState { /** * Configuration block for adding a header to received emails. Detailed below. */ addHeaderActions?: pulumi.Input[] | undefined>; /** * Name of the rule to place this rule after. */ after?: pulumi.Input; /** * SES receipt rule ARN. */ arn?: pulumi.Input; /** * Configuration block for rejecting received emails. Detailed below. */ bounceActions?: pulumi.Input[] | undefined>; /** * If true, the rule will be enabled. */ enabled?: pulumi.Input; /** * Configuration block for calling an AWS Lambda function. Detailed below. */ lambdaActions?: pulumi.Input[] | undefined>; /** * Name of the rule. */ name?: pulumi.Input; /** * List of email addresses. */ recipients?: pulumi.Input[] | undefined>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Name of the rule set. * * The following arguments are optional: */ ruleSetName?: pulumi.Input; /** * Configuration block for storing received emails in an S3 bucket. Detailed below. */ s3Actions?: pulumi.Input[] | undefined>; /** * If true, incoming emails will be scanned for spam and viruses. */ scanEnabled?: pulumi.Input; /** * Configuration block for publishing to an SNS topic. Detailed below. */ snsActions?: pulumi.Input[] | undefined>; /** * Configuration block for terminating the evaluation of the receipt rule set. Detailed below. */ stopActions?: pulumi.Input[] | undefined>; /** * `Require` or `Optional`. */ tlsPolicy?: pulumi.Input; /** * Configuration block for calling Amazon WorkMail. Detailed below. */ workmailActions?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a ReceiptRule resource. */ export interface ReceiptRuleArgs { /** * Configuration block for adding a header to received emails. Detailed below. */ addHeaderActions?: pulumi.Input[] | undefined>; /** * Name of the rule to place this rule after. */ after?: pulumi.Input; /** * Configuration block for rejecting received emails. Detailed below. */ bounceActions?: pulumi.Input[] | undefined>; /** * If true, the rule will be enabled. */ enabled?: pulumi.Input; /** * Configuration block for calling an AWS Lambda function. Detailed below. */ lambdaActions?: pulumi.Input[] | undefined>; /** * Name of the rule. */ name?: pulumi.Input; /** * List of email addresses. */ recipients?: pulumi.Input[] | undefined>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Name of the rule set. * * The following arguments are optional: */ ruleSetName: pulumi.Input; /** * Configuration block for storing received emails in an S3 bucket. Detailed below. */ s3Actions?: pulumi.Input[] | undefined>; /** * If true, incoming emails will be scanned for spam and viruses. */ scanEnabled?: pulumi.Input; /** * Configuration block for publishing to an SNS topic. Detailed below. */ snsActions?: pulumi.Input[] | undefined>; /** * Configuration block for terminating the evaluation of the receipt rule set. Detailed below. */ stopActions?: pulumi.Input[] | undefined>; /** * `Require` or `Optional`. */ tlsPolicy?: pulumi.Input; /** * Configuration block for calling Amazon WorkMail. Detailed below. */ workmailActions?: pulumi.Input[] | undefined>; } //# sourceMappingURL=receiptRule.d.ts.map