Package software.amazon.awscdk.services.ses

Class CfnConfigurationSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ses.CfnConfigurationSet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.331Z") @Stability(Stable) public class CfnConfigurationSet extends CfnResource implements IInspectable
A CloudFormation AWS::SES::ConfigurationSet.

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()
                 .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())
         .trackingOptions(TrackingOptionsProperty.builder()
                 .customRedirectDomain("customRedirectDomain")
                 .build())
         .vdmOptions(VdmOptionsProperty.builder()
                 .dashboardOptions(DashboardOptionsProperty.builder()
                         .engagementMetrics("engagementMetrics")
                         .build())
                 .guardianOptions(GuardianOptionsProperty.builder()
                         .optimizedSharedDelivery("optimizedSharedDelivery")
                         .build())
                 .build())
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnConfigurationSet

      @Stability(Stable) public CfnConfigurationSet(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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.

    • getCfnProperties

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

    • getDeliveryOptions

      @Stability(Stable) @Nullable public Object getDeliveryOptions()
      Specifies 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 whether messages that use the configuration set are required to use Transport Layer Security (TLS).

    • setDeliveryOptions

      @Stability(Stable) public void setDeliveryOptions(@Nullable IResolvable value)
      Specifies 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:.

      • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
      • Contain 64 characters or fewer.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the configuration set. The name must meet the following requirements:.

      • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
      • Contain 64 characters or fewer.

    • getReputationOptions

      @Stability(Stable) @Nullable public Object getReputationOptions()
      An object that represents the reputation settings for the configuration set.

    • setReputationOptions

      @Stability(Stable) public void setReputationOptions(@Nullable IResolvable value)
      An object that represents the reputation settings for the configuration set.

    • setReputationOptions

      @Stability(Stable) public void setReputationOptions(@Nullable CfnConfigurationSet.ReputationOptionsProperty value)
      An object that represents the reputation settings for 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.

    • 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.

    • 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.

    • getTrackingOptions

      @Stability(Stable) @Nullable public Object getTrackingOptions()
      The name of the custom open and click tracking domain associated with the configuration set.

    • setTrackingOptions

      @Stability(Stable) public void setTrackingOptions(@Nullable IResolvable value)
      The name of the custom open and click tracking domain associated with the configuration set.

    • setTrackingOptions

      @Stability(Stable) public void setTrackingOptions(@Nullable CfnConfigurationSet.TrackingOptionsProperty value)
      The name of the custom open and click tracking domain associated with the configuration set.

    • getVdmOptions

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

    • 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.