UNPKG

@pulumiverse/scaleway

Version:

A Pulumi package for creating and managing Scaleway cloud resources.

235 lines 9.92 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.TemDomain = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("./utilities")); /** * Creates and manages Scaleway Transactional Email Domains. * For more information refer to the [API documentation](https://www.scaleway.com/en/developers/api/transactional-email). * * ## Example Usage * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const main = new scaleway.tem.Domain("main", { * acceptTos: true, * name: "example.com", * }); * ``` * * ### Add the required records to your DNS zone * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const config = new pulumi.Config(); * const domainName = config.require("domainName"); * const main = new scaleway.tem.Domain("main", { * name: domainName, * acceptTos: true, * }); * const spf = new scaleway.domain.Record("spf", { * dnsZone: domainName, * type: "TXT", * data: main.spfValue, * }); * const dkim = new scaleway.domain.Record("dkim", { * dnsZone: domainName, * name: main.dkimName, * type: "TXT", * data: main.dkimConfig, * }); * const mx = new scaleway.domain.Record("mx", { * dnsZone: domainName, * type: "MX", * data: main.mxConfig, * }); * const dmarc = new scaleway.domain.Record("dmarc", { * dnsZone: domainName, * name: main.dmarcName, * type: "TXT", * data: main.dmarcConfig, * }); * ``` * * ### Automatically Configure DNS Settings for Your Domain * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@pulumiverse/scaleway"; * * const config = new pulumi.Config(); * const domainName = config.require("domainName"); * const main = new scaleway.tem.Domain("main", { * name: domainName, * acceptTos: true, * autoconfig: true, * }); * ``` * * ### Configuring GitLab Project Variables * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gitlab from "@pulumi/gitlab"; * import * as scaleway from "@pulumiverse/scaleway"; * * const config = new pulumi.Config(); * const domainName = config.require("domainName"); * const myDomain = scaleway.tem.getDomain({ * name: domainName, * }); * const smtpAuthUser = new gitlab.ProjectVariable("smtp_auth_user", { * key: "SMTP_AUTH_USER", * value: myDomain.then(myDomain => myDomain.smtpsAuthUser), * }); * const smtpPort = new gitlab.ProjectVariable("smtp_port", { * key: "SMTP_PORT", * value: output(myDomain.then(myDomain => myDomain.smtpsPort)).apply(x =>String(x)), * }); * const smtpHost = new gitlab.ProjectVariable("smtp_host", { * key: "SMTP_HOST", * value: output(myDomain.then(myDomain => myDomain.smtpsHost)).apply(x =>String(x)), * }); * ``` * * ## Import * * Domains can be imported using the `{region}/{id}`, e.g. * * ```sh * $ pulumi import scaleway:index/temDomain:TemDomain main fr-par/11111111-1111-1111-1111-111111111111 * ``` * * @deprecated scaleway.index/temdomain.TemDomain has been deprecated in favor of scaleway.tem/domain.Domain */ class TemDomain extends pulumi.CustomResource { /** * Get an existing TemDomain 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, id, state, opts) { pulumi.log.warn("TemDomain is deprecated: scaleway.index/temdomain.TemDomain has been deprecated in favor of scaleway.tem/domain.Domain"); return new TemDomain(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'scaleway:index/temDomain:TemDomain'; /** * Returns true if the given object is an instance of TemDomain. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj) { if (obj === undefined || obj === null) { return false; } return obj['__pulumiType'] === TemDomain.__pulumiType; } /** @deprecated scaleway.index/temdomain.TemDomain has been deprecated in favor of scaleway.tem/domain.Domain */ constructor(name, argsOrState, opts) { pulumi.log.warn("TemDomain is deprecated: scaleway.index/temdomain.TemDomain has been deprecated in favor of scaleway.tem/domain.Domain"); let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["acceptTos"] = state?.acceptTos; resourceInputs["autoconfig"] = state?.autoconfig; resourceInputs["createdAt"] = state?.createdAt; resourceInputs["dkimConfig"] = state?.dkimConfig; resourceInputs["dkimName"] = state?.dkimName; resourceInputs["dmarcConfig"] = state?.dmarcConfig; resourceInputs["dmarcName"] = state?.dmarcName; resourceInputs["lastError"] = state?.lastError; resourceInputs["lastValidAt"] = state?.lastValidAt; resourceInputs["mxBlackhole"] = state?.mxBlackhole; resourceInputs["mxConfig"] = state?.mxConfig; resourceInputs["name"] = state?.name; resourceInputs["nextCheckAt"] = state?.nextCheckAt; resourceInputs["projectId"] = state?.projectId; resourceInputs["region"] = state?.region; resourceInputs["reputations"] = state?.reputations; resourceInputs["revokedAt"] = state?.revokedAt; resourceInputs["smtpHost"] = state?.smtpHost; resourceInputs["smtpPort"] = state?.smtpPort; resourceInputs["smtpPortAlternative"] = state?.smtpPortAlternative; resourceInputs["smtpPortUnsecure"] = state?.smtpPortUnsecure; resourceInputs["smtpsAuthUser"] = state?.smtpsAuthUser; resourceInputs["smtpsPort"] = state?.smtpsPort; resourceInputs["smtpsPortAlternative"] = state?.smtpsPortAlternative; resourceInputs["spfConfig"] = state?.spfConfig; resourceInputs["spfValue"] = state?.spfValue; resourceInputs["status"] = state?.status; } else { const args = argsOrState; if (args?.acceptTos === undefined && !opts.urn) { throw new Error("Missing required property 'acceptTos'"); } resourceInputs["acceptTos"] = args?.acceptTos; resourceInputs["autoconfig"] = args?.autoconfig; resourceInputs["name"] = args?.name; resourceInputs["projectId"] = args?.projectId; resourceInputs["region"] = args?.region; resourceInputs["createdAt"] = undefined /*out*/; resourceInputs["dkimConfig"] = undefined /*out*/; resourceInputs["dkimName"] = undefined /*out*/; resourceInputs["dmarcConfig"] = undefined /*out*/; resourceInputs["dmarcName"] = undefined /*out*/; resourceInputs["lastError"] = undefined /*out*/; resourceInputs["lastValidAt"] = undefined /*out*/; resourceInputs["mxBlackhole"] = undefined /*out*/; resourceInputs["mxConfig"] = undefined /*out*/; resourceInputs["nextCheckAt"] = undefined /*out*/; resourceInputs["reputations"] = undefined /*out*/; resourceInputs["revokedAt"] = undefined /*out*/; resourceInputs["smtpHost"] = undefined /*out*/; resourceInputs["smtpPort"] = undefined /*out*/; resourceInputs["smtpPortAlternative"] = undefined /*out*/; resourceInputs["smtpPortUnsecure"] = undefined /*out*/; resourceInputs["smtpsAuthUser"] = undefined /*out*/; resourceInputs["smtpsPort"] = undefined /*out*/; resourceInputs["smtpsPortAlternative"] = undefined /*out*/; resourceInputs["spfConfig"] = undefined /*out*/; resourceInputs["spfValue"] = undefined /*out*/; resourceInputs["status"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(TemDomain.__pulumiType, name, resourceInputs, opts); } } exports.TemDomain = TemDomain; //# sourceMappingURL=temDomain.js.map