github.com/pmcatominey/terraform@v0.7.0-rc2.0.20160708105029-1401a52a5cc5/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  ```
    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  * `recipients` - (Optional) A list of email addresses
    45  * `scan_enabled` - (Optional) If true, incoming emails will be scanned for spam and viruses
    46  * `tls_policy` - (Optional) Require or Optional
    47  * `add_header_action` - (Optional) A list of Add Header Action blocks. Documented below.
    48  * `bounce_action` - (Optional) A list of Bounce Action blocks. Documented below.
    49  * `lambda_action` - (Optional) A list of Lambda Action blocks. Documented below.
    50  * `s3_action` - (Optional) A list of S3 Action blocks. Documented below.
    51  * `sns_action` - (Optional) A list of SNS Action blocks. Documented below.
    52  * `stop_action` - (Optional) A list of Stop Action blocks. Documented below.
    53  * `workmail_action` - (Optional) A list of WorkMail Action blocks. Documented below.
    54  
    55  Add header actions support the following:
    56  
    57  * `header_name` - (Required) The name of the header to add
    58  * `header_value` - (Required) The value of the header to add
    59  * `position` - (Required) The position of the action in the receipt rule
    60  
    61  Bounce actions support the following:
    62  
    63  * `message` - (Required) The message to send
    64  * `sender` - (Required) The email address of the sender
    65  * `smtp_reply_code` - (Required) The RFC 5321 SMTP reply code
    66  * `status_code` - (Optional) The RFC 3463 SMTP enhanced status code
    67  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    68  * `position` - (Required) The position of the action in the receipt rule
    69  
    70  Lambda actions support the following:
    71  
    72  * `function_arn` - (Required) The ARN of the Lambda function to invoke
    73  * `invocation_type` - (Optional) Event or RequestResponse
    74  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    75  * `position` - (Required) The position of the action in the receipt rule
    76  
    77  S3 actions support the following:
    78  
    79  * `bucket_name` - (Required) The name of the S3 bucket
    80  * `kms_key_arn` - (Optional) The ARN of the KMS key
    81  * `object_key_prefix` - (Optional) The key prefix of the S3 bucket
    82  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    83  * `position` - (Required) The position of the action in the receipt rule
    84  
    85  SNS actions support the following:
    86  
    87  * `topic_arn` - (Required) The ARN of an SNS topic to notify
    88  * `position` - (Required) The position of the action in the receipt rule
    89  
    90  Stop actions support the following:
    91  
    92  * `scope` - (Required) The scope to apply
    93  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
    94  * `position` - (Required) The position of the action in the receipt rule
    95  
    96  WorkMail actions support the following:
    97  
    98  * `organization_arn` - (Required) The ARN of the WorkMail organization
    99  * `topic_arn` - (Optional) The ARN of an SNS topic to notify
   100  * `position` - (Required) The position of the action in the receipt rule