ses

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

Provides a resource to designate the active SES receipt rule set

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 = None

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, __name__=None, __opts__=None)

Provides an SES configuration set resource

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 = None

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, __name__=None, __opts__=None)

Provides an SES domain DKIM generation resource.

Domain ownership needs to be confirmed first using ses_domain_identity Resource

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 = 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 Terraform. Find out more about verifying domains in Amazon SES in the AWS SES docs.

domain = None

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, __name__=None, __opts__=None)

Provides an SES domain identity resource

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 = None

The ARN of the domain identity.

domain = None

The domain name to assign to SES

verification_token = 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 Terraform. 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, __name__=None, __opts__=None)

Represents a successful verification of an SES domain identity.

Most commonly, this resource is used together with aws_route53_record and aws_ses_domain_identity 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.
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 = None

The ARN of the domain identity.

domain = None

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, __name__=None, __opts__=None)

Provides an SES email identity resource

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 = None

The ARN of the email identity.

email = None

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, __name__=None, __opts__=None)

Provides an SES event destination

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
cloudwatch_destinations = None

CloudWatch destination for the events

configuration_set_name = None

The name of the configuration set

enabled = None

If true, the event destination will be enabled

kinesis_destination = None

Send the events to a kinesis firehose destination

matching_types = None

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

name = None

The name of the event destination

sns_destination = None

Send the events to an SNS Topic destination

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, notification_type=None, topic_arn=None, __name__=None, __opts__=None)

Resource for managing SES Identity Notification Topics

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).
  • 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 = 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).

notification_type = None

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

topic_arn = None

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.MailFrom(resource_name, opts=None, behavior_on_mx_failure=None, domain=None, mail_from_domain=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 aws_ses_domain_identity 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.
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 = 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 = None

Verified domain name to generate DKIM tokens for.

mail_from_domain = None

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, __name__=None, __opts__=None)

Provides an SES receipt filter resource

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 = None

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

name = None

The name of the filter

policy = None

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, __name__=None, __opts__=None)

Provides an SES receipt rule resource

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.
add_header_actions = None

A list of Add Header Action blocks. Documented below.

after = None

The name of the rule to place this rule after

bounce_actions = None

A list of Bounce Action blocks. Documented below.

enabled = None

If true, the rule will be enabled

lambda_actions = None

A list of Lambda Action blocks. Documented below.

name = None

The name of the rule

recipients = None

A list of email addresses

rule_set_name = None

The name of the rule set

s3_actions = None

A list of S3 Action blocks. Documented below.

scan_enabled = None

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

sns_actions = None

A list of SNS Action blocks. Documented below.

stop_actions = None

A list of Stop Action blocks. Documented below.

tls_policy = None

Require or Optional

workmail_actions = None

A list of WorkMail Action blocks. Documented below.

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, __name__=None, __opts__=None)

Provides an SES receipt rule set resource

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 = None

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, __name__=None, __opts__=None)

Provides a resource to create a SES template.

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 = None

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

name = None

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

subject = None

The subject line of the email.

text = 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.

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