Skip to content

AccountSettings

Source: src/AWS/SES/AccountSettings.ts

Account-level Amazon SES v2 settings — an account/region singleton that manages account-wide sending status, the account suppression list, and Virtual Deliverability Manager (VDM) configuration.

Only the aspects you specify are managed: omit sendingEnabled, suppression, or vdm to leave that setting untouched.

Deleting this resource is a no-op — it leaves the account settings exactly as they are. Unlike a normal resource there is nothing to tear down: these are account-global toggles with no single safe default, and resetting them (e.g. disabling sending or clearing the suppression list) would affect live mail beyond this stack. Change the props and re-deploy to adjust them.

Enable VDM with Engagement Tracking

import * as SES from "alchemy/AWS/SES";
const settings = yield* SES.AccountSettings("Account", {
vdm: {
enabled: "ENABLED",
dashboardEngagementMetrics: "ENABLED",
},
});

Configure the Suppression List

const settings = yield* SES.AccountSettings("Account", {
suppression: { reasons: ["BOUNCE", "COMPLAINT"] },
});

Enable Guardian Optimized Shared Delivery

const settings = yield* SES.AccountSettings("Account", {
vdm: {
enabled: "ENABLED",
guardianOptimizedSharedDelivery: "ENABLED",
},
});

Stop All Sending for the Account

// WARNING: this halts every outbound email in the account, including mail
// sent by stacks and systems outside this one. Prefer a configuration
// set's sendingEnabled to pause a single sending path.
const settings = yield* SES.AccountSettings("Account", {
sendingEnabled: false,
});

Manage Only VDM and Leave Sending Alone

// Omitted aspects are never touched — this deploy will not read or write
// the account's sending status or suppression list.
const settings = yield* SES.AccountSettings("Account", {
vdm: { enabled: "ENABLED" },
});