@pulumiverse/scaleway/tem/blockedList.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages blocklisted email addresses for a Scaleway Transactional Email Domain.
 * For more information refer to the [API documentation](https://www.scaleway.com/en/developers/api/transactional-email/#post-transactional-email-v1alpha1-regions-region-blocklists).
 *
 * ## Example Usage
 *
 * ### Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const test = new scaleway.tem.BlockedList("test", {
 *     domainId: "fr-par/12345678-1234-1234-1234-123456789abc",
 *     email: "spam@example.com",
 *     type: "mailbox_full",
 *     reason: "Spam detected",
 *     region: "fr-par",
 * });
 * ```
 *
 * ## Import
 *
 * Blocklists can be imported using the `{region}/{id}`, e.g.
 *
 * ```sh
 * $ pulumi import scaleway:tem/blockedList:BlockedList test fr-par/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class BlockedList extends pulumi.CustomResource {
    /**
     * Get an existing BlockedList 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?: BlockedListState, opts?: pulumi.CustomResourceOptions): BlockedList;
    /**
     * Returns true if the given object is an instance of BlockedList.  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 BlockedList;
    /**
     * The ID of the domain affected by the blocklist. Must be in the format `{region}/{domain_id}`.
     */
    readonly domainId: pulumi.Output<string>;
    /**
     * The email address to block.
     */
    readonly email: pulumi.Output<string>;
    /**
     * The ID of the project this blocklist belongs to. Defaults to the provider's project ID.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * Reason for blocking the email address.
     */
    readonly reason: pulumi.Output<string | undefined>;
    /**
     * The region in which the blocklist is created. Defaults to the provider's region.
     */
    readonly region: pulumi.Output<string | undefined>;
    /**
     * Type of the blocklist. Possible values are:
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a BlockedList 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: BlockedListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering BlockedList resources.
 */
export interface BlockedListState {
    /**
     * The ID of the domain affected by the blocklist. Must be in the format `{region}/{domain_id}`.
     */
    domainId?: pulumi.Input<string | undefined>;
    /**
     * The email address to block.
     */
    email?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project this blocklist belongs to. Defaults to the provider's project ID.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * Reason for blocking the email address.
     */
    reason?: pulumi.Input<string | undefined>;
    /**
     * The region in which the blocklist is created. Defaults to the provider's region.
     */
    region?: pulumi.Input<string | undefined>;
    /**
     * Type of the blocklist. Possible values are:
     */
    type?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a BlockedList resource.
 */
export interface BlockedListArgs {
    /**
     * The ID of the domain affected by the blocklist. Must be in the format `{region}/{domain_id}`.
     */
    domainId: pulumi.Input<string>;
    /**
     * The email address to block.
     */
    email: pulumi.Input<string>;
    /**
     * The ID of the project this blocklist belongs to. Defaults to the provider's project ID.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * Reason for blocking the email address.
     */
    reason?: pulumi.Input<string | undefined>;
    /**
     * The region in which the blocklist is created. Defaults to the provider's region.
     */
    region?: pulumi.Input<string | undefined>;
    /**
     * Type of the blocklist. Possible values are:
     */
    type: pulumi.Input<string>;
}
//# sourceMappingURL=blockedList.d.ts.map