class Aws::SES::Types::CreateReceiptRuleRequest
Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES
. For more information, see the [Amazon SES
Developer Guide].
[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
@note When making an API call, you may pass CreateReceiptRuleRequest
data as a hash: { rule_set_name: "ReceiptRuleSetName", # required after: "ReceiptRuleName", rule: { # required name: "ReceiptRuleName", # required enabled: false, tls_policy: "Require", # accepts Require, Optional recipients: ["Recipient"], actions: [ { s3_action: { topic_arn: "AmazonResourceName", bucket_name: "S3BucketName", # required object_key_prefix: "S3KeyPrefix", kms_key_arn: "AmazonResourceName", }, bounce_action: { topic_arn: "AmazonResourceName", smtp_reply_code: "BounceSmtpReplyCode", # required status_code: "BounceStatusCode", message: "BounceMessage", # required sender: "Address", # required }, workmail_action: { topic_arn: "AmazonResourceName", organization_arn: "AmazonResourceName", # required }, lambda_action: { topic_arn: "AmazonResourceName", function_arn: "AmazonResourceName", # required invocation_type: "Event", # accepts Event, RequestResponse }, stop_action: { scope: "RuleSet", # required, accepts RuleSet topic_arn: "AmazonResourceName", }, add_header_action: { header_name: "HeaderName", # required header_value: "HeaderValue", # required }, sns_action: { topic_arn: "AmazonResourceName", # required encoding: "UTF-8", # accepts UTF-8, Base64 }, }, ], scan_enabled: false, }, }
@!attribute [rw] rule_set_name
The name of the rule set that the receipt rule will be added to. @return [String]
@!attribute [rw] after
The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. @return [String]
@!attribute [rw] rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy. @return [Types::ReceiptRule]
@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleRequest AWS API Documentation
Constants
- SENSITIVE