Package software.amazon.awscdk.services.customerprofiles

Class CfnEventTrigger

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.customerprofiles.CfnEventTrigger
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IEventTriggerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.701Z") @Stability(Stable) public class CfnEventTrigger extends CfnResource implements IInspectable, IEventTriggerRef, ITaggableV2
Specifies the rules to perform an action based on customer ingested data.

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.customerprofiles.*;
 CfnEventTrigger cfnEventTrigger = CfnEventTrigger.Builder.create(this, "MyCfnEventTrigger")
         .domainName("domainName")
         .eventTriggerConditions(List.of(EventTriggerConditionProperty.builder()
                 .eventTriggerDimensions(List.of(EventTriggerDimensionProperty.builder()
                         .objectAttributes(List.of(ObjectAttributeProperty.builder()
                                 .comparisonOperator("comparisonOperator")
                                 .values(List.of("values"))
                                 // the properties below are optional
                                 .fieldName("fieldName")
                                 .source("source")
                                 .build()))
                         .build()))
                 .logicalOperator("logicalOperator")
                 .build()))
         .eventTriggerName("eventTriggerName")
         .objectTypeName("objectTypeName")
         // the properties below are optional
         .description("description")
         .eventTriggerLimits(EventTriggerLimitsProperty.builder()
                 .eventExpiration(123)
                 .periods(List.of(PeriodProperty.builder()
                         .unit("unit")
                         .value(123)
                         // the properties below are optional
                         .maxInvocationsPerProfile(123)
                         .unlimited(false)
                         .build()))
                 .build())
         .segmentFilter("segmentFilter")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnEventTrigger

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

    • CfnEventTrigger

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

    • CfnEventTrigger

      @Stability(Stable) public CfnEventTrigger(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEventTriggerProps props)
      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. 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the event trigger was created.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the event trigger was most recently updated.

    • 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

    • getEventTriggerRef

      @Stability(Stable) @NotNull public EventTriggerReference getEventTriggerRef()
      A reference to a EventTrigger resource.
      Specified by:
      getEventTriggerRef in interface IEventTriggerRef

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The unique name of the domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The unique name of the domain.

    • getEventTriggerConditions

      @Stability(Stable) @NotNull public Object getEventTriggerConditions()
      A list of conditions that determine when an event should trigger the destination.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEventTrigger.EventTriggerConditionProperty>

    • setEventTriggerConditions

      @Stability(Stable) public void setEventTriggerConditions(@NotNull IResolvable value)
      A list of conditions that determine when an event should trigger the destination.

    • setEventTriggerConditions

      @Stability(Stable) public void setEventTriggerConditions(@NotNull List<Object> value)
      A list of conditions that determine when an event should trigger the destination.

    • getEventTriggerName

      @Stability(Stable) @NotNull public String getEventTriggerName()
      The unique name of the event trigger.

    • setEventTriggerName

      @Stability(Stable) public void setEventTriggerName(@NotNull String value)
      The unique name of the event trigger.

    • getObjectTypeName

      @Stability(Stable) @NotNull public String getObjectTypeName()
      The unique name of the object type.

    • setObjectTypeName

      @Stability(Stable) public void setObjectTypeName(@NotNull String value)
      The unique name of the object type.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the event trigger.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the event trigger.

    • getEventTriggerLimits

      @Stability(Stable) @Nullable public Object getEventTriggerLimits()
      Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

      Returns union: either IResolvable or CfnEventTrigger.EventTriggerLimitsProperty

    • setEventTriggerLimits

      @Stability(Stable) public void setEventTriggerLimits(@Nullable IResolvable value)
      Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

    • setEventTriggerLimits

      @Stability(Stable) public void setEventTriggerLimits(@Nullable CfnEventTrigger.EventTriggerLimitsProperty value)
      Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

    • getSegmentFilter

      @Stability(Stable) @Nullable public String getSegmentFilter()
      The destination is triggered only for profiles that meet the criteria of a segment definition.

    • setSegmentFilter

      @Stability(Stable) public void setSegmentFilter(@Nullable String value)
      The destination is triggered only for profiles that meet the criteria of a segment definition.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.