Package software.amazon.awscdk.services.ses.actions

Interface AddHeaderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddHeaderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:48.981Z")
@Stability(Stable)
public interface AddHeaderProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a add header action.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.ses.actions.*;
 Bucket bucket = new Bucket(this, "Bucket");
 Topic topic = new Topic(this, "Topic");
 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .rules(List.of(ReceiptRuleOptions.builder()
                 .recipients(List.of("hello@aws.com"))
                 .actions(List.of(
                     AddHeader.Builder.create()
                             .name("X-Special-Header")
                             .value("aws")
                             .build(),
                     S3.Builder.create()
                             .bucket(bucket)
                             .objectKeyPrefix("emails/")
                             .topic(topic)
                             .build()))
                 .build(), ReceiptRuleOptions.builder()
                 .recipients(List.of("aws.com"))
                 .actions(List.of(
                     Sns.Builder.create()
                             .topic(topic)
                             .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AddHeaderProps.Builder	A builder for AddHeaderProps
static final class	AddHeaderProps.Jsii$Proxy	An implementation for AddHeaderProps

Method Summary

Modifier and Type	Method	Description
static AddHeaderProps.Builder	builder()
String	getName()	The name of the header to add.
String	getValue()	The value of the header to add.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the header to add.

Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

getValue

@Stability(Stable)
@NotNull
String getValue()

The value of the header to add.

Must be less than 2048 characters, and must not contain newline characters ("\r" or "\n").

builder

@Stability(Stable)
static AddHeaderProps.Builder builder()

Returns:

a AddHeaderProps.Builder of AddHeaderProps