Package software.amazon.awscdk.services.ses

Class CfnConfigurationSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ses.CfnConfigurationSet
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConfigurationSetRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:29.919Z") @Stability(Stable) public class CfnConfigurationSet extends CfnResource implements IInspectable, IConfigurationSetRef, ITaggableV2
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

Required permissions:

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

  • ses:GetConfigurationSet
  • (This permission is replacing the v1 ses:DescribeConfigurationSet permission which will not work with these v2 resource options.)
  • ses:PutConfigurationSetDeliveryOptions
  • ses:PutConfigurationSetReputationOptions
  • ses:PutConfigurationSetSendingOptions
  • ses:PutConfigurationSetSuppressionOptions
  • ses:PutConfigurationSetTrackingOptions

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 CfnConfigurationSet cfnConfigurationSet = CfnConfigurationSet.Builder.create(this, "MyCfnConfigurationSet")
         .deliveryOptions(DeliveryOptionsProperty.builder()
                 .maxDeliverySeconds(123)
                 .sendingPoolName("sendingPoolName")
                 .tlsPolicy("tlsPolicy")
                 .build())
         .name("name")
         .reputationOptions(ReputationOptionsProperty.builder()
                 .reputationMetricsEnabled(false)
                 .build())
         .sendingOptions(SendingOptionsProperty.builder()
                 .sendingEnabled(false)
                 .build())
         .suppressionOptions(SuppressionOptionsProperty.builder()
                 .suppressedReasons(List.of("suppressedReasons"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trackingOptions(TrackingOptionsProperty.builder()
                 .customRedirectDomain("customRedirectDomain")
                 .httpsPolicy("httpsPolicy")
                 .build())
         .vdmOptions(VdmOptionsProperty.builder()
                 .dashboardOptions(DashboardOptionsProperty.builder()
                         .engagementMetrics("engagementMetrics")
                         .build())
                 .guardianOptions(GuardianOptionsProperty.builder()
                         .optimizedSharedDelivery("optimizedSharedDelivery")
                         .build())
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationSet

      protected CfnConfigurationSet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfigurationSet

      protected CfnConfigurationSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfigurationSet

      @Stability(Stable) public CfnConfigurationSet(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnConfigurationSetProps props)
      Create a new AWS::SES::ConfigurationSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnConfigurationSet

      @Stability(Stable) public CfnConfigurationSet(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::SES::ConfigurationSet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForConfigurationSet

      @Stability(Stable) @NotNull public static String arnForConfigurationSet(@NotNull IConfigurationSetRef resource)
      Parameters:
      resource - This parameter is required.

    • fromConfigurationSetName

      @Stability(Stable) @NotNull public static IConfigurationSetRef fromConfigurationSetName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String configurationSetName)
      Creates a new IConfigurationSetRef from a configurationSetName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      configurationSetName - This parameter is required.

    • isCfnConfigurationSet

      @Stability(Stable) @NotNull public static Boolean isCfnConfigurationSet(@NotNull Object x)
      Checks whether the given object is a CfnConfigurationSet.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfigurationSetRef

      @Stability(Stable) @NotNull public ConfigurationSetReference getConfigurationSetRef()
      A reference to a ConfigurationSet resource.
      Specified by:
      getConfigurationSetRef in interface IConfigurationSetRef

    • getDeliveryOptions

      @Stability(Stable) @Nullable public Object getDeliveryOptions()
      Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

      Returns union: either IResolvable or CfnConfigurationSet.DeliveryOptionsProperty

    • setDeliveryOptions

      @Stability(Stable) public void setDeliveryOptions(@Nullable IResolvable value)
      Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

    • setDeliveryOptions

      @Stability(Stable) public void setDeliveryOptions(@Nullable CfnConfigurationSet.DeliveryOptionsProperty value)
      Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the configuration set.

      The name must meet the following requirements:.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the configuration set.

      The name must meet the following requirements:.

    • getReputationOptions

      @Stability(Stable) @Nullable public Object getReputationOptions()
      An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

      Returns union: either IResolvable or CfnConfigurationSet.ReputationOptionsProperty

    • setReputationOptions

      @Stability(Stable) public void setReputationOptions(@Nullable IResolvable value)
      An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

    • setReputationOptions

      @Stability(Stable) public void setReputationOptions(@Nullable CfnConfigurationSet.ReputationOptionsProperty value)
      An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

    • getSendingOptions

      @Stability(Stable) @Nullable public Object getSendingOptions()
      An object that defines whether or not Amazon SES can send email that you send using the configuration set.

      Returns union: either IResolvable or CfnConfigurationSet.SendingOptionsProperty

    • setSendingOptions

      @Stability(Stable) public void setSendingOptions(@Nullable IResolvable value)
      An object that defines whether or not Amazon SES can send email that you send using the configuration set.

    • setSendingOptions

      @Stability(Stable) public void setSendingOptions(@Nullable CfnConfigurationSet.SendingOptionsProperty value)
      An object that defines whether or not Amazon SES can send email that you send using the configuration set.

    • getSuppressionOptions

      @Stability(Stable) @Nullable public Object getSuppressionOptions()
      An object that contains information about the suppression list preferences for your account.

      Returns union: either IResolvable or CfnConfigurationSet.SuppressionOptionsProperty

    • setSuppressionOptions

      @Stability(Stable) public void setSuppressionOptions(@Nullable IResolvable value)
      An object that contains information about the suppression list preferences for your account.

    • setSuppressionOptions

      @Stability(Stable) public void setSuppressionOptions(@Nullable CfnConfigurationSet.SuppressionOptionsProperty value)
      An object that contains information about the suppression list preferences for your account.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of objects that define the tags (keys and values) that are associated with the configuration set.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of objects that define the tags (keys and values) that are associated with the configuration set.

    • getTrackingOptions

      @Stability(Stable) @Nullable public Object getTrackingOptions()
      An object that defines the open and click tracking options for emails that you send using the configuration set.

      Returns union: either IResolvable or CfnConfigurationSet.TrackingOptionsProperty

    • setTrackingOptions

      @Stability(Stable) public void setTrackingOptions(@Nullable IResolvable value)
      An object that defines the open and click tracking options for emails that you send using the configuration set.

    • setTrackingOptions

      @Stability(Stable) public void setTrackingOptions(@Nullable CfnConfigurationSet.TrackingOptionsProperty value)
      An object that defines the open and click tracking options for emails that you send using the configuration set.

    • getVdmOptions

      @Stability(Stable) @Nullable public Object getVdmOptions()
      The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

      Returns union: either IResolvable or CfnConfigurationSet.VdmOptionsProperty

    • setVdmOptions

      @Stability(Stable) public void setVdmOptions(@Nullable IResolvable value)
      The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

    • setVdmOptions

      @Stability(Stable) public void setVdmOptions(@Nullable CfnConfigurationSet.VdmOptionsProperty value)
      The Virtual Deliverability Manager (VDM) options that apply to the configuration set.