aws-cdk-lib.aws_ses_actions.AddHeader

class AddHeader

LanguageType name
.NETAmazon.CDK.AWS.SES.Actions.AddHeader
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssesactions#AddHeader
Javasoftware.amazon.awscdk.services.ses.actions.AddHeader
Pythonaws_cdk.aws_ses_actions.AddHeader
TypeScript (source)aws-cdk-lib » aws_ses_actions » AddHeader

Implements IReceiptRuleAction

Adds a header to the received email.

Example

import * as s3 from 'aws-cdk-lib/aws-s3';
import * as actions from 'aws-cdk-lib/aws-ses-actions';

const bucket = new s3.Bucket(this, 'Bucket');
const topic = new sns.Topic(this, 'Topic');

new ses.ReceiptRuleSet(this, 'RuleSet', {
  rules: [
    {
      recipients: ['hello@aws.com'],
      actions: [
        new actions.AddHeader({
          name: 'X-Special-Header',
          value: 'aws',
        }),
        new actions.S3({
          bucket,
          objectKeyPrefix: 'emails/',
          topic,
        }),
      ],
    },
    {
      recipients: ['aws.com'],
      actions: [
        new actions.Sns({
          topic,
        }),
      ],
    },
  ],
});

Initializer

new AddHeader(props: AddHeaderProps)

Parameters

  • props AddHeaderProps

Methods

NameDescription
bind(_rule)Returns the receipt rule action specification.

bind(_rule)

public bind(_rule: IReceiptRule): ReceiptRuleActionConfig

Parameters

  • _rule IReceiptRule

Returns

  • ReceiptRuleActionConfig

Returns the receipt rule action specification.