Module ses

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Others

Resources

Resource ActiveReceiptRuleSet

class ActiveReceiptRuleSet extends CustomResource

Provides a resource to designate the active SES receipt rule set

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const main = new aws.ses.ActiveReceiptRuleSet("main", {
    ruleSetName: "primary-rules",
});

constructor

new ActiveReceiptRuleSet(name: string, args: ActiveReceiptRuleSetArgs, opts?: pulumi.CustomResourceOptions)

Create a ActiveReceiptRuleSet resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActiveReceiptRuleSetState, opts?: pulumi.CustomResourceOptions): ActiveReceiptRuleSet

Get an existing ActiveReceiptRuleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ActiveReceiptRuleSet

Returns true if the given object is an instance of ActiveReceiptRuleSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ruleSetName

public ruleSetName: pulumi.Output<string>;

The name of the rule set

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfgurationSet

DEPRECATED aws.ses.ConfgurationSet has been deprecated in favor of aws.ses.ConfigurationSet

class ConfgurationSet extends CustomResource

constructor

DEPRECATED aws.ses.ConfgurationSet has been deprecated in favor of aws.ses.ConfigurationSet

new ConfgurationSet(name: string, args?: ConfgurationSetArgs, opts?: pulumi.CustomResourceOptions)

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfgurationSetState, opts?: pulumi.CustomResourceOptions): ConfgurationSet

Get an existing ConfgurationSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfgurationSet

Returns true if the given object is an instance of ConfgurationSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfigurationSet

class ConfigurationSet extends CustomResource

Provides an SES configuration set resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ses.ConfigurationSet("test", {});

constructor

new ConfigurationSet(name: string, args?: ConfigurationSetArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigurationSet resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationSetState, opts?: pulumi.CustomResourceOptions): ConfigurationSet

Get an existing ConfigurationSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfigurationSet

Returns true if the given object is an instance of ConfigurationSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the configuration set

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DomainDkim

class DomainDkim extends CustomResource

Provides an SES domain DKIM generation resource.

Domain ownership needs to be confirmed first using aws.ses.DomainIdentity resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleDomainIdentity = new aws.ses.DomainIdentity("example", {
    domain: "example.com",
});
const exampleDomainDkim = new aws.ses.DomainDkim("example", {
    domain: exampleDomainIdentity.domain,
});
const exampleAmazonsesDkimRecord: aws.route53.Record[] = [];
for (let i = 0; i < 3; i++) {
    exampleAmazonsesDkimRecord.push(new aws.route53.Record(`example_amazonses_dkim_record-${i}`, {
        name: exampleDomainDkim.dkimTokens.apply(dkimTokens => `${dkimTokens[i]}._domainkey.example.com`),
        records: [exampleDomainDkim.dkimTokens.apply(dkimTokens => `${dkimTokens[i]}.dkim.amazonses.com`)],
        ttl: 600,
        type: "CNAME",
        zoneId: "ABCDEFGHIJ123",
    }));
}

constructor

new DomainDkim(name: string, args: DomainDkimArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainDkim resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainDkimState, opts?: pulumi.CustomResourceOptions): DomainDkim

Get an existing DomainDkim resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainDkim

Returns true if the given object is an instance of DomainDkim. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dkimTokens

public dkimTokens: pulumi.Output<string[]>;

DKIM tokens generated by SES. These tokens should be used to create CNAME records used to verify SES Easy DKIM. See below for an example of how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

property domain

public domain: pulumi.Output<string>;

Verified domain name to generate DKIM tokens for.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DomainIdentity

class DomainIdentity extends CustomResource

Provides an SES domain identity resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ses.DomainIdentity("example", {
    domain: "example.com",
});
const exampleAmazonsesVerificationRecord = new aws.route53.Record("example_amazonses_verification_record", {
    name: "_amazonses.example.com",
    records: [example.verificationToken],
    ttl: 600,
    type: "TXT",
    zoneId: "ABCDEFGHIJ123",
});

constructor

new DomainIdentity(name: string, args: DomainIdentityArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainIdentity resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainIdentityState, opts?: pulumi.CustomResourceOptions): DomainIdentity

Get an existing DomainIdentity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainIdentity

Returns true if the given object is an instance of DomainIdentity. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the domain identity.

property domain

public domain: pulumi.Output<string>;

The domain name to assign to SES

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property verificationToken

public verificationToken: pulumi.Output<string>;

A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state “verification pending” until this is done. See below for an example of how this might be achieved when the domain is hosted in Route 53 and managed by this provider. Find out more about verifying domains in Amazon SES in the AWS SES docs.

Resource DomainIdentityVerification

class DomainIdentityVerification extends CustomResource

Represents a successful verification of an SES domain identity.

Most commonly, this resource is used together with aws.route53.Record and aws.ses.DomainIdentity to request an SES domain identity, deploy the required DNS verification records, and wait for verification to complete.

WARNING: This resource implements a part of the verification workflow. It does not represent a real-world entity in AWS, therefore changing or deleting this resource on its own has no immediate effect.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ses.DomainIdentity("example", {
    domain: "example.com",
});
const exampleAmazonsesVerificationRecord = new aws.route53.Record("example_amazonses_verification_record", {
    name: pulumi.interpolate`_amazonses.${example.id}`,
    records: [example.verificationToken],
    ttl: 600,
    type: "TXT",
    zoneId: aws_route53_zone_example.zoneId,
});
const exampleVerification = new aws.ses.DomainIdentityVerification("example_verification", {
    domain: example.id,
}, { dependsOn: [exampleAmazonsesVerificationRecord] });

constructor

new DomainIdentityVerification(name: string, args: DomainIdentityVerificationArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainIdentityVerification resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainIdentityVerificationState, opts?: pulumi.CustomResourceOptions): DomainIdentityVerification

Get an existing DomainIdentityVerification resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainIdentityVerification

Returns true if the given object is an instance of DomainIdentityVerification. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the domain identity.

property domain

public domain: pulumi.Output<string>;

The domain name of the SES domain identity to verify.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EmailIdentity

class EmailIdentity extends CustomResource

Provides an SES email identity resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ses.EmailIdentity("example", {
    email: "email@example.com",
});

constructor

new EmailIdentity(name: string, args: EmailIdentityArgs, opts?: pulumi.CustomResourceOptions)

Create a EmailIdentity resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EmailIdentityState, opts?: pulumi.CustomResourceOptions): EmailIdentity

Get an existing EmailIdentity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EmailIdentity

Returns true if the given object is an instance of EmailIdentity. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the email identity.

property email

public email: pulumi.Output<string>;

The email address to assign to SES

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EventDestination

class EventDestination extends CustomResource

Provides an SES event destination

Example Usage

CloudWatch Destination

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const cloudwatch = new aws.ses.EventDestination("cloudwatch", {
    cloudwatchDestinations: [{
        defaultValue: "default",
        dimensionName: "dimension",
        valueSource: "emailHeader",
    }],
    configurationSetName: aws_ses_configuration_set_example.name,
    enabled: true,
    matchingTypes: [
        "bounce",
        "send",
    ],
});

Kinesis Destination

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const kinesis = new aws.ses.EventDestination("kinesis", {
    configurationSetName: aws_ses_configuration_set_example.name,
    enabled: true,
    kinesisDestination: {
        roleArn: aws_iam_role_example.arn,
        streamArn: aws_kinesis_firehose_delivery_stream_example.arn,
    },
    matchingTypes: [
        "bounce",
        "send",
    ],
});

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const sns = new aws.ses.EventDestination("sns", {
    configurationSetName: aws_ses_configuration_set_example.name,
    enabled: true,
    matchingTypes: [
        "bounce",
        "send",
    ],
    snsDestination: {
        topicArn: aws_sns_topic_example.arn,
    },
});

constructor

new EventDestination(name: string, args: EventDestinationArgs, opts?: pulumi.CustomResourceOptions)

Create a EventDestination resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventDestinationState, opts?: pulumi.CustomResourceOptions): EventDestination

Get an existing EventDestination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventDestination

Returns true if the given object is an instance of EventDestination. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cloudwatchDestinations

public cloudwatchDestinations: pulumi.Output<EventDestinationCloudwatchDestination[] | undefined>;

CloudWatch destination for the events

property configurationSetName

public configurationSetName: pulumi.Output<string>;

The name of the configuration set

property enabled

public enabled: pulumi.Output<boolean | undefined>;

If true, the event destination will be enabled

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kinesisDestination

public kinesisDestination: pulumi.Output<EventDestinationKinesisDestination | undefined>;

Send the events to a kinesis firehose destination

property matchingTypes

public matchingTypes: pulumi.Output<string[]>;

A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".

property name

public name: pulumi.Output<string>;

The name of the event destination

property snsDestination

public snsDestination: pulumi.Output<EventDestinationSnsDestination | undefined>;

Send the events to an SNS Topic destination

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityNotificationTopic

class IdentityNotificationTopic extends CustomResource

Resource for managing SES Identity Notification Topics

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ses.IdentityNotificationTopic("test", {
    identity: aws_ses_domain_identity_example.domain,
    includeOriginalHeaders: true,
    notificationType: "Bounce",
    topicArn: aws_sns_topic_example.arn,
});

constructor

new IdentityNotificationTopic(name: string, args: IdentityNotificationTopicArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityNotificationTopic resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityNotificationTopicState, opts?: pulumi.CustomResourceOptions): IdentityNotificationTopic

Get an existing IdentityNotificationTopic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityNotificationTopic

Returns true if the given object is an instance of IdentityNotificationTopic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<string>;

The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).

property includeOriginalHeaders

public includeOriginalHeaders: pulumi.Output<boolean | undefined>;

Whether SES should include original email headers in SNS notifications of this type. false by default.

property notificationType

public notificationType: pulumi.Output<string>;

The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.

property topicArn

public topicArn: pulumi.Output<string | undefined>;

The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource IdentityPolicy

class IdentityPolicy extends CustomResource

Manages a SES Identity Policy. More information about SES Sending Authorization Policies can be found in the SES Developer Guide.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleDomainIdentity = new aws.ses.DomainIdentity("example", {
    domain: "example.com",
});
const examplePolicyDocument = exampleDomainIdentity.arn.apply(arn => aws.iam.getPolicyDocument({
    statements: [{
        actions: [
            "SES:SendEmail",
            "SES:SendRawEmail",
        ],
        principals: [{
            identifiers: ["*"],
            type: "AWS",
        }],
        resources: [arn],
    }],
}, { async: true }));
const exampleIdentityPolicy = new aws.ses.IdentityPolicy("example", {
    identity: exampleDomainIdentity.arn,
    policy: examplePolicyDocument.json,
});

constructor

new IdentityPolicy(name: string, args: IdentityPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a IdentityPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IdentityPolicyState, opts?: pulumi.CustomResourceOptions): IdentityPolicy

Get an existing IdentityPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is IdentityPolicy

Returns true if the given object is an instance of IdentityPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<string>;

Name or Amazon Resource Name (ARN) of the SES Identity.

property name

public name: pulumi.Output<string>;

Name of the policy.

property policy

public policy: pulumi.Output<string>;

JSON string of the policy.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource MailFrom

class MailFrom extends CustomResource

Provides an SES domain MAIL FROM resource.

NOTE: For the MAIL FROM domain to be fully usable, this resource should be paired with the aws.ses.DomainIdentity resource. To validate the MAIL FROM domain, a DNS MX record is required. To pass SPF checks, a DNS TXT record may also be required. See the Amazon SES MAIL FROM documentation for more information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Example SES Domain Identity
const exampleDomainIdentity = new aws.ses.DomainIdentity("example", {
    domain: "example.com",
});
const exampleMailFrom = new aws.ses.MailFrom("example", {
    domain: exampleDomainIdentity.domain,
    mailFromDomain: pulumi.interpolate`bounce.${exampleDomainIdentity.domain}`,
});
// Example Route53 MX record
const exampleSesDomainMailFromMx = new aws.route53.Record("example_ses_domain_mail_from_mx", {
    name: exampleMailFrom.mailFromDomain,
    records: ["10 feedback-smtp.us-east-1.amazonses.com"], // Change to the region in which `aws_ses_domain_identity.example` is created
    ttl: 600,
    type: "MX",
    zoneId: aws_route53_zone_example.id,
});
// Example Route53 TXT record for SPF
const exampleSesDomainMailFromTxt = new aws.route53.Record("example_ses_domain_mail_from_txt", {
    name: exampleMailFrom.mailFromDomain,
    records: ["v=spf1 include:amazonses.com -all"],
    ttl: 600,
    type: "TXT",
    zoneId: aws_route53_zone_example.id,
});

constructor

new MailFrom(name: string, args: MailFromArgs, opts?: pulumi.CustomResourceOptions)

Create a MailFrom resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MailFromState, opts?: pulumi.CustomResourceOptions): MailFrom

Get an existing MailFrom resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MailFrom

Returns true if the given object is an instance of MailFrom. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property behaviorOnMxFailure

public behaviorOnMxFailure: pulumi.Output<string | undefined>;

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. Defaults to UseDefaultValue. See the SES API documentation for more information.

property domain

public domain: pulumi.Output<string>;

Verified domain name to generate DKIM tokens for.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mailFromDomain

public mailFromDomain: pulumi.Output<string>;

Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ReceiptFilter

class ReceiptFilter extends CustomResource

Provides an SES receipt filter resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const filter = new aws.ses.ReceiptFilter("filter", {
    cidr: "10.10.10.10",
    policy: "Block",
});

constructor

new ReceiptFilter(name: string, args: ReceiptFilterArgs, opts?: pulumi.CustomResourceOptions)

Create a ReceiptFilter resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReceiptFilterState, opts?: pulumi.CustomResourceOptions): ReceiptFilter

Get an existing ReceiptFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReceiptFilter

Returns true if the given object is an instance of ReceiptFilter. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cidr

public cidr: pulumi.Output<string>;

The IP address or address range to filter, in CIDR notation

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the filter

property policy

public policy: pulumi.Output<string>;

Block or Allow

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ReceiptRule

class ReceiptRule extends CustomResource

Provides an SES receipt rule resource

Example Usage

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,
    }],
    enabled: true,
    recipients: ["karen@example.com"],
    ruleSetName: "default-rule-set",
    s3Actions: [{
        bucketName: "emails",
        position: 2,
    }],
    scanEnabled: true,
});

constructor

new ReceiptRule(name: string, args: ReceiptRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a ReceiptRule resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReceiptRuleState, opts?: pulumi.CustomResourceOptions): ReceiptRule

Get an existing ReceiptRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property addHeaderActions

public addHeaderActions: pulumi.Output<ReceiptRuleAddHeaderAction[] | undefined>;

A list of Add Header Action blocks. Documented below.

property after

public after: pulumi.Output<string | undefined>;

The name of the rule to place this rule after

property bounceActions

public bounceActions: pulumi.Output<ReceiptRuleBounceAction[] | undefined>;

A list of Bounce Action blocks. Documented below.

property enabled

public enabled: pulumi.Output<boolean>;

If true, the rule will be enabled

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lambdaActions

public lambdaActions: pulumi.Output<ReceiptRuleLambdaAction[] | undefined>;

A list of Lambda Action blocks. Documented below.

property name

public name: pulumi.Output<string>;

The name of the rule

property recipients

public recipients: pulumi.Output<string[] | undefined>;

A list of email addresses

property ruleSetName

public ruleSetName: pulumi.Output<string>;

The name of the rule set

property s3Actions

public s3Actions: pulumi.Output<ReceiptRuleS3Action[] | undefined>;

A list of S3 Action blocks. Documented below.

property scanEnabled

public scanEnabled: pulumi.Output<boolean>;

If true, incoming emails will be scanned for spam and viruses

property snsActions

public snsActions: pulumi.Output<ReceiptRuleSnsAction[] | undefined>;

A list of SNS Action blocks. Documented below.

property stopActions

public stopActions: pulumi.Output<ReceiptRuleStopAction[] | undefined>;

A list of Stop Action blocks. Documented below.

property tlsPolicy

public tlsPolicy: pulumi.Output<string>;

Require or Optional

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workmailActions

public workmailActions: pulumi.Output<ReceiptRuleWorkmailAction[] | undefined>;

A list of WorkMail Action blocks. Documented below.

Resource ReceiptRuleSet

class ReceiptRuleSet extends CustomResource

Provides an SES receipt rule set resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const main = new aws.ses.ReceiptRuleSet("main", {
    ruleSetName: "primary-rules",
});

constructor

new ReceiptRuleSet(name: string, args: ReceiptRuleSetArgs, opts?: pulumi.CustomResourceOptions)

Create a ReceiptRuleSet resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReceiptRuleSetState, opts?: pulumi.CustomResourceOptions): ReceiptRuleSet

Get an existing ReceiptRuleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReceiptRuleSet

Returns true if the given object is an instance of ReceiptRuleSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ruleSetName

public ruleSetName: pulumi.Output<string>;

The name of the rule set

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Template

class Template extends CustomResource

Provides a resource to create a SES template.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const myTemplate = new aws.ses.Template("MyTemplate", {
    html: "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
    subject: "Greetings, {{name}}!",
    text: `Hello {{name}},
Your favorite animal is {{favoriteanimal}}.`,
});

constructor

new Template(name: string, args?: TemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a Template resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TemplateState, opts?: pulumi.CustomResourceOptions): Template

Get an existing Template resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Template

Returns true if the given object is an instance of Template. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property html

public html: pulumi.Output<string | undefined>;

The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.

property subject

public subject: pulumi.Output<string | undefined>;

The subject line of the email.

property text

public text: pulumi.Output<string | undefined>;

The email body that will be visible to recipients whose email clients do not display HTML. Must be less than 500KB in size, including both the text and HTML parts.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ActiveReceiptRuleSetArgs

interface ActiveReceiptRuleSetArgs

The set of arguments for constructing a ActiveReceiptRuleSet resource.

property ruleSetName

ruleSetName: pulumi.Input<string>;

The name of the rule set

interface ActiveReceiptRuleSetState

interface ActiveReceiptRuleSetState

Input properties used for looking up and filtering ActiveReceiptRuleSet resources.

property ruleSetName

ruleSetName?: pulumi.Input<string>;

The name of the rule set

interface ConfgurationSetArgs

interface ConfgurationSetArgs

The set of arguments for constructing a ConfgurationSet resource.

property name

name?: pulumi.Input<string>;

interface ConfgurationSetState

interface ConfgurationSetState

Input properties used for looking up and filtering ConfgurationSet resources.

property name

name?: pulumi.Input<string>;

interface ConfigurationSetArgs

interface ConfigurationSetArgs

The set of arguments for constructing a ConfigurationSet resource.

property name

name?: pulumi.Input<string>;

The name of the configuration set

interface ConfigurationSetState

interface ConfigurationSetState

Input properties used for looking up and filtering ConfigurationSet resources.

property name

name?: pulumi.Input<string>;

The name of the configuration set

interface DomainDkimArgs

interface DomainDkimArgs

The set of arguments for constructing a DomainDkim resource.

property domain

domain: pulumi.Input<string>;

Verified domain name to generate DKIM tokens for.

interface DomainDkimState

interface DomainDkimState

Input properties used for looking up and filtering DomainDkim resources.

property dkimTokens

dkimTokens?: pulumi.Input<pulumi.Input<string>[]>;

property domain

domain?: pulumi.Input<string>;

Verified domain name to generate DKIM tokens for.

interface DomainIdentityArgs

interface DomainIdentityArgs

The set of arguments for constructing a DomainIdentity resource.

property domain

domain: pulumi.Input<string>;

The domain name to assign to SES

interface DomainIdentityState

interface DomainIdentityState

Input properties used for looking up and filtering DomainIdentity resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the domain identity.

property domain

domain?: pulumi.Input<string>;

The domain name to assign to SES

property verificationToken

verificationToken?: pulumi.Input<string>;

interface DomainIdentityVerificationArgs

interface DomainIdentityVerificationArgs

The set of arguments for constructing a DomainIdentityVerification resource.

property domain

domain: pulumi.Input<string>;

The domain name of the SES domain identity to verify.

interface DomainIdentityVerificationState

interface DomainIdentityVerificationState

Input properties used for looking up and filtering DomainIdentityVerification resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the domain identity.

property domain

domain?: pulumi.Input<string>;

The domain name of the SES domain identity to verify.

interface EmailIdentityArgs

interface EmailIdentityArgs

The set of arguments for constructing a EmailIdentity resource.

property email

email: pulumi.Input<string>;

The email address to assign to SES

interface EmailIdentityState

interface EmailIdentityState

Input properties used for looking up and filtering EmailIdentity resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the email identity.

property email

email?: pulumi.Input<string>;

The email address to assign to SES

interface EventDestinationArgs

interface EventDestinationArgs

The set of arguments for constructing a EventDestination resource.

property cloudwatchDestinations

cloudwatchDestinations?: pulumi.Input<pulumi.Input<EventDestinationCloudwatchDestination>[]>;

CloudWatch destination for the events

property configurationSetName

configurationSetName: pulumi.Input<string>;

The name of the configuration set

property enabled

enabled?: pulumi.Input<boolean>;

If true, the event destination will be enabled

property kinesisDestination

kinesisDestination?: pulumi.Input<EventDestinationKinesisDestination>;

Send the events to a kinesis firehose destination

property matchingTypes

matchingTypes: pulumi.Input<pulumi.Input<string>[]>;

A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".

property name

name?: pulumi.Input<string>;

The name of the event destination

property snsDestination

snsDestination?: pulumi.Input<EventDestinationSnsDestination>;

Send the events to an SNS Topic destination

interface EventDestinationState

interface EventDestinationState

Input properties used for looking up and filtering EventDestination resources.

property cloudwatchDestinations

cloudwatchDestinations?: pulumi.Input<pulumi.Input<EventDestinationCloudwatchDestination>[]>;

CloudWatch destination for the events

property configurationSetName

configurationSetName?: pulumi.Input<string>;

The name of the configuration set

property enabled

enabled?: pulumi.Input<boolean>;

If true, the event destination will be enabled

property kinesisDestination

kinesisDestination?: pulumi.Input<EventDestinationKinesisDestination>;

Send the events to a kinesis firehose destination

property matchingTypes

matchingTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".

property name

name?: pulumi.Input<string>;

The name of the event destination

property snsDestination

snsDestination?: pulumi.Input<EventDestinationSnsDestination>;

Send the events to an SNS Topic destination

interface IdentityNotificationTopicArgs

interface IdentityNotificationTopicArgs

The set of arguments for constructing a IdentityNotificationTopic resource.

property identity

identity: pulumi.Input<string>;

The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).

property includeOriginalHeaders

includeOriginalHeaders?: pulumi.Input<boolean>;

Whether SES should include original email headers in SNS notifications of this type. false by default.

property notificationType

notificationType: pulumi.Input<string>;

The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.

property topicArn

topicArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

interface IdentityNotificationTopicState

interface IdentityNotificationTopicState

Input properties used for looking up and filtering IdentityNotificationTopic resources.

property identity

identity?: pulumi.Input<string>;

The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN).

property includeOriginalHeaders

includeOriginalHeaders?: pulumi.Input<boolean>;

Whether SES should include original email headers in SNS notifications of this type. false by default.

property notificationType

notificationType?: pulumi.Input<string>;

The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.

property topicArn

topicArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

interface IdentityPolicyArgs

interface IdentityPolicyArgs

The set of arguments for constructing a IdentityPolicy resource.

property identity

identity: pulumi.Input<string>;

Name or Amazon Resource Name (ARN) of the SES Identity.

property name

name?: pulumi.Input<string>;

Name of the policy.

property policy

policy: pulumi.Input<string>;

JSON string of the policy.

interface IdentityPolicyState

interface IdentityPolicyState

Input properties used for looking up and filtering IdentityPolicy resources.

property identity

identity?: pulumi.Input<string>;

Name or Amazon Resource Name (ARN) of the SES Identity.

property name

name?: pulumi.Input<string>;

Name of the policy.

property policy

policy?: pulumi.Input<string>;

JSON string of the policy.

interface MailFromArgs

interface MailFromArgs

The set of arguments for constructing a MailFrom resource.

property behaviorOnMxFailure

behaviorOnMxFailure?: pulumi.Input<string>;

property domain

domain: pulumi.Input<string>;

Verified domain name to generate DKIM tokens for.

property mailFromDomain

mailFromDomain: pulumi.Input<string>;

Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

interface MailFromState

interface MailFromState

Input properties used for looking up and filtering MailFrom resources.

property behaviorOnMxFailure

behaviorOnMxFailure?: pulumi.Input<string>;

property domain

domain?: pulumi.Input<string>;

Verified domain name to generate DKIM tokens for.

property mailFromDomain

mailFromDomain?: pulumi.Input<string>;

Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

interface ReceiptFilterArgs

interface ReceiptFilterArgs

The set of arguments for constructing a ReceiptFilter resource.

property cidr

cidr: pulumi.Input<string>;

The IP address or address range to filter, in CIDR notation

property name

name?: pulumi.Input<string>;

The name of the filter

property policy

policy: pulumi.Input<string>;

Block or Allow

interface ReceiptFilterState

interface ReceiptFilterState

Input properties used for looking up and filtering ReceiptFilter resources.

property cidr

cidr?: pulumi.Input<string>;

The IP address or address range to filter, in CIDR notation

property name

name?: pulumi.Input<string>;

The name of the filter

property policy

policy?: pulumi.Input<string>;

Block or Allow

interface ReceiptRuleArgs

interface ReceiptRuleArgs

The set of arguments for constructing a ReceiptRule resource.

property addHeaderActions

addHeaderActions?: pulumi.Input<pulumi.Input<ReceiptRuleAddHeaderAction>[]>;

A list of Add Header Action blocks. Documented below.

property after

after?: pulumi.Input<string>;

The name of the rule to place this rule after

property bounceActions

bounceActions?: pulumi.Input<pulumi.Input<ReceiptRuleBounceAction>[]>;

A list of Bounce Action blocks. Documented below.

property enabled

enabled?: pulumi.Input<boolean>;

If true, the rule will be enabled

property lambdaActions

lambdaActions?: pulumi.Input<pulumi.Input<ReceiptRuleLambdaAction>[]>;

A list of Lambda Action blocks. Documented below.

property name

name?: pulumi.Input<string>;

The name of the rule

property recipients

recipients?: pulumi.Input<pulumi.Input<string>[]>;

A list of email addresses

property ruleSetName

ruleSetName: pulumi.Input<string>;

The name of the rule set

property s3Actions

s3Actions?: pulumi.Input<pulumi.Input<ReceiptRuleS3Action>[]>;

A list of S3 Action blocks. Documented below.

property scanEnabled

scanEnabled?: pulumi.Input<boolean>;

If true, incoming emails will be scanned for spam and viruses

property snsActions

snsActions?: pulumi.Input<pulumi.Input<ReceiptRuleSnsAction>[]>;

A list of SNS Action blocks. Documented below.

property stopActions

stopActions?: pulumi.Input<pulumi.Input<ReceiptRuleStopAction>[]>;

A list of Stop Action blocks. Documented below.

property tlsPolicy

tlsPolicy?: pulumi.Input<string>;

Require or Optional

property workmailActions

workmailActions?: pulumi.Input<pulumi.Input<ReceiptRuleWorkmailAction>[]>;

A list of WorkMail Action blocks. Documented below.

interface ReceiptRuleSetArgs

interface ReceiptRuleSetArgs

The set of arguments for constructing a ReceiptRuleSet resource.

property ruleSetName

ruleSetName: pulumi.Input<string>;

The name of the rule set

interface ReceiptRuleSetState

interface ReceiptRuleSetState

Input properties used for looking up and filtering ReceiptRuleSet resources.

property ruleSetName

ruleSetName?: pulumi.Input<string>;

The name of the rule set

interface ReceiptRuleState

interface ReceiptRuleState

Input properties used for looking up and filtering ReceiptRule resources.

property addHeaderActions

addHeaderActions?: pulumi.Input<pulumi.Input<ReceiptRuleAddHeaderAction>[]>;

A list of Add Header Action blocks. Documented below.

property after

after?: pulumi.Input<string>;

The name of the rule to place this rule after

property bounceActions

bounceActions?: pulumi.Input<pulumi.Input<ReceiptRuleBounceAction>[]>;

A list of Bounce Action blocks. Documented below.

property enabled

enabled?: pulumi.Input<boolean>;

If true, the rule will be enabled

property lambdaActions

lambdaActions?: pulumi.Input<pulumi.Input<ReceiptRuleLambdaAction>[]>;

A list of Lambda Action blocks. Documented below.

property name

name?: pulumi.Input<string>;

The name of the rule

property recipients

recipients?: pulumi.Input<pulumi.Input<string>[]>;

A list of email addresses

property ruleSetName

ruleSetName?: pulumi.Input<string>;

The name of the rule set

property s3Actions

s3Actions?: pulumi.Input<pulumi.Input<ReceiptRuleS3Action>[]>;

A list of S3 Action blocks. Documented below.

property scanEnabled

scanEnabled?: pulumi.Input<boolean>;

If true, incoming emails will be scanned for spam and viruses

property snsActions

snsActions?: pulumi.Input<pulumi.Input<ReceiptRuleSnsAction>[]>;

A list of SNS Action blocks. Documented below.

property stopActions

stopActions?: pulumi.Input<pulumi.Input<ReceiptRuleStopAction>[]>;

A list of Stop Action blocks. Documented below.

property tlsPolicy

tlsPolicy?: pulumi.Input<string>;

Require or Optional

property workmailActions

workmailActions?: pulumi.Input<pulumi.Input<ReceiptRuleWorkmailAction>[]>;

A list of WorkMail Action blocks. Documented below.

interface TemplateArgs

interface TemplateArgs

The set of arguments for constructing a Template resource.

property html

html?: pulumi.Input<string>;

The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.

property name

name?: pulumi.Input<string>;

The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.

property subject

subject?: pulumi.Input<string>;

The subject line of the email.

property text

text?: pulumi.Input<string>;

The email body that will be visible to recipients whose email clients do not display HTML. Must be less than 500KB in size, including both the text and HTML parts.

interface TemplateState

interface TemplateState

Input properties used for looking up and filtering Template resources.

property html

html?: pulumi.Input<string>;

The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.

property name

name?: pulumi.Input<string>;

The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.

property subject

subject?: pulumi.Input<string>;

The subject line of the email.

property text

text?: pulumi.Input<string>;

The email body that will be visible to recipients whose email clients do not display HTML. Must be less than 500KB in size, including both the text and HTML parts.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module ses

Resources

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

CloudWatch Destination

Kinesis Destination

SNS Destination

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage