pulumi-aws-native-kotlin/com.pulumi.awsnative.customerprofiles.kotlin.outputs

Package-level declarations

Types

CalculatedAttributeDefinitionAttributeDetails

data class CalculatedAttributeDefinitionAttributeDetails(val attributes: List<CalculatedAttributeDefinitionAttributeItem>, val expression: String)

Mathematical expression and a list of attribute items specified in that expression.

CalculatedAttributeDefinitionAttributeItem

data class CalculatedAttributeDefinitionAttributeItem(val name: String)

The details of a single attribute item specified in the mathematical expression.

CalculatedAttributeDefinitionConditions

data class CalculatedAttributeDefinitionConditions(val objectCount: Int? = null, val range: CalculatedAttributeDefinitionRange? = null, val threshold: CalculatedAttributeDefinitionThreshold? = null)

The conditions including range, object count, and threshold for the calculated attribute.

CalculatedAttributeDefinitionRange

data class CalculatedAttributeDefinitionRange(val unit: CalculatedAttributeDefinitionRangeUnit, val value: Int)

The relative time period over which data is included in the aggregation.

CalculatedAttributeDefinitionThreshold

data class CalculatedAttributeDefinitionThreshold(val operator: CalculatedAttributeDefinitionThresholdOperator, val value: String)

The threshold for the calculated attribute.

DestinationDetailsProperties

data class DestinationDetailsProperties(val status: EventStreamStatus, val uri: String)

Details regarding the Kinesis stream.

DomainAttributeTypesSelector

data class DomainAttributeTypesSelector(val address: List<String>? = null, val attributeMatchingModel: DomainAttributeTypesSelectorAttributeMatchingModel, val emailAddress: List<String>? = null, val phoneNumber: List<String>? = null)

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

DomainAutoMerging

data class DomainAutoMerging(val conflictResolution: DomainConflictResolution? = null, val consolidation: DomainConsolidation? = null, val enabled: Boolean, val minAllowedConfidenceScoreForMerging: Double? = null)

Configuration information about the auto-merging process.

DomainConflictResolution

data class DomainConflictResolution(val conflictResolvingModel: DomainConflictResolutionConflictResolvingModel, val sourceName: String? = null)

How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

DomainConsolidation

data class DomainConsolidation(val matchingAttributesList: List<List<String>>)

A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

DomainExportingConfig

data class DomainExportingConfig(val s3Exporting: DomainS3ExportingConfig? = null)

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

DomainJobSchedule

data class DomainJobSchedule(val dayOfTheWeek: DomainJobScheduleDayOfTheWeek, val time: String)

The day and time when do you want to start the Identity Resolution Job every week.

DomainMatching

data class DomainMatching(val autoMerging: DomainAutoMerging? = null, val enabled: Boolean, val exportingConfig: DomainExportingConfig? = null, val jobSchedule: DomainJobSchedule? = null)

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

DomainMatchingRule

data class DomainMatchingRule(val rule: List<String>)

Specifies how does the rule-based matching process should match profiles.

DomainRuleBasedMatching

data class DomainRuleBasedMatching(val attributeTypesSelector: DomainAttributeTypesSelector? = null, val conflictResolution: DomainConflictResolution? = null, val enabled: Boolean, val exportingConfig: DomainExportingConfig? = null, val matchingRules: List<DomainMatchingRule>? = null, val maxAllowedRuleLevelForMatching: Int? = null, val maxAllowedRuleLevelForMerging: Int? = null, val status: DomainRuleBasedMatchingStatus? = null)

The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

DomainS3ExportingConfig

data class DomainS3ExportingConfig(val s3BucketName: String, val s3KeyName: String? = null)

The S3 location where Identity Resolution Jobs write result files.

DomainStats

data class DomainStats(val meteringProfileCount: Double? = null, val objectCount: Double? = null, val profileCount: Double? = null, val totalSize: Double? = null)

Usage-specific statistics about the domain.

EventTriggerCondition

data class EventTriggerCondition(val eventTriggerDimensions: List<EventTriggerDimension>, val logicalOperator: EventTriggerLogicalOperator)

Specifies the circumstances under which the event should trigger the destination.

EventTriggerDimension

data class EventTriggerDimension(val objectAttributes: List<EventTriggerObjectAttribute>)

A specific event dimension to be assessed.

EventTriggerLimits

data class EventTriggerLimits(val eventExpiration: Int? = null, val periods: List<EventTriggerPeriod>? = null)

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

EventTriggerObjectAttribute

data class EventTriggerObjectAttribute(val comparisonOperator: EventTriggerObjectAttributeComparisonOperator, val fieldName: String? = null, val source: String? = null, val values: List<String>)

The criteria that a specific object attribute must meet to trigger the destination.

EventTriggerPeriod

data class EventTriggerPeriod(val maxInvocationsPerProfile: Int? = null, val unit: EventTriggerPeriodUnit, val unlimited: Boolean? = null, val value: Int)

Defines a limit and the time period during which it is enforced.

GetCalculatedAttributeDefinitionResult

