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

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

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – 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

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

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

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

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

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.

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

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

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

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

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

  • 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

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

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

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.

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.

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.

identity = None

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

name = None

Name 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.

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.

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)

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

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

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

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

The name of the rule to place this rule after

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

If true, the rule will be enabled

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

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

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

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

Require or Optional

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

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

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.

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.

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