Class CfnReceiptRule

A CloudFormation AWS::SES::ReceiptRule.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnReceiptRule

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.AWS.SES.dll

Syntax (csharp)

public class CfnReceiptRule : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnReceiptRule
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

Specifies a receipt rule.

CloudformationResource: AWS::SES::ReceiptRule

Link: 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;

CfnReceiptRule 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(Construct, String, ICfnReceiptRuleProps)	Create a new AWS::SES::ReceiptRule.
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

Properties

After	The name of an existing rule after which the new rule is placed.
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(Construct, String, ICfnReceiptRuleProps)

Create a new AWS::SES::ReceiptRule.

public CfnReceiptRule(Construct scope, string id, ICfnReceiptRuleProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id System.String

• scoped id of the resource.

props ICfnReceiptRuleProps

• resource properties.

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

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

Remarks

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

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

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

CfnResource.CfnProperties

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

Remarks

Link: 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 virtual string RuleSetName { get; set; }

Property Value

System.String

Remarks

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

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable