Class CfnReceiptRuleProps

Properties for defining a CfnReceiptRule.

Inheritance

object

CfnReceiptRuleProps

Implements

ICfnReceiptRuleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnReceiptRuleProps : ICfnReceiptRuleProps

Syntax (vb)

Public Class CfnReceiptRuleProps Implements ICfnReceiptRuleProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.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 cfnReceiptRuleProps = new CfnReceiptRuleProps {
                 Rule = 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"
                 },
                 RuleSetName = "ruleSetName",

                 // the properties below are optional
                 After = "after"
             };

Synopsis

Constructors

CfnReceiptRuleProps()

Properties for defining a CfnReceiptRule.

Properties

After	The name of an existing rule after which the new rule is placed.
Rule	A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
RuleSetName	The name of the rule set where the receipt rule is added.

Constructors

CfnReceiptRuleProps()

Properties for defining a CfnReceiptRule.

public CfnReceiptRuleProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.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 cfnReceiptRuleProps = new CfnReceiptRuleProps {
                 Rule = 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"
                 },
                 RuleSetName = "ruleSetName",

                 // the properties below are optional
                 After = "after"
             };

Properties

After

The name of an existing rule after which the new rule is placed.

public string? After { get; set; }

Property Value

string

Remarks

If this parameter is null, the new rule is inserted at the beginning of the rule list.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html#cfn-ses-receiptrule-after

Rule

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

public object Rule { get; set; }

Property Value

object

Remarks

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

RuleSetName

The name of the rule set where the receipt rule is added.

public string RuleSetName { get; set; }