data class GetCalculatedAttributeDefinitionResult(val attributeDetails: CalculatedAttributeDefinitionAttributeDetails? = null, val conditions: CalculatedAttributeDefinitionConditions? = null, val createdAt: String? = null, val description: String? = null, val displayName: String? = null, val lastUpdatedAt: String? = null, val statistic: CalculatedAttributeDefinitionStatistic? = null, val tags: List<Tag>? = null)

GetDomainResult

data class GetDomainResult(val createdAt: String? = null, val deadLetterQueueUrl: String? = null, val defaultEncryptionKey: String? = null, val defaultExpirationDays: Int? = null, val lastUpdatedAt: String? = null, val matching: DomainMatching? = null, val ruleBasedMatching: DomainRuleBasedMatching? = null, val stats: DomainStats? = null, val tags: List<Tag>? = null)

GetEventStreamResult

data class GetEventStreamResult(val createdAt: String? = null, val destinationDetails: DestinationDetailsProperties? = null, val eventStreamArn: String? = null, val state: EventStreamState? = null, val tags: List<Tag>? = null)

GetEventTriggerResult

data class GetEventTriggerResult(val createdAt: String? = null, val description: String? = null, val eventTriggerConditions: List<EventTriggerCondition>? = null, val eventTriggerLimits: EventTriggerLimits? = null, val lastUpdatedAt: String? = null, val objectTypeName: String? = null, val segmentFilter: String? = null, val tags: List<Tag>? = null)

GetIntegrationResult

data class GetIntegrationResult(val createdAt: String? = null, val eventTriggerNames: List<String>? = null, val lastUpdatedAt: String? = null, val objectTypeName: String? = null, val objectTypeNames: List<IntegrationObjectTypeMapping>? = null, val tags: List<Tag>? = null)

GetObjectTypeResult

data class GetObjectTypeResult(val allowProfileCreation: Boolean? = null, val createdAt: String? = null, val description: String? = null, val encryptionKey: String? = null, val expirationDays: Int? = null, val fields: List<ObjectTypeFieldMap>? = null, val keys: List<ObjectTypeKeyMap>? = null, val lastUpdatedAt: String? = null, val sourceLastUpdatedTimestampFormat: String? = null, val tags: List<Tag>? = null, val templateId: String? = null)

GetSegmentDefinitionResult

data class GetSegmentDefinitionResult(val createdAt: String? = null, val description: String? = null, val segmentDefinitionArn: String? = null, val tags: List<Tag>? = null)

IntegrationConnectorOperator

data class IntegrationConnectorOperator(val marketo: IntegrationMarketoConnectorOperator? = null, val s3: IntegrationS3ConnectorOperator? = null, val salesforce: IntegrationSalesforceConnectorOperator? = null, val serviceNow: IntegrationServiceNowConnectorOperator? = null, val zendesk: IntegrationZendeskConnectorOperator? = null)

IntegrationFlowDefinition

data class IntegrationFlowDefinition(val description: String? = null, val flowName: String, val kmsArn: String, val sourceFlowConfig: IntegrationSourceFlowConfig, val tasks: List<IntegrationTask>, val triggerConfig: IntegrationTriggerConfig)

IntegrationIncrementalPullConfig

data class IntegrationIncrementalPullConfig(val datetimeTypeFieldName: String? = null)

IntegrationMarketoSourceProperties

data class IntegrationMarketoSourceProperties(val object: String)

IntegrationObjectTypeMapping

data class IntegrationObjectTypeMapping(val key: String, val value: String)

IntegrationS3SourceProperties

data class IntegrationS3SourceProperties(val bucketName: String, val bucketPrefix: String? = null)

IntegrationSalesforceSourceProperties

data class IntegrationSalesforceSourceProperties(val enableDynamicFieldUpdate: Boolean? = null, val includeDeletedRecords: Boolean? = null, val object: String)

IntegrationScheduledTriggerProperties

data class IntegrationScheduledTriggerProperties(val dataPullMode: IntegrationScheduledTriggerPropertiesDataPullMode? = null, val firstExecutionFrom: Double? = null, val scheduleEndTime: Double? = null, val scheduleExpression: String, val scheduleOffset: Int? = null, val scheduleStartTime: Double? = null, val timezone: String? = null)

IntegrationServiceNowSourceProperties

data class IntegrationServiceNowSourceProperties(val object: String)

IntegrationSourceConnectorProperties

data class IntegrationSourceConnectorProperties(val marketo: IntegrationMarketoSourceProperties? = null, val s3: IntegrationS3SourceProperties? = null, val salesforce: IntegrationSalesforceSourceProperties? = null, val serviceNow: IntegrationServiceNowSourceProperties? = null, val zendesk: IntegrationZendeskSourceProperties? = null)

IntegrationSourceFlowConfig

data class IntegrationSourceFlowConfig(val connectorProfileName: String? = null, val connectorType: IntegrationConnectorType, val incrementalPullConfig: IntegrationIncrementalPullConfig? = null, val sourceConnectorProperties: IntegrationSourceConnectorProperties)

IntegrationTask

data class IntegrationTask(val connectorOperator: IntegrationConnectorOperator? = null, val destinationField: String? = null, val sourceFields: List<String>, val taskProperties: List<IntegrationTaskPropertiesMap>? = null, val taskType: IntegrationTaskType)

IntegrationTaskPropertiesMap

data class IntegrationTaskPropertiesMap(val operatorPropertyKey: IntegrationOperatorPropertiesKeys, val property: String)

IntegrationTriggerConfig

data class IntegrationTriggerConfig(val triggerProperties: IntegrationTriggerProperties? = null, val triggerType: IntegrationTriggerType)

IntegrationTriggerProperties

data class IntegrationTriggerProperties(val scheduled: IntegrationScheduledTriggerProperties? = null)

IntegrationZendeskSourceProperties

data class IntegrationZendeskSourceProperties(val object: String)

ObjectTypeField

data class ObjectTypeField(val contentType: ObjectTypeFieldContentType? = null, val source: String? = null, val target: String? = null)

Represents a field in a ProfileObjectType.

ObjectTypeFieldMap

data class ObjectTypeFieldMap(val name: String? = null, val objectTypeField: ObjectTypeField? = null)

ObjectTypeKey

data class ObjectTypeKey(val fieldNames: List<String>? = null, val standardIdentifiers: List<ObjectTypeKeyStandardIdentifiersItem>? = null)

An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.

ObjectTypeKeyMap

data class ObjectTypeKeyMap(val name: String? = null, val objectTypeKeyList: List<ObjectTypeKey>? = null)

SegmentDefinitionAddressDimension

data class SegmentDefinitionAddressDimension(val city: SegmentDefinitionProfileDimension? = null, val country: SegmentDefinitionProfileDimension? = null, val county: SegmentDefinitionProfileDimension? = null, val postalCode: SegmentDefinitionProfileDimension? = null, val province: SegmentDefinitionProfileDimension? = null, val state: SegmentDefinitionProfileDimension? = null)

The address based criteria for the segment.

SegmentDefinitionAttributeDimension

data class SegmentDefinitionAttributeDimension(val dimensionType: SegmentDefinitionAttributeDimensionType, val values: List<String>)

Specifies attribute based criteria for a segment.

SegmentDefinitionCalculatedAttributeDimension

data class SegmentDefinitionCalculatedAttributeDimension(val conditionOverrides: SegmentDefinitionConditionOverrides? = null, val dimensionType: SegmentDefinitionAttributeDimensionType, val values: List<String>)

Specifies calculated attribute based criteria for a segment.

SegmentDefinitionConditionOverrides

data class SegmentDefinitionConditionOverrides(val range: SegmentDefinitionRangeOverride? = null)

Overrides the condition block within the original calculated attribute definition.

SegmentDefinitionDateDimension

data class SegmentDefinitionDateDimension(val dimensionType: SegmentDefinitionDateDimensionType, val values: List<String>)

Specifies date based criteria for a segment.

SegmentDefinitionDimension0Properties

data class SegmentDefinitionDimension0Properties(val profileAttributes: SegmentDefinitionProfileAttributes)

The criteria that define the dimensions for the segment.

SegmentDefinitionDimension1Properties

data class SegmentDefinitionDimension1Properties(val calculatedAttributes: Map<String, SegmentDefinitionCalculatedAttributeDimension>? = null)

The criteria that define the dimensions for the segment.

SegmentDefinitionExtraLengthValueProfileDimension

data class SegmentDefinitionExtraLengthValueProfileDimension(val dimensionType: SegmentDefinitionStringDimensionType, val values: List<String>)

Specifies criteria for a segment using extended-length string values.

SegmentDefinitionGroup

data class SegmentDefinitionGroup(val dimensions: List<Either<SegmentDefinitionDimension0Properties, SegmentDefinitionDimension1Properties>>? = null, val sourceSegments: List<SegmentDefinitionSourceSegment>? = null, val sourceType: SegmentDefinitionIncludeOptions? = null, val type: SegmentDefinitionIncludeOptions? = null)

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

SegmentDefinitionProfileAttributes

Specifies the dimension settings within profile attributes for a segment.

SegmentDefinitionProfileDimension

data class SegmentDefinitionProfileDimension(val dimensionType: SegmentDefinitionStringDimensionType, val values: List<String>)

Specifies profile based criteria for a segment.

SegmentDefinitionRangeOverride

data class SegmentDefinitionRangeOverride(val end: Int? = null, val start: Int, val unit: SegmentDefinitionRangeOverrideUnit)

Defines the range to be applied to the calculated attribute definition.

SegmentDefinitionSegmentGroup

data class SegmentDefinitionSegmentGroup(val groups: List<SegmentDefinitionGroup>? = null, val include: SegmentDefinitionIncludeOptions? = null)

SegmentDefinitionSourceSegment

data class SegmentDefinitionSourceSegment(val segmentDefinitionName: String? = null)

The base segment to build the segment on.