aws-cdk-lib.aws_ses.CfnReceiptRuleProps

interface CfnReceiptRuleProps

LanguageType name
.NETAmazon.CDK.AWS.SES.CfnReceiptRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnReceiptRuleProps
Javasoftware.amazon.awscdk.services.ses.CfnReceiptRuleProps
Pythonaws_cdk.aws_ses.CfnReceiptRuleProps
TypeScript aws-cdk-lib » aws_ses » CfnReceiptRuleProps

Properties for defining a CfnReceiptRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const cfnReceiptRuleProps: ses.CfnReceiptRuleProps = {
  rule: {
    actions: [{
      addHeaderAction: {
        headerName: 'headerName',
        headerValue: 'headerValue',
      },
      bounceAction: {
        message: 'message',
        sender: 'sender',
        smtpReplyCode: 'smtpReplyCode',

        // the properties below are optional
        statusCode: 'statusCode',
        topicArn: 'topicArn',
      },
      lambdaAction: {
        functionArn: 'functionArn',

        // the properties below are optional
        invocationType: 'invocationType',
        topicArn: 'topicArn',
      },
      s3Action: {
        bucketName: 'bucketName',

        // the properties below are optional
        kmsKeyArn: 'kmsKeyArn',
        objectKeyPrefix: 'objectKeyPrefix',
        topicArn: 'topicArn',
      },
      snsAction: {
        encoding: 'encoding',
        topicArn: 'topicArn',
      },
      stopAction: {
        scope: 'scope',

        // the properties below are optional
        topicArn: 'topicArn',
      },
      workmailAction: {
        organizationArn: 'organizationArn',

        // the properties below are optional
        topicArn: 'topicArn',
      },
    }],
    enabled: false,
    name: 'name',
    recipients: ['recipients'],
    scanEnabled: false,
    tlsPolicy: 'tlsPolicy',
  },
  ruleSetName: 'ruleSetName',

  // the properties below are optional
  after: 'after',
};

Properties

NameTypeDescription
ruleIResolvable | RulePropertyA data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
ruleSetNamestringThe name of the rule set where the receipt rule is added.
after?stringThe name of an existing rule after which the new rule is placed.

rule

Type: IResolvable | RuleProperty

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


ruleSetName

Type: string

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


after?

Type: string (optional)

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

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