@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
252 lines (251 loc) • 8.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Transactional Email Domains.
* For more information see [the documentation](https://developers.scaleway.com/en/products/transactional_email/api/).
*
* ## Examples
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const main = new scaleway.TemDomain("main", {acceptTos: true});
* ```
*
* ### Add the required records to your DNS zone
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const config = new pulumi.Config();
* const domainName = config.require("domainName");
* const main = new scaleway.TemDomain("main", {acceptTos: true});
* const spf = new scaleway.DomainRecord("spf", {
* dnsZone: domainName,
* type: "TXT",
* data: pulumi.interpolate`v=spf1 ${main.spfConfig} -all`,
* });
* const dkim = new scaleway.DomainRecord("dkim", {
* dnsZone: domainName,
* type: "TXT",
* data: main.dkimConfig,
* });
* const mx = new scaleway.DomainRecord("mx", {
* dnsZone: domainName,
* type: "MX",
* data: ".",
* });
* ```
*
* ## Import
*
* Domains can be imported using the `{region}/{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/temDomain:TemDomain main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: TemDomainState, opts?: pulumi.CustomResourceOptions): 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: any): obj is TemDomain;
/**
* Acceptation of the [Term of Service](https://tem.s3.fr-par.scw.cloud/antispam_policy.pdf).
* > **Important:** This attribute must be set to `true`.
*/
readonly acceptTos: pulumi.Output<boolean>;
/**
* The date and time of the Transaction Email Domain's creation (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The DKIM public key, as should be recorded in the DNS zone.
*/
readonly dkimConfig: pulumi.Output<string>;
/**
* The error message if the last check failed.
*/
readonly lastError: pulumi.Output<string>;
/**
* The date and time the domain was last found to be valid (RFC 3339 format).
*/
readonly lastValidAt: pulumi.Output<string>;
/**
* The domain name, must not be used in another Transactional Email Domain.
* > **Important:** Updates to `name` will recreate the domain.
*/
readonly name: pulumi.Output<string>;
/**
* The date and time of the next scheduled check (RFC 3339 format).
*/
readonly nextCheckAt: pulumi.Output<string>;
/**
* `projectId`) The ID of the project the domain is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`). The region in which the domain should be created.
*/
readonly region: pulumi.Output<string>;
/**
* The date and time of the revocation of the domain (RFC 3339 format).
*/
readonly revokedAt: pulumi.Output<string>;
/**
* SMTP host to use to send emails
*/
readonly smtpHost: pulumi.Output<string>;
/**
* SMTP port to use to send emails over TLS. (Port 587)
*/
readonly smtpPort: pulumi.Output<number>;
/**
* SMTP port to use to send emails over TLS. (Port 2587)
*/
readonly smtpPortAlternative: pulumi.Output<number>;
/**
* SMTP port to use to send emails. (Port 25)
*/
readonly smtpPortUnsecure: pulumi.Output<number>;
/**
* SMTPS port to use to send emails over TLS Wrapper. (Port 465)
*/
readonly smtpsPort: pulumi.Output<number>;
/**
* SMTPS port to use to send emails over TLS Wrapper. (Port 2465)
*/
readonly smtpsPortAlternative: pulumi.Output<number>;
/**
* The snippet of the SPF record that should be registered in the DNS zone.
*/
readonly spfConfig: pulumi.Output<string>;
/**
* The status of the Transaction Email Domain.
*/
readonly status: pulumi.Output<string>;
/**
* Create a TemDomain 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: TemDomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TemDomain resources.
*/
export interface TemDomainState {
/**
* Acceptation of the [Term of Service](https://tem.s3.fr-par.scw.cloud/antispam_policy.pdf).
* > **Important:** This attribute must be set to `true`.
*/
acceptTos?: pulumi.Input<boolean>;
/**
* The date and time of the Transaction Email Domain's creation (RFC 3339 format).
*/
createdAt?: pulumi.Input<string>;
/**
* The DKIM public key, as should be recorded in the DNS zone.
*/
dkimConfig?: pulumi.Input<string>;
/**
* The error message if the last check failed.
*/
lastError?: pulumi.Input<string>;
/**
* The date and time the domain was last found to be valid (RFC 3339 format).
*/
lastValidAt?: pulumi.Input<string>;
/**
* The domain name, must not be used in another Transactional Email Domain.
* > **Important:** Updates to `name` will recreate the domain.
*/
name?: pulumi.Input<string>;
/**
* The date and time of the next scheduled check (RFC 3339 format).
*/
nextCheckAt?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the domain is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which the domain should be created.
*/
region?: pulumi.Input<string>;
/**
* The date and time of the revocation of the domain (RFC 3339 format).
*/
revokedAt?: pulumi.Input<string>;
/**
* SMTP host to use to send emails
*/
smtpHost?: pulumi.Input<string>;
/**
* SMTP port to use to send emails over TLS. (Port 587)
*/
smtpPort?: pulumi.Input<number>;
/**
* SMTP port to use to send emails over TLS. (Port 2587)
*/
smtpPortAlternative?: pulumi.Input<number>;
/**
* SMTP port to use to send emails. (Port 25)
*/
smtpPortUnsecure?: pulumi.Input<number>;
/**
* SMTPS port to use to send emails over TLS Wrapper. (Port 465)
*/
smtpsPort?: pulumi.Input<number>;
/**
* SMTPS port to use to send emails over TLS Wrapper. (Port 2465)
*/
smtpsPortAlternative?: pulumi.Input<number>;
/**
* The snippet of the SPF record that should be registered in the DNS zone.
*/
spfConfig?: pulumi.Input<string>;
/**
* The status of the Transaction Email Domain.
*/
status?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TemDomain resource.
*/
export interface TemDomainArgs {
/**
* Acceptation of the [Term of Service](https://tem.s3.fr-par.scw.cloud/antispam_policy.pdf).
* > **Important:** This attribute must be set to `true`.
*/
acceptTos: pulumi.Input<boolean>;
/**
* The domain name, must not be used in another Transactional Email Domain.
* > **Important:** Updates to `name` will recreate the domain.
*/
name?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the domain is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which the domain should be created.
*/
region?: pulumi.Input<string>;
}