Class CfnEventTriggerProps

Properties for defining a CfnEventTrigger.

Inheritance

object

CfnEventTriggerProps

Implements

ICfnEventTriggerProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEventTriggerProps : ICfnEventTriggerProps

Syntax (vb)

Public Class CfnEventTriggerProps Implements ICfnEventTriggerProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnEventTriggerProps = new CfnEventTriggerProps {
                 DomainName = "domainName",
                 EventTriggerConditions = new [] { new EventTriggerConditionProperty {
                     EventTriggerDimensions = new [] { new EventTriggerDimensionProperty {
                         ObjectAttributes = new [] { new ObjectAttributeProperty {
                             ComparisonOperator = "comparisonOperator",
                             Values = new [] { "values" },

                             // the properties below are optional
                             FieldName = "fieldName",
                             Source = "source"
                         } }
                     } },
                     LogicalOperator = "logicalOperator"
                 } },
                 EventTriggerName = "eventTriggerName",
                 ObjectTypeName = "objectTypeName",

                 // the properties below are optional
                 Description = "description",
                 EventTriggerLimits = new EventTriggerLimitsProperty {
                     EventExpiration = 123,
                     Periods = new [] { new PeriodProperty {
                         Unit = "unit",
                         Value = 123,

                         // the properties below are optional
                         MaxInvocationsPerProfile = 123,
                         Unlimited = false
                     } }
                 },
                 SegmentFilter = "segmentFilter",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnEventTriggerProps()

Properties for defining a CfnEventTrigger.

Properties

Description	The description of the event trigger.
DomainName	The unique name of the domain.
EventTriggerConditions	A list of conditions that determine when an event should trigger the destination.
EventTriggerLimits	Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventTriggerName	The unique name of the event trigger.
ObjectTypeName	The unique name of the object type.
SegmentFilter	The destination is triggered only for profiles that meet the criteria of a segment definition.
Tags	An array of key-value pairs to apply to this resource.

Constructors

CfnEventTriggerProps()

Properties for defining a CfnEventTrigger.

public CfnEventTriggerProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnEventTriggerProps = new CfnEventTriggerProps {
                 DomainName = "domainName",
                 EventTriggerConditions = new [] { new EventTriggerConditionProperty {
                     EventTriggerDimensions = new [] { new EventTriggerDimensionProperty {
                         ObjectAttributes = new [] { new ObjectAttributeProperty {
                             ComparisonOperator = "comparisonOperator",
                             Values = new [] { "values" },

                             // the properties below are optional
                             FieldName = "fieldName",
                             Source = "source"
                         } }
                     } },
                     LogicalOperator = "logicalOperator"
                 } },
                 EventTriggerName = "eventTriggerName",
                 ObjectTypeName = "objectTypeName",

                 // the properties below are optional
                 Description = "description",
                 EventTriggerLimits = new EventTriggerLimitsProperty {
                     EventExpiration = 123,
                     Periods = new [] { new PeriodProperty {
                         Unit = "unit",
                         Value = 123,

                         // the properties below are optional
                         MaxInvocationsPerProfile = 123,
                         Unlimited = false
                     } }
                 },
                 SegmentFilter = "segmentFilter",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

The description of the event trigger.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-description

DomainName

The unique name of the domain.

public string DomainName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-domainname

EventTriggerConditions

A list of conditions that determine when an event should trigger the destination.

public object EventTriggerConditions { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerconditions

Type union: either IResolvable or (either IResolvable or CfnEventTrigger.IEventTriggerConditionProperty)[]

EventTriggerLimits

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

public object? EventTriggerLimits { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits

Type union: either IResolvable or CfnEventTrigger.IEventTriggerLimitsProperty

EventTriggerName

The unique name of the event trigger.

public string EventTriggerName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggername

ObjectTypeName

The unique name of the object type.

public string ObjectTypeName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-objecttypename

SegmentFilter

The destination is triggered only for profiles that meet the criteria of a segment definition.

public string? SegmentFilter { get; set; }