Package software.amazon.awscdk.services.pinpointemail

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.pinpointemail.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:00.890Z") @Stability(Stable) public class CfnConfigurationSet extends CfnResource implements IInspectable
A CloudFormation AWS::PinpointEmail::ConfigurationSet.

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

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.pinpointemail.*;
 CfnConfigurationSet cfnConfigurationSet = CfnConfigurationSet.Builder.create(this, "MyCfnConfigurationSet")
         .name("name")
         // the properties below are optional
         .deliveryOptions(DeliveryOptionsProperty.builder()
                 .sendingPoolName("sendingPoolName")
                 .build())
         .reputationOptions(ReputationOptionsProperty.builder()
                 .reputationMetricsEnabled(false)
                 .build())
         .sendingOptions(SendingOptionsProperty.builder()
                 .sendingEnabled(false)
                 .build())
         .tags(List.of(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trackingOptions(TrackingOptionsProperty.builder()
                 .customRedirectDomain("customRedirectDomain")
                 .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, @NotNull CfnConfigurationSetProps props)
      Create a new AWS::PinpointEmail::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.
      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

    • getName

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

    • setName

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

    • getDeliveryOptions

      @Stability(Stable) @Nullable public Object getDeliveryOptions()
      An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

    • setDeliveryOptions

      @Stability(Stable) public void setDeliveryOptions(@Nullable CfnConfigurationSet.DeliveryOptionsProperty value)
      An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

    • setDeliveryOptions

      @Stability(Stable) public void setDeliveryOptions(@Nullable IResolvable value)
      An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

    • getReputationOptions

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

    • setReputationOptions

      @Stability(Stable) public void setReputationOptions(@Nullable IResolvable value)
      An object that defines whether or not Amazon Pinpoint 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 Pinpoint 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 Pinpoint 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 Pinpoint 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 Pinpoint can send email that you send using the configuration set.

    • getTags

      @Stability(Stable) @Nullable public List<CfnConfigurationSet.TagsProperty> getTags()
      An object that defines the tags (keys and values) that you want to associate with the configuration set.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnConfigurationSet.TagsProperty> value)
      An object that defines the tags (keys and values) that you want to associate 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.

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