Show / Hide Table of Contents

Class CfnMailManagerRuleSet

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnMailManagerRuleSet
Implements
IInspectable
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMailManagerRuleSet : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnMailManagerRuleSet Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

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 drop;

             var cfnMailManagerRuleSet = new CfnMailManagerRuleSet(this, "MyCfnMailManagerRuleSet", new CfnMailManagerRuleSetProps {
                 Rules = new [] { new RuleProperty {
                     Actions = new [] { new RuleActionProperty {
                         AddHeader = new AddHeaderActionProperty {
                             HeaderName = "headerName",
                             HeaderValue = "headerValue"
                         },
                         Archive = new ArchiveActionProperty {
                             TargetArchive = "targetArchive",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy"
                         },
                         DeliverToMailbox = new DeliverToMailboxActionProperty {
                             MailboxArn = "mailboxArn",
                             RoleArn = "roleArn",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy"
                         },
                         DeliverToQBusiness = new DeliverToQBusinessActionProperty {
                             ApplicationId = "applicationId",
                             IndexId = "indexId",
                             RoleArn = "roleArn",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy"
                         },
                         Drop = drop,
                         PublishToSns = new SnsActionProperty {
                             RoleArn = "roleArn",
                             TopicArn = "topicArn",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy",
                             Encoding = "encoding",
                             PayloadType = "payloadType"
                         },
                         Relay = new RelayActionProperty {
                             Relay = "relay",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy",
                             MailFrom = "mailFrom"
                         },
                         ReplaceRecipient = new ReplaceRecipientActionProperty {
                             ReplaceWith = new [] { "replaceWith" }
                         },
                         Send = new SendActionProperty {
                             RoleArn = "roleArn",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy"
                         },
                         WriteToS3 = new S3ActionProperty {
                             RoleArn = "roleArn",
                             S3Bucket = "s3Bucket",

                             // the properties below are optional
                             ActionFailurePolicy = "actionFailurePolicy",
                             S3Prefix = "s3Prefix",
                             S3SseKmsKeyId = "s3SseKmsKeyId"
                         }
                     } },

                     // the properties below are optional
                     Conditions = new [] { new RuleConditionProperty {
                         BooleanExpression = new RuleBooleanExpressionProperty {
                             Evaluate = new RuleBooleanToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute",
                                 IsInAddressList = new RuleIsInAddressListProperty {
                                     AddressLists = new [] { "addressLists" },
                                     Attribute = "attribute"
                                 }
                             },
                             Operator = "operator"
                         },
                         DmarcExpression = new RuleDmarcExpressionProperty {
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         IpExpression = new RuleIpExpressionProperty {
                             Evaluate = new RuleIpToEvaluateProperty {
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         NumberExpression = new RuleNumberExpressionProperty {
                             Evaluate = new RuleNumberToEvaluateProperty {
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Value = 123
                         },
                         StringExpression = new RuleStringExpressionProperty {
                             Evaluate = new RuleStringToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute",
                                 MimeHeaderAttribute = "mimeHeaderAttribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         VerdictExpression = new RuleVerdictExpressionProperty {
                             Evaluate = new RuleVerdictToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         }
                     } },
                     Name = "name",
                     Unless = new [] { new RuleConditionProperty {
                         BooleanExpression = new RuleBooleanExpressionProperty {
                             Evaluate = new RuleBooleanToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute",
                                 IsInAddressList = new RuleIsInAddressListProperty {
                                     AddressLists = new [] { "addressLists" },
                                     Attribute = "attribute"
                                 }
                             },
                             Operator = "operator"
                         },
                         DmarcExpression = new RuleDmarcExpressionProperty {
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         IpExpression = new RuleIpExpressionProperty {
                             Evaluate = new RuleIpToEvaluateProperty {
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         NumberExpression = new RuleNumberExpressionProperty {
                             Evaluate = new RuleNumberToEvaluateProperty {
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Value = 123
                         },
                         StringExpression = new RuleStringExpressionProperty {
                             Evaluate = new RuleStringToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute",
                                 MimeHeaderAttribute = "mimeHeaderAttribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         },
                         VerdictExpression = new RuleVerdictExpressionProperty {
                             Evaluate = new RuleVerdictToEvaluateProperty {
                                 Analysis = new AnalysisProperty {
                                     Analyzer = "analyzer",
                                     ResultField = "resultField"
                                 },
                                 Attribute = "attribute"
                             },
                             Operator = "operator",
                             Values = new [] { "values" }
                         }
                     } }
                 } },

                 // the properties below are optional
                 RuleSetName = "ruleSetName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnMailManagerRuleSet(Construct, string, ICfnMailManagerRuleSetProps)

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

Properties

AttrRuleSetArn

The Amazon Resource Name (ARN) of the rule set resource.

AttrRuleSetId

The identifier of the rule set.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

RuleSetName

A user-friendly name for the rule set.

Rules

Conditional rules that are evaluated for determining actions on email.

Tags

The tags used to organize, track, or control access for the resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

Constructors

CfnMailManagerRuleSet(Construct, string, ICfnMailManagerRuleSetProps)

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

public CfnMailManagerRuleSet(Construct scope, string id, ICfnMailManagerRuleSetProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnMailManagerRuleSetProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

Properties

AttrRuleSetArn

The Amazon Resource Name (ARN) of the rule set resource.

public virtual string AttrRuleSetArn { get; }
Property Value

string

Remarks

CloudformationAttribute: RuleSetArn

AttrRuleSetId

The identifier of the rule set.

public virtual string AttrRuleSetId { get; }
Property Value

string

Remarks

CloudformationAttribute: RuleSetId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

CfnProperties

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

RuleSetName

A user-friendly name for the rule set.

public virtual string? RuleSetName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

Rules

Conditional rules that are evaluated for determining actions on email.

public virtual object Rules { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

Tags

The tags used to organize, track, or control access for the resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerruleset.html

CloudformationResource: AWS::SES::MailManagerRuleSet

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggableV2
Back to top Generated by DocFX