github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/aws/r/ses_receipt_rule.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: ses_receipt_rule"
     4  sidebar_current: "docs-aws-resource-ses-receipt-rule"
     5  description: |-
     6    Provides an SES receipt rule resource
     7  ---
     8  
     9  # aws\_ses\_receipt_rule
    10  
    11  Provides an SES receipt rule resource
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  # Add a header to the email and store it in S3
    17  resource "aws_ses_receipt_rule" "store" {
    18    name          = "store"
    19    rule_set_name = "default-rule-set"
    20    recipients    = ["karen@example.com"]
    21    enabled       = true
    22    scan_enabled  = true
    23  
    24    add_header_action {
    25      header_name  = "Custom-Header"
    26      header_value = "Added by SES"
    27    }
    28  
    29    s3_action {
    30      bucket_name = "emails"
    31    }
    32  }
    33  ```
    34  
    35  ## Argument Reference
    36  
    37  The following arguments are supported:
    38  
    39  * `name` - (Required) The name of the rule
    40  * `rule_set_name` - (Required) The name of the rule set
    41  * `after` - (Optional) The name of the rule to place this rule after
    42  * `enabled` - (Optional) If true, the rule will be enabled
    43  * `recipients` - (Optional) A list of email addresses
    44  * `scan_enabled` - (Optional) If true, incoming emails will be scanned for spam and viruses
    45  * `tls_policy` - (Optional) Require or Optional
    46  * `add_header_action` - (Optional) A list of Add Header Action blocks. Documented below.
    47  * `bounce_action` - (Optional) A list of Bounce Action blocks. Documented below.
    48  * `lambda_action` - (Optional) A list of Lambda Action blocks. Documented below.
    49  * `s3_action` - (Optional) A list of S3 Action blocks. Documented below.
    50  * `sns_action` - (Optional) A list of SNS Action blocks. Documented below.
    51  * `stop_action` - (Optional) A list of Stop Action blocks. Documented below.
    52  * `workmail_action` - (Optional) A list of WorkMail Action blocks. Documented below.
    53  
    54  Add header actions support the following:
    55  
    56  * `header_name` - (Required) The name of the header to add
    57  * `header_value` - (Required) The value of the header to add
    58  * `position` - (Required) The position of the action in the receipt rule
    59  
    60  Bounce actions support the following:
    61  
    62  * `message` - (Required) The message to send
    63  * `sender` - (Required) The email address of the sender
    64  * `smtp_reply_code` - (Required) The RFC 5321 SMTP reply code
    65  * `status_code` - (Optional) The RFC 3463 SMTP enhanced status code
    66  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    67  * `position` - (Required) The position of the action in the receipt rule
    68  
    69  Lambda actions support the following:
    70  
    71  * `function_arn` - (Required) The ARN of the Lambda function to invoke
    72  * `invocation_type` - (Optional) Event or RequestResponse
    73  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    74  * `position` - (Required) The position of the action in the receipt rule
    75  
    76  S3 actions support the following:
    77  
    78  * `bucket_name` - (Required) The name of the S3 bucket
    79  * `kms_key_arn` - (Optional) The ARN of the KMS key
    80  * `object_key_prefix` - (Optional) The key prefix of the S3 bucket
    81  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    82  * `position` - (Required) The position of the action in the receipt rule
    83  
    84  SNS actions support the following:
    85  
    86  * `topic_arn` - (Required) The ARN of an SNS topic to notify
    87  * `position` - (Required) The position of the action in the receipt rule
    88  
    89  Stop actions support the following:
    90  
    91  * `scope` - (Required) The scope to apply
    92  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    93  * `position` - (Required) The position of the action in the receipt rule
    94  
    95  WorkMail actions support the following:
    96  
    97  * `organization_arn` - (Required) The ARN of the WorkMail organization
    98  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    99  * `position` - (Required) The position of the action in the receipt rule