Class CfnReceiptRule
Specifies a receipt rule.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReceiptRule : CfnResource, IInspectable
Syntax (vb)
Public Class CfnReceiptRule
Inherits CfnResource
Implements IInspectable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptrule.html
CloudformationResource: AWS::SES::ReceiptRule
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 cfnReceiptRule = new CfnReceiptRule(this, "MyCfnReceiptRule", 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"
},
LambdaAction = new LambdaActionProperty {
FunctionArn = "functionArn",
// the properties below are optional
InvocationType = "invocationType",
TopicArn = "topicArn"
},
S3Action = new S3ActionProperty {
BucketName = "bucketName",
// the properties below are optional
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
CfnReceiptRule(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReceiptRule(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnReceiptRule(Construct, String, ICfnReceiptRuleProps) |
Properties
After | The name of an existing rule after which the new rule is placed. |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReceiptRule(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReceiptRule(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReceiptRule(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReceiptRule(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnReceiptRule(Construct, String, ICfnReceiptRuleProps)
public CfnReceiptRule(Construct scope, string id, ICfnReceiptRuleProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnReceiptRuleProps
Resource properties.
Properties
After
The name of an existing rule after which the new rule is placed.
public virtual string After { get; set; }
Property Value
System.String
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
public virtual object Rule { get; set; }
Property Value
System.Object
RuleSetName
The name of the rule set where the receipt rule is added.
public virtual string RuleSetName { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>