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.

ses¶

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.

class pulumi_aws.ses.ActiveReceiptRuleSet(resource_name, opts=None, rule_set_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a resource to designate the active SES receipt rule set

import pulumi
import pulumi_aws as aws

main = aws.ses.ActiveReceiptRuleSet("main", rule_set_name="primary-rules")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
rule_set_name (pulumi.Input[str]) – The name of the rule set

rule_set_name: pulumi.Output[str] = None¶: The name of the rule set

static get(resource_name, id, opts=None, rule_set_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
rule_set_name (pulumi.Input[str]) – The name of the rule set

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.ConfgurationSet(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a ConfgurationSet resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.ConfigurationSet(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES configuration set resource

import pulumi
import pulumi_aws as aws

test = aws.ses.ConfigurationSet("test")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the configuration set

name: pulumi.Output[str] = None¶: The name of the configuration set

static get(resource_name, id, opts=None, name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the configuration set

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.DomainDkim(resource_name, opts=None, domain=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES domain DKIM generation resource.

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

import pulumi
import pulumi_aws as aws

example_domain_identity = aws.ses.DomainIdentity("exampleDomainIdentity", domain="example.com")
example_domain_dkim = aws.ses.DomainDkim("exampleDomainDkim", domain=example_domain_identity.domain)
example_amazonses_dkim_record = []
for range in [{"value": i} for i in range(0, 3)]:
    example_amazonses_dkim_record.append(aws.route53.Record(f"exampleAmazonsesDkimRecord-{range['value']}",
        name=example_domain_dkim.dkim_tokens[range["value"]].apply(lambda dkim_tokens: f"{dkim_tokens}._domainkey.example.com"),
        records=[example_domain_dkim.dkim_tokens[range["value"]].apply(lambda dkim_tokens: f"{dkim_tokens}.dkim.amazonses.com")],
        ttl="600",
        type="CNAME",
        zone_id="ABCDEFGHIJ123"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – Verified domain name to generate DKIM tokens for.

dkim_tokens: pulumi.Output[list] = None¶: 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.

domain: pulumi.Output[str] = None¶: Verified domain name to generate DKIM tokens for.

static get(resource_name, id, opts=None, dkim_tokens=None, domain=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
dkim_tokens (pulumi.Input[list]) –
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.
domain (pulumi.Input[str]) – Verified domain name to generate DKIM tokens for.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.DomainIdentity(resource_name, opts=None, domain=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES domain identity resource

import pulumi
import pulumi_aws as aws

example = aws.ses.DomainIdentity("example", domain="example.com")
example_amazonses_verification_record = aws.route53.Record("exampleAmazonsesVerificationRecord",
    name="_amazonses.example.com",
    records=[example.verification_token],
    ttl="600",
    type="TXT",
    zone_id="ABCDEFGHIJ123")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The domain name to assign to SES

arn: pulumi.Output[str] = None¶: The ARN of the domain identity.

domain: pulumi.Output[str] = None¶: The domain name to assign to SES

verification_token: pulumi.Output[str] = None¶: 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.

static get(resource_name, id, opts=None, arn=None, domain=None, verification_token=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the domain identity.
domain (pulumi.Input[str]) – The domain name to assign to SES
verification_token (pulumi.Input[str]) –
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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.DomainIdentityVerification(resource_name, opts=None, domain=None, __props__=None, __name__=None, __opts__=None)¶

Represents a successful verification of an SES domain identity.

Most commonly, this resource is used together with route53.Record and 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.

import pulumi
import pulumi_aws as aws

example = aws.ses.DomainIdentity("example", domain="example.com")
example_amazonses_verification_record = aws.route53.Record("exampleAmazonsesVerificationRecord",
    name=example.id.apply(lambda id: f"_amazonses.{id}"),
    records=[example.verification_token],
    ttl="600",
    type="TXT",
    zone_id=aws_route53_zone["example"]["zone_id"])
example_verification = aws.ses.DomainIdentityVerification("exampleVerification", domain=example.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain (pulumi.Input[str]) – The domain name of the SES domain identity to verify.

arn: pulumi.Output[str] = None¶: The ARN of the domain identity.

domain: pulumi.Output[str] = None¶: The domain name of the SES domain identity to verify.

static get(resource_name, id, opts=None, arn=None, domain=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the domain identity.
domain (pulumi.Input[str]) – The domain name of the SES domain identity to verify.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.EmailIdentity(resource_name, opts=None, email=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES email identity resource

import pulumi
import pulumi_aws as aws

example = aws.ses.EmailIdentity("example", email="email@example.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
email (pulumi.Input[str]) – The email address to assign to SES

arn: pulumi.Output[str] = None¶: The ARN of the email identity.

email: pulumi.Output[str] = None¶: The email address to assign to SES

static get(resource_name, id, opts=None, arn=None, email=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the email identity.
email (pulumi.Input[str]) – The email address to assign to SES

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.EventDestination(resource_name, opts=None, cloudwatch_destinations=None, configuration_set_name=None, enabled=None, kinesis_destination=None, matching_types=None, name=None, sns_destination=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES event destination

import pulumi
import pulumi_aws as aws

cloudwatch = aws.ses.EventDestination("cloudwatch",
    cloudwatch_destinations=[{
        "default_value": "default",
        "dimensionName": "dimension",
        "valueSource": "emailHeader",
    }],
    configuration_set_name=aws_ses_configuration_set["example"]["name"],
    enabled=True,
    matching_types=[
        "bounce",
        "send",
    ])

import pulumi
import pulumi_aws as aws

kinesis = aws.ses.EventDestination("kinesis",
    configuration_set_name=aws_ses_configuration_set["example"]["name"],
    enabled=True,
    kinesis_destination={
        "role_arn": aws_iam_role["example"]["arn"],
        "stream_arn": aws_kinesis_firehose_delivery_stream["example"]["arn"],
    },
    matching_types=[
        "bounce",
        "send",
    ])

import pulumi
import pulumi_aws as aws

sns = aws.ses.EventDestination("sns",
    configuration_set_name=aws_ses_configuration_set["example"]["name"],
    enabled=True,
    matching_types=[
        "bounce",
        "send",
    ],
    sns_destination={
        "topic_arn": aws_sns_topic["example"]["arn"],
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cloudwatch_destinations (pulumi.Input[list]) – CloudWatch destination for the events
configuration_set_name (pulumi.Input[str]) – The name of the configuration set
enabled (pulumi.Input[bool]) – If true, the event destination will be enabled
kinesis_destination (pulumi.Input[dict]) – Send the events to a kinesis firehose destination
matching_types (pulumi.Input[list]) – A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".
name (pulumi.Input[str]) – The name of the event destination
sns_destination (pulumi.Input[dict]) – Send the events to an SNS Topic destination

The cloudwatch_destinations object supports the following:

default_value (pulumi.Input[str]) - The default value for the event
dimensionName (pulumi.Input[str]) - The name for the dimension
valueSource (pulumi.Input[str]) - The source for the value. It can be either "messageTag" or "emailHeader"

The kinesis_destination object supports the following:

role_arn (pulumi.Input[str]) - The ARN of the role that has permissions to access the Kinesis Stream
stream_arn (pulumi.Input[str]) - The ARN of the Kinesis Stream

The sns_destination object supports the following:

topic_arn (pulumi.Input[str]) - The ARN of the SNS topic

cloudwatch_destinations: pulumi.Output[list] = None¶

CloudWatch destination for the events

default_value (str) - The default value for the event
dimensionName (str) - The name for the dimension
valueSource (str) - The source for the value. It can be either "messageTag" or "emailHeader"

configuration_set_name: pulumi.Output[str] = None¶: The name of the configuration set

enabled: pulumi.Output[bool] = None¶: If true, the event destination will be enabled

kinesis_destination: pulumi.Output[dict] = None¶

Send the events to a kinesis firehose destination

role_arn (str) - The ARN of the role that has permissions to access the Kinesis Stream
stream_arn (str) - The ARN of the Kinesis Stream

matching_types: pulumi.Output[list] = None¶: A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".

name: pulumi.Output[str] = None¶: The name of the event destination

sns_destination: pulumi.Output[dict] = None¶

Send the events to an SNS Topic destination

topic_arn (str) - The ARN of the SNS topic

static get(resource_name, id, opts=None, cloudwatch_destinations=None, configuration_set_name=None, enabled=None, kinesis_destination=None, matching_types=None, name=None, sns_destination=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cloudwatch_destinations (pulumi.Input[list]) – CloudWatch destination for the events
configuration_set_name (pulumi.Input[str]) – The name of the configuration set
enabled (pulumi.Input[bool]) – If true, the event destination will be enabled
kinesis_destination (pulumi.Input[dict]) – Send the events to a kinesis firehose destination
matching_types (pulumi.Input[list]) – A list of matching types. May be any of "send", "reject", "bounce", "complaint", "delivery", "open", "click", or "renderingFailure".
name (pulumi.Input[str]) – The name of the event destination
sns_destination (pulumi.Input[dict]) – Send the events to an SNS Topic destination

The cloudwatch_destinations object supports the following:

default_value (pulumi.Input[str]) - The default value for the event
dimensionName (pulumi.Input[str]) - The name for the dimension
valueSource (pulumi.Input[str]) - The source for the value. It can be either "messageTag" or "emailHeader"

The kinesis_destination object supports the following:

role_arn (pulumi.Input[str]) - The ARN of the role that has permissions to access the Kinesis Stream
stream_arn (pulumi.Input[str]) - The ARN of the Kinesis Stream

The sns_destination object supports the following:

topic_arn (pulumi.Input[str]) - The ARN of the SNS topic

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.IdentityNotificationTopic(resource_name, opts=None, identity=None, include_original_headers=None, notification_type=None, topic_arn=None, __props__=None, __name__=None, __opts__=None)¶

Resource for managing SES Identity Notification Topics

import pulumi
import pulumi_aws as aws

test = aws.ses.IdentityNotificationTopic("test",
    identity=aws_ses_domain_identity["example"]["domain"],
    include_original_headers=True,
    notification_type="Bounce",
    topic_arn=aws_sns_topic["example"]["arn"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[str]) – 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).
include_original_headers (pulumi.Input[bool]) – Whether SES should include original email headers in SNS notifications of this type. false by default.
notification_type (pulumi.Input[str]) – The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
topic_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

identity: pulumi.Output[str] = None¶: 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).

include_original_headers: pulumi.Output[bool] = None¶: Whether SES should include original email headers in SNS notifications of this type. false by default.

notification_type: pulumi.Output[str] = None¶: The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.

topic_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

static get(resource_name, id, opts=None, identity=None, include_original_headers=None, notification_type=None, topic_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[str]) – 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).
include_original_headers (pulumi.Input[bool]) – Whether SES should include original email headers in SNS notifications of this type. false by default.
notification_type (pulumi.Input[str]) – The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: Bounce, Complaint or Delivery.
topic_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to “” (an empty string) to disable publishing.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.IdentityPolicy(resource_name, opts=None, identity=None, name=None, policy=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_aws as aws

example_domain_identity = aws.ses.DomainIdentity("exampleDomainIdentity", domain="example.com")
example_policy_document = example_domain_identity.arn.apply(lambda arn: aws.iam.get_policy_document(statements=[{
    "actions": [
        "SES:SendEmail",
        "SES:SendRawEmail",
    ],
    "principals": [{
        "identifiers": ["*"],
        "type": "AWS",
    }],
    "resources": [arn],
}]))
example_identity_policy = aws.ses.IdentityPolicy("exampleIdentityPolicy",
    identity=example_domain_identity.arn,
    policy=example_policy_document.json)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[str]) – Name or Amazon Resource Name (ARN) of the SES Identity.
name (pulumi.Input[str]) – Name of the policy.
policy (pulumi.Input[str]) – JSON string of the policy.

identity: pulumi.Output[str] = None¶: Name or Amazon Resource Name (ARN) of the SES Identity.

name: pulumi.Output[str] = None¶: Name of the policy.

policy: pulumi.Output[str] = None¶: JSON string of the policy.

static get(resource_name, id, opts=None, identity=None, name=None, policy=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
identity (pulumi.Input[str]) – Name or Amazon Resource Name (ARN) of the SES Identity.
name (pulumi.Input[str]) – Name of the policy.
policy (pulumi.Input[str]) – JSON string of the policy.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.MailFrom(resource_name, opts=None, behavior_on_mx_failure=None, domain=None, mail_from_domain=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES domain MAIL FROM resource.

NOTE: For the MAIL FROM domain to be fully usable, this resource should be paired with the 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.

import pulumi
import pulumi_aws as aws

# Example SES Domain Identity
example_domain_identity = aws.ses.DomainIdentity("exampleDomainIdentity", domain="example.com")
example_mail_from = aws.ses.MailFrom("exampleMailFrom",
    domain=example_domain_identity.domain,
    mail_from_domain=example_domain_identity.domain.apply(lambda domain: f"bounce.{domain}"))
# Example Route53 MX record
example_ses_domain_mail_from_mx = aws.route53.Record("exampleSesDomainMailFromMx",
    name=example_mail_from.mail_from_domain,
    records=["10 feedback-smtp.us-east-1.amazonses.com"],
    ttl="600",
    type="MX",
    zone_id=aws_route53_zone["example"]["id"])
# Example Route53 TXT record for SPF
example_ses_domain_mail_from_txt = aws.route53.Record("exampleSesDomainMailFromTxt",
    name=example_mail_from.mail_from_domain,
    records=["v=spf1 include:amazonses.com -all"],
    ttl="600",
    type="TXT",
    zone_id=aws_route53_zone["example"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
behavior_on_mx_failure (pulumi.Input[str]) – 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.
domain (pulumi.Input[str]) – Verified domain name to generate DKIM tokens for.
mail_from_domain (pulumi.Input[str]) – Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

behavior_on_mx_failure: pulumi.Output[str] = None¶: 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.

domain: pulumi.Output[str] = None¶: Verified domain name to generate DKIM tokens for.

mail_from_domain: pulumi.Output[str] = None¶: Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

static get(resource_name, id, opts=None, behavior_on_mx_failure=None, domain=None, mail_from_domain=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
behavior_on_mx_failure (pulumi.Input[str]) –
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.
domain (pulumi.Input[str]) – Verified domain name to generate DKIM tokens for.
mail_from_domain (pulumi.Input[str]) – Subdomain (of above domain) which is to be used as MAIL FROM address (Required for DMARC validation)

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.ReceiptFilter(resource_name, opts=None, cidr=None, name=None, policy=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES receipt filter resource

import pulumi
import pulumi_aws as aws

filter = aws.ses.ReceiptFilter("filter",
    cidr="10.10.10.10",
    policy="Block")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr (pulumi.Input[str]) – The IP address or address range to filter, in CIDR notation
name (pulumi.Input[str]) – The name of the filter
policy (pulumi.Input[str]) – Block or Allow

cidr: pulumi.Output[str] = None¶: The IP address or address range to filter, in CIDR notation

name: pulumi.Output[str] = None¶: The name of the filter

policy: pulumi.Output[str] = None¶: Block or Allow

static get(resource_name, id, opts=None, cidr=None, name=None, policy=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr (pulumi.Input[str]) – The IP address or address range to filter, in CIDR notation
name (pulumi.Input[str]) – The name of the filter
policy (pulumi.Input[str]) – Block or Allow

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.ReceiptRule(resource_name, opts=None, add_header_actions=None, after=None, bounce_actions=None, enabled=None, lambda_actions=None, name=None, recipients=None, rule_set_name=None, s3_actions=None, scan_enabled=None, sns_actions=None, stop_actions=None, tls_policy=None, workmail_actions=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES receipt rule resource

import pulumi
import pulumi_aws as aws

# Add a header to the email and store it in S3
store = aws.ses.ReceiptRule("store",
    add_header_actions=[{
        "headerName": "Custom-Header",
        "headerValue": "Added by SES",
        "position": 1,
    }],
    enabled=True,
    recipients=["karen@example.com"],
    rule_set_name="default-rule-set",
    s3_actions=[{
        "bucket_name": "emails",
        "position": 2,
    }],
    scan_enabled=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
add_header_actions (pulumi.Input[list]) – A list of Add Header Action blocks. Documented below.
after (pulumi.Input[str]) – The name of the rule to place this rule after
bounce_actions (pulumi.Input[list]) – A list of Bounce Action blocks. Documented below.
enabled (pulumi.Input[bool]) – If true, the rule will be enabled
lambda_actions (pulumi.Input[list]) – A list of Lambda Action blocks. Documented below.
name (pulumi.Input[str]) – The name of the rule
recipients (pulumi.Input[list]) – A list of email addresses
rule_set_name (pulumi.Input[str]) – The name of the rule set
s3_actions (pulumi.Input[list]) – A list of S3 Action blocks. Documented below.
scan_enabled (pulumi.Input[bool]) – If true, incoming emails will be scanned for spam and viruses
sns_actions (pulumi.Input[list]) – A list of SNS Action blocks. Documented below.
stop_actions (pulumi.Input[list]) – A list of Stop Action blocks. Documented below.
tls_policy (pulumi.Input[str]) – Require or Optional
workmail_actions (pulumi.Input[list]) – A list of WorkMail Action blocks. Documented below.

The add_header_actions object supports the following:

headerName (pulumi.Input[str]) - The name of the header to add
headerValue (pulumi.Input[str]) - The value of the header to add
position (pulumi.Input[float]) - The position of the action in the receipt rule

The bounce_actions object supports the following:

message (pulumi.Input[str]) - The message to send
position (pulumi.Input[float]) - The position of the action in the receipt rule
sender (pulumi.Input[str]) - The email address of the sender
smtpReplyCode (pulumi.Input[str]) - The RFC 5321 SMTP reply code
status_code (pulumi.Input[str]) - The RFC 3463 SMTP enhanced status code
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The lambda_actions object supports the following:

function_arn (pulumi.Input[str]) - The ARN of the Lambda function to invoke
invocationType (pulumi.Input[str]) - Event or RequestResponse
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The s3_actions object supports the following:

bucket_name (pulumi.Input[str]) - The name of the S3 bucket
kms_key_arn (pulumi.Input[str]) - The ARN of the KMS key
objectKeyPrefix (pulumi.Input[str]) - The key prefix of the S3 bucket
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The sns_actions object supports the following:

position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The stop_actions object supports the following:

position (pulumi.Input[float]) - The position of the action in the receipt rule
scope (pulumi.Input[str]) - The scope to apply
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The workmail_actions object supports the following:

organizationArn (pulumi.Input[str]) - The ARN of the WorkMail organization
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

add_header_actions: pulumi.Output[list] = None¶

A list of Add Header Action blocks. Documented below.

headerName (str) - The name of the header to add
headerValue (str) - The value of the header to add
position (float) - The position of the action in the receipt rule

after: pulumi.Output[str] = None¶: The name of the rule to place this rule after

bounce_actions: pulumi.Output[list] = None¶

A list of Bounce Action blocks. Documented below.

message (str) - The message to send
position (float) - The position of the action in the receipt rule
sender (str) - The email address of the sender
smtpReplyCode (str) - The RFC 5321 SMTP reply code
status_code (str) - The RFC 3463 SMTP enhanced status code
topic_arn (str) - The ARN of an SNS topic to notify

enabled: pulumi.Output[bool] = None¶: If true, the rule will be enabled

lambda_actions: pulumi.Output[list] = None¶

A list of Lambda Action blocks. Documented below.

function_arn (str) - The ARN of the Lambda function to invoke
invocationType (str) - Event or RequestResponse
position (float) - The position of the action in the receipt rule
topic_arn (str) - The ARN of an SNS topic to notify

name: pulumi.Output[str] = None¶: The name of the rule

recipients: pulumi.Output[list] = None¶: A list of email addresses

rule_set_name: pulumi.Output[str] = None¶: The name of the rule set

s3_actions: pulumi.Output[list] = None¶

A list of S3 Action blocks. Documented below.

bucket_name (str) - The name of the S3 bucket
kms_key_arn (str) - The ARN of the KMS key
objectKeyPrefix (str) - The key prefix of the S3 bucket
position (float) - The position of the action in the receipt rule
topic_arn (str) - The ARN of an SNS topic to notify

scan_enabled: pulumi.Output[bool] = None¶: If true, incoming emails will be scanned for spam and viruses

sns_actions: pulumi.Output[list] = None¶

A list of SNS Action blocks. Documented below.

position (float) - The position of the action in the receipt rule
topic_arn (str) - The ARN of an SNS topic to notify

stop_actions: pulumi.Output[list] = None¶

A list of Stop Action blocks. Documented below.

position (float) - The position of the action in the receipt rule
scope (str) - The scope to apply
topic_arn (str) - The ARN of an SNS topic to notify

tls_policy: pulumi.Output[str] = None¶: Require or Optional

workmail_actions: pulumi.Output[list] = None¶

A list of WorkMail Action blocks. Documented below.

organizationArn (str) - The ARN of the WorkMail organization
position (float) - The position of the action in the receipt rule
topic_arn (str) - The ARN of an SNS topic to notify

static get(resource_name, id, opts=None, add_header_actions=None, after=None, bounce_actions=None, enabled=None, lambda_actions=None, name=None, recipients=None, rule_set_name=None, s3_actions=None, scan_enabled=None, sns_actions=None, stop_actions=None, tls_policy=None, workmail_actions=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
add_header_actions (pulumi.Input[list]) – A list of Add Header Action blocks. Documented below.
after (pulumi.Input[str]) – The name of the rule to place this rule after
bounce_actions (pulumi.Input[list]) – A list of Bounce Action blocks. Documented below.
enabled (pulumi.Input[bool]) – If true, the rule will be enabled
lambda_actions (pulumi.Input[list]) – A list of Lambda Action blocks. Documented below.
name (pulumi.Input[str]) – The name of the rule
recipients (pulumi.Input[list]) – A list of email addresses
rule_set_name (pulumi.Input[str]) – The name of the rule set
s3_actions (pulumi.Input[list]) – A list of S3 Action blocks. Documented below.
scan_enabled (pulumi.Input[bool]) – If true, incoming emails will be scanned for spam and viruses
sns_actions (pulumi.Input[list]) – A list of SNS Action blocks. Documented below.
stop_actions (pulumi.Input[list]) – A list of Stop Action blocks. Documented below.
tls_policy (pulumi.Input[str]) – Require or Optional
workmail_actions (pulumi.Input[list]) – A list of WorkMail Action blocks. Documented below.

The add_header_actions object supports the following:

headerName (pulumi.Input[str]) - The name of the header to add
headerValue (pulumi.Input[str]) - The value of the header to add
position (pulumi.Input[float]) - The position of the action in the receipt rule

The bounce_actions object supports the following:

message (pulumi.Input[str]) - The message to send
position (pulumi.Input[float]) - The position of the action in the receipt rule
sender (pulumi.Input[str]) - The email address of the sender
smtpReplyCode (pulumi.Input[str]) - The RFC 5321 SMTP reply code
status_code (pulumi.Input[str]) - The RFC 3463 SMTP enhanced status code
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The lambda_actions object supports the following:

function_arn (pulumi.Input[str]) - The ARN of the Lambda function to invoke
invocationType (pulumi.Input[str]) - Event or RequestResponse
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The s3_actions object supports the following:

bucket_name (pulumi.Input[str]) - The name of the S3 bucket
kms_key_arn (pulumi.Input[str]) - The ARN of the KMS key
objectKeyPrefix (pulumi.Input[str]) - The key prefix of the S3 bucket
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The sns_actions object supports the following:

position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The stop_actions object supports the following:

position (pulumi.Input[float]) - The position of the action in the receipt rule
scope (pulumi.Input[str]) - The scope to apply
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

The workmail_actions object supports the following:

organizationArn (pulumi.Input[str]) - The ARN of the WorkMail organization
position (pulumi.Input[float]) - The position of the action in the receipt rule
topic_arn (pulumi.Input[str]) - The ARN of an SNS topic to notify

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.ReceiptRuleSet(resource_name, opts=None, rule_set_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SES receipt rule set resource

import pulumi
import pulumi_aws as aws

main = aws.ses.ReceiptRuleSet("main", rule_set_name="primary-rules")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
rule_set_name (pulumi.Input[str]) – The name of the rule set

rule_set_name: pulumi.Output[str] = None¶: The name of the rule set

static get(resource_name, id, opts=None, rule_set_name=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
rule_set_name (pulumi.Input[str]) – The name of the rule set

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.ses.Template(resource_name, opts=None, html=None, name=None, subject=None, text=None, __props__=None, __name__=None, __opts__=None)¶

Provides a resource to create a SES template.

import pulumi
import pulumi_aws as aws

my_template = 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}}.
""")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
html (pulumi.Input[str]) – The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.
name (pulumi.Input[str]) – The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.
subject (pulumi.Input[str]) – The subject line of the email.
text (pulumi.Input[str]) – 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.

html: pulumi.Output[str] = None¶: The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.

name: pulumi.Output[str] = None¶: The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.

subject: pulumi.Output[str] = None¶: The subject line of the email.

text: pulumi.Output[str] = None¶: 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.

static get(resource_name, id, opts=None, html=None, name=None, subject=None, text=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
html (pulumi.Input[str]) – The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.
name (pulumi.Input[str]) – The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.
subject (pulumi.Input[str]) – The subject line of the email.
text (pulumi.Input[str]) – 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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

ses¶

On This Page