Interface CfnReceiptRule.IRuleProperty

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnReceiptRule.IRuleProperty

Syntax (vb)

Public Interface CfnReceiptRule.IRuleProperty

Remarks

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-rule.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SES;

             var ruleProperty = new RuleProperty {
                 Actions = new [] { new ActionProperty {
                     AddHeaderAction = new AddHeaderActionProperty {
                         HeaderName = "headerName",
                         HeaderValue = "headerValue"
                     },
                     BounceAction = new BounceActionProperty {
                         Message = "message",
                         Sender = "sender",
                         SmtpReplyCode = "smtpReplyCode",

                         // the properties below are optional
                         StatusCode = "statusCode",
                         TopicArn = "topicArn"
                     },
                     ConnectAction = new ConnectActionProperty {
                         IamRoleArn = "iamRoleArn",
                         InstanceArn = "instanceArn"
                     },
                     LambdaAction = new LambdaActionProperty {
                         FunctionArn = "functionArn",

                         // the properties below are optional
                         InvocationType = "invocationType",
                         TopicArn = "topicArn"
                     },
                     S3Action = new S3ActionProperty {
                         BucketName = "bucketName",

                         // the properties below are optional
                         IamRoleArn = "iamRoleArn",
                         KmsKeyArn = "kmsKeyArn",
                         ObjectKeyPrefix = "objectKeyPrefix",
                         TopicArn = "topicArn"
                     },
                     SnsAction = new SNSActionProperty {
                         Encoding = "encoding",
                         TopicArn = "topicArn"
                     },
                     StopAction = new StopActionProperty {
                         Scope = "scope",

                         // the properties below are optional
                         TopicArn = "topicArn"
                     },
                     WorkmailAction = new WorkmailActionProperty {
                         OrganizationArn = "organizationArn",

                         // the properties below are optional
                         TopicArn = "topicArn"
                     }
                 } },
                 Enabled = false,
                 Name = "name",
                 Recipients = new [] { "recipients" },
                 ScanEnabled = false,
                 TlsPolicy = "tlsPolicy"
             };

Synopsis

Properties

Actions	An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
Enabled	If `true` , the receipt rule is active.
Name	The name of the receipt rule. The name must meet the following requirements:.
Recipients	The recipient domains and email addresses that the receipt rule applies to.
ScanEnabled	If `true` , then messages that this receipt rule applies to are scanned for spam and viruses.
TlsPolicy	Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).