Files
agent-claw/cdk/node_modules/aws-cdk-lib/aws-customerprofiles/lib/customerprofiles.generated.d.ts
2026-05-06 18:55:16 -05:00

3749 lines
173 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { CalculatedAttributeDefinitionReference, DomainReference, EventStreamReference, EventTriggerReference, ICalculatedAttributeDefinitionRef, IDomainRef, IEventStreamRef, IEventTriggerRef, IIntegrationRef, IntegrationReference, IObjectTypeRef, IRecommenderRef, ISegmentDefinitionRef, ObjectTypeReference, RecommenderReference, SegmentDefinitionReference } from "../../interfaces/generated/aws-customerprofiles-interfaces.generated";
/**
* A calculated attribute definition for Customer Profiles.
*
* @cloudformationResource AWS::CustomerProfiles::CalculatedAttributeDefinition
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html
*/
export declare class CfnCalculatedAttributeDefinition extends cdk.CfnResource implements cdk.IInspectable, ICalculatedAttributeDefinitionRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCalculatedAttributeDefinition from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCalculatedAttributeDefinition;
/**
* Checks whether the given object is a CfnCalculatedAttributeDefinition
*/
static isCfnCalculatedAttributeDefinition(x: any): x is CfnCalculatedAttributeDefinition;
/**
* Mathematical expression and a list of attribute items specified in that expression.
*/
private _attributeDetails;
/**
* The name of an attribute defined in a profile object type.
*/
private _calculatedAttributeName;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The conditions including range, object count, and threshold for the calculated attribute.
*/
private _conditions?;
/**
* The description of the calculated attribute.
*/
private _description?;
/**
* The display name of the calculated attribute.
*/
private _displayName?;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* The aggregation operation to perform for the calculated attribute.
*/
private _statistic;
/**
* An array of key-value pairs to apply to this resource.
*/
private _tags?;
/**
* Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
*/
private _useHistoricalData?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::CalculatedAttributeDefinition`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCalculatedAttributeDefinitionProps);
get calculatedAttributeDefinitionRef(): CalculatedAttributeDefinitionReference;
/**
* Mathematical expression and a list of attribute items specified in that expression.
*/
get attributeDetails(): CfnCalculatedAttributeDefinition.AttributeDetailsProperty | cdk.IResolvable;
/**
* Mathematical expression and a list of attribute items specified in that expression.
*/
set attributeDetails(value: CfnCalculatedAttributeDefinition.AttributeDetailsProperty | cdk.IResolvable);
/**
* The name of an attribute defined in a profile object type.
*/
get calculatedAttributeName(): string;
/**
* The name of an attribute defined in a profile object type.
*/
set calculatedAttributeName(value: string);
/**
* The conditions including range, object count, and threshold for the calculated attribute.
*/
get conditions(): CfnCalculatedAttributeDefinition.ConditionsProperty | cdk.IResolvable | undefined;
/**
* The conditions including range, object count, and threshold for the calculated attribute.
*/
set conditions(value: CfnCalculatedAttributeDefinition.ConditionsProperty | cdk.IResolvable | undefined);
/**
* The description of the calculated attribute.
*/
get description(): string | undefined;
/**
* The description of the calculated attribute.
*/
set description(value: string | undefined);
/**
* The display name of the calculated attribute.
*/
get displayName(): string | undefined;
/**
* The display name of the calculated attribute.
*/
set displayName(value: string | undefined);
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* The aggregation operation to perform for the calculated attribute.
*/
get statistic(): string;
/**
* The aggregation operation to perform for the calculated attribute.
*/
set statistic(value: string);
/**
* An array of key-value pairs to apply to this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An array of key-value pairs to apply to this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
*/
get useHistoricalData(): boolean | cdk.IResolvable | undefined;
/**
* Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
*/
set useHistoricalData(value: boolean | cdk.IResolvable | undefined);
/**
* The timestamp of when the calculated attribute definition was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The timestamp of when the calculated attribute definition was most recently edited.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The readiness status of the calculated attribute.
*
* @cloudformationAttribute Readiness
*/
get attrReadiness(): cdk.IResolvable;
/**
* Status of the Calculated Attribute creation (whether all historical data has been indexed.)
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCalculatedAttributeDefinition {
/**
* Mathematical expression and a list of attribute items specified in that expression.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html
*/
interface AttributeDetailsProperty {
/**
* Mathematical expression and a list of attribute items specified in that expression.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-attributes
*/
readonly attributes: Array<CfnCalculatedAttributeDefinition.AttributeItemProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Mathematical expression that is performed on attribute items provided in the attribute list.
*
* Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-expression
*/
readonly expression: string;
}
/**
* The details of a single attribute item specified in the mathematical expression.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.html
*/
interface AttributeItemProperty {
/**
* The unique name of the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.html#cfn-customerprofiles-calculatedattributedefinition-attributeitem-name
*/
readonly name: string;
}
/**
* The conditions including range, object count, and threshold for the calculated attribute.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html
*/
interface ConditionsProperty {
/**
* The number of profile objects used for the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-objectcount
*/
readonly objectCount?: number;
/**
* The relative time period over which data is included in the aggregation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-range
*/
readonly range?: cdk.IResolvable | CfnCalculatedAttributeDefinition.RangeProperty;
/**
* The threshold for the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-threshold
*/
readonly threshold?: cdk.IResolvable | CfnCalculatedAttributeDefinition.ThresholdProperty;
}
/**
* The relative time period over which data is included in the aggregation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html
*/
interface RangeProperty {
/**
* The format the timestamp field in your JSON object is specified.
*
* This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601"
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat
*/
readonly timestampFormat?: string;
/**
* An expression specifying the field in your JSON object from which the date should be parsed.
*
* The expression should follow the structure of \"{ObjectTypeName.<Location of timestamp field in JSON pointer format>}\". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}"
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampsource
*/
readonly timestampSource?: string;
/**
* The unit of time.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-unit
*/
readonly unit: string;
/**
* The amount of time of the specified unit.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-value
*/
readonly value?: number;
/**
* A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.
*
* Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-valuerange
*/
readonly valueRange?: cdk.IResolvable | CfnCalculatedAttributeDefinition.ValueRangeProperty;
}
/**
* A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.
*
* Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html
*/
interface ValueRangeProperty {
/**
* The ending point for this overridden range.
*
* Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-end
*/
readonly end: number;
/**
* The starting point for this overridden range.
*
* Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-start
*/
readonly start: number;
}
/**
* The threshold for the calculated attribute.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html
*/
interface ThresholdProperty {
/**
* The operator of the threshold.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-operator
*/
readonly operator: string;
/**
* The value of the threshold.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-value
*/
readonly value: string;
}
/**
* Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html
*/
interface ReadinessProperty {
/**
* Any customer messaging.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-message
*/
readonly message?: string;
/**
* Approximately how far the Calculated Attribute creation is from completion.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-progresspercentage
*/
readonly progressPercentage?: number;
}
}
/**
* Properties for defining a `CfnCalculatedAttributeDefinition`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html
*/
export interface CfnCalculatedAttributeDefinitionProps {
/**
* Mathematical expression and a list of attribute items specified in that expression.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails
*/
readonly attributeDetails: CfnCalculatedAttributeDefinition.AttributeDetailsProperty | cdk.IResolvable;
/**
* The name of an attribute defined in a profile object type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-calculatedattributename
*/
readonly calculatedAttributeName: string;
/**
* The conditions including range, object count, and threshold for the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-conditions
*/
readonly conditions?: CfnCalculatedAttributeDefinition.ConditionsProperty | cdk.IResolvable;
/**
* The description of the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-description
*/
readonly description?: string;
/**
* The display name of the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-displayname
*/
readonly displayName?: string;
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-domainname
*/
readonly domainName: string;
/**
* The aggregation operation to perform for the calculated attribute.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-statistic
*/
readonly statistic: string;
/**
* An array of key-value pairs to apply to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-usehistoricaldata
*/
readonly useHistoricalData?: boolean | cdk.IResolvable;
}
/**
* Specifies an Amazon Connect Customer Profiles Domain.
*
* @cloudformationResource AWS::CustomerProfiles::Domain
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html
*/
export declare class CfnDomain extends cdk.CfnResource implements cdk.IInspectable, IDomainRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDomain from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDomain;
/**
* Checks whether the given object is a CfnDomain
*/
static isCfnDomain(x: any): x is CfnDomain;
/**
* Creates a new IDomainRef from a domainName
*/
static fromDomainName(scope: constructs.Construct, id: string, domainName: string): IDomainRef;
static arnForDomain(resource: IDomainRef): string;
/**
* Configuration and status of the data store for the domain.
*/
private _dataStore?;
/**
* The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
*/
private _deadLetterQueueUrl?;
/**
* The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
*/
private _defaultEncryptionKey?;
/**
* The default number of days until the data within the domain expires.
*/
private _defaultExpirationDays;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* The process of matching duplicate profiles.
*/
private _matching?;
/**
* The process of matching duplicate profiles using Rule-Based matching.
*/
private _ruleBasedMatching?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags used to organize, track, or control access for this resource.
*/
private _tagsRaw?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::Domain`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnDomainProps);
get domainRef(): DomainReference;
/**
* Configuration and status of the data store for the domain.
*/
get dataStore(): CfnDomain.DataStoreProperty | cdk.IResolvable | undefined;
/**
* Configuration and status of the data store for the domain.
*/
set dataStore(value: CfnDomain.DataStoreProperty | cdk.IResolvable | undefined);
/**
* The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
*/
get deadLetterQueueUrl(): string | undefined;
/**
* The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
*/
set deadLetterQueueUrl(value: string | undefined);
/**
* The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
*/
get defaultEncryptionKey(): string | undefined;
/**
* The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
*/
set defaultEncryptionKey(value: string | undefined);
/**
* The default number of days until the data within the domain expires.
*/
get defaultExpirationDays(): number;
/**
* The default number of days until the data within the domain expires.
*/
set defaultExpirationDays(value: number);
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* The process of matching duplicate profiles.
*/
get matching(): cdk.IResolvable | CfnDomain.MatchingProperty | undefined;
/**
* The process of matching duplicate profiles.
*/
set matching(value: cdk.IResolvable | CfnDomain.MatchingProperty | undefined);
/**
* The process of matching duplicate profiles using Rule-Based matching.
*/
get ruleBasedMatching(): cdk.IResolvable | CfnDomain.RuleBasedMatchingProperty | undefined;
/**
* The process of matching duplicate profiles using Rule-Based matching.
*/
set ruleBasedMatching(value: cdk.IResolvable | CfnDomain.RuleBasedMatchingProperty | undefined);
/**
* The tags used to organize, track, or control access for this resource.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* The tags used to organize, track, or control access for this resource.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp of when the domain was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* Progress information for data store setup.
*
* @cloudformationAttribute DataStore.Readiness
*/
get attrDataStoreReadiness(): cdk.IResolvable;
/**
* The timestamp of when the domain was most recently edited.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The status of rule-based matching rule.
*
* @cloudformationAttribute RuleBasedMatching.Status
*/
get attrRuleBasedMatchingStatus(): string;
/**
* Usage-specific statistics about the domain.
*
* @cloudformationAttribute Stats
*/
get attrStats(): cdk.IResolvable;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnDomain {
/**
* 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 the *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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html
*/
interface MatchingProperty {
/**
* Configuration information about the auto-merging process.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-automerging
*/
readonly autoMerging?: CfnDomain.AutoMergingProperty | cdk.IResolvable;
/**
* The flag that enables the matching process of duplicate profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-enabled
*/
readonly enabled: boolean | cdk.IResolvable;
/**
* The S3 location where Identity Resolution Jobs write result files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-exportingconfig
*/
readonly exportingConfig?: CfnDomain.ExportingConfigProperty | cdk.IResolvable;
/**
* The day and time when do you want to start the Identity Resolution Job every week.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-jobschedule
*/
readonly jobSchedule?: cdk.IResolvable | CfnDomain.JobScheduleProperty;
}
/**
* Configuration information about the auto-merging process.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html
*/
interface AutoMergingProperty {
/**
* Determines 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` , `ConflictResolution` specifies which `EmailAddress` should be used.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-conflictresolution
*/
readonly conflictResolution?: CfnDomain.ConflictResolutionProperty | cdk.IResolvable;
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-consolidation
*/
readonly consolidation?: CfnDomain.ConsolidationProperty | cdk.IResolvable;
/**
* The flag that enables the auto-merging of duplicate profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-enabled
*/
readonly enabled: boolean | cdk.IResolvable;
/**
* A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
*
* A higher score means that a higher similarity is required to merge profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-minallowedconfidencescoreformerging
*/
readonly minAllowedConfidenceScoreForMerging?: number;
}
/**
* Determines 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` , `ConflictResolution` specifies which `EmailAddress` should be used.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html
*/
interface ConflictResolutionProperty {
/**
* How the auto-merging process should resolve conflicts between different profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-conflictresolvingmodel
*/
readonly conflictResolvingModel: string;
/**
* The `ObjectType` name that is used to resolve profile merging conflicts when choosing `SOURCE` as the `ConflictResolvingModel` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-sourcename
*/
readonly sourceName?: 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-consolidation.html
*/
interface ConsolidationProperty {
/**
* A list of matching criteria.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-consolidation.html#cfn-customerprofiles-domain-consolidation-matchingattributeslist
*/
readonly matchingAttributesList: Array<Array<string>> | cdk.IResolvable;
}
/**
* Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-exportingconfig.html
*/
interface ExportingConfigProperty {
/**
* The S3 location where Identity Resolution Jobs write result files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-exportingconfig.html#cfn-customerprofiles-domain-exportingconfig-s3exporting
*/
readonly s3Exporting?: cdk.IResolvable | CfnDomain.S3ExportingConfigProperty;
}
/**
* The S3 location where Identity Resolution Jobs write result files.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html
*/
interface S3ExportingConfigProperty {
/**
* The name of the S3 bucket where Identity Resolution Jobs write result files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3bucketname
*/
readonly s3BucketName: string;
/**
* The S3 key name of the location where Identity Resolution Jobs write result files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3keyname
*/
readonly s3KeyName?: string;
}
/**
* The day and time when do you want to start the Identity Resolution Job every week.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html
*/
interface JobScheduleProperty {
/**
* The day when the Identity Resolution Job should run every week.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-dayoftheweek
*/
readonly dayOfTheWeek: string;
/**
* The time when the Identity Resolution Job should run every week.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-time
*/
readonly time: string;
}
/**
* The process of matching duplicate profiles using 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html
*/
interface RuleBasedMatchingProperty {
/**
* Configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector
*/
readonly attributeTypesSelector?: CfnDomain.AttributeTypesSelectorProperty | cdk.IResolvable;
/**
* Determines 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` , `ConflictResolution` specifies which `EmailAddress` should be used.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution
*/
readonly conflictResolution?: CfnDomain.ConflictResolutionProperty | cdk.IResolvable;
/**
* The flag that enables the matching process of duplicate profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-enabled
*/
readonly enabled: boolean | cdk.IResolvable;
/**
* The S3 location where Identity Resolution Jobs write result files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig
*/
readonly exportingConfig?: CfnDomain.ExportingConfigProperty | cdk.IResolvable;
/**
* Configures how the rule-based matching process should match profiles.
*
* You can have up to 15 `MatchingRule` in the `MatchingRules` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-matchingrules
*/
readonly matchingRules?: Array<cdk.IResolvable | CfnDomain.MatchingRuleProperty> | cdk.IResolvable;
/**
* Indicates the maximum allowed rule level for matching.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching
*/
readonly maxAllowedRuleLevelForMatching?: number;
/**
* Indicates the maximum allowed rule level for merging.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging
*/
readonly maxAllowedRuleLevelForMerging?: number;
/**
* The status of rule-based matching rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-status
*/
readonly status?: string;
}
/**
* Configures information about the `AttributeTypesSelector` which rule-based identity resolution uses to match profiles.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html
*/
interface AttributeTypesSelectorProperty {
/**
* The `Address` type.
*
* You can choose from `Address` , `BusinessAddress` , `MaillingAddress` , and `ShippingAddress` . You only can use the `Address` type in the `MatchingRule` . For example, if you want to match a profile based on `BusinessAddress.City` or `MaillingAddress.City` , you can choose the `BusinessAddress` and the `MaillingAddress` to represent the `Address` type and specify the `Address.City` on the matching rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-address
*/
readonly address?: Array<string>;
/**
* Configures the `AttributeMatchingModel` , you can either choose `ONE_TO_ONE` or `MANY_TO_MANY` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-attributematchingmodel
*/
readonly attributeMatchingModel: string;
/**
* The Email type.
*
* You can choose from `EmailAddress` , `BusinessEmailAddress` and `PersonalEmailAddress` . You only can use the `EmailAddress` type in the `MatchingRule` . For example, if you want to match profile based on `PersonalEmailAddress` or `BusinessEmailAddress` , you can choose the `PersonalEmailAddress` and the `BusinessEmailAddress` to represent the `EmailAddress` type and only specify the `EmailAddress` on the matching rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-emailaddress
*/
readonly emailAddress?: Array<string>;
/**
* The `PhoneNumber` type.
*
* You can choose from `PhoneNumber` , `HomePhoneNumber` , and `MobilePhoneNumber` . You only can use the `PhoneNumber` type in the `MatchingRule` . For example, if you want to match a profile based on `Phone` or `HomePhone` , you can choose the `Phone` and the `HomePhone` to represent the `PhoneNumber` type and only specify the `PhoneNumber` on the matching rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-phonenumber
*/
readonly phoneNumber?: Array<string>;
}
/**
* Specifies how the rule-based matching process should match profiles.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matchingrule.html
*/
interface MatchingRuleProperty {
/**
* A single rule level of the `MatchRules` .
*
* Configures how the rule-based matching process should match profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matchingrule.html#cfn-customerprofiles-domain-matchingrule-rule
*/
readonly rule: Array<string>;
}
/**
* Configuration and status of the data store for the domain.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html
*/
interface DataStoreProperty {
/**
* Whether the data store is enabled.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-enabled
*/
readonly enabled?: boolean | cdk.IResolvable;
/**
* Progress information for data store setup.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-readiness
*/
readonly readiness?: cdk.IResolvable | CfnDomain.ReadinessProperty;
}
/**
* Progress information for data store setup.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html
*/
interface ReadinessProperty {
/**
* A message describing the current progress.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-message
*/
readonly message?: string;
/**
* The percentage of progress completed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-progresspercentage
*/
readonly progressPercentage?: number;
}
/**
* Usage-specific statistics about the domain.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html
*/
interface DomainStatsProperty {
/**
* The number of profiles that you are currently paying for in the domain.
*
* If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-meteringprofilecount
*/
readonly meteringProfileCount?: number;
/**
* The total number of objects in domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-objectcount
*/
readonly objectCount?: number;
/**
* The total number of profiles currently in the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-profilecount
*/
readonly profileCount?: number;
/**
* The total size, in bytes, of all objects in the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-totalsize
*/
readonly totalSize?: number;
}
}
/**
* Properties for defining a `CfnDomain`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html
*/
export interface CfnDomainProps {
/**
* Configuration and status of the data store for the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-datastore
*/
readonly dataStore?: CfnDomain.DataStoreProperty | cdk.IResolvable;
/**
* The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
*
* You must set up a policy on the `DeadLetterQueue` for the `SendMessage` operation to enable Amazon Connect Customer Profiles to send messages to the `DeadLetterQueue` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-deadletterqueueurl
*/
readonly deadLetterQueueUrl?: string;
/**
* The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
*
* It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultencryptionkey
*/
readonly defaultEncryptionKey?: string;
/**
* The default number of days until the data within the domain expires.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultexpirationdays
*/
readonly defaultExpirationDays: number;
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-domainname
*/
readonly domainName: string;
/**
* The process of matching duplicate profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-matching
*/
readonly matching?: cdk.IResolvable | CfnDomain.MatchingProperty;
/**
* The process of matching duplicate profiles using Rule-Based matching.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-rulebasedmatching
*/
readonly ruleBasedMatching?: cdk.IResolvable | CfnDomain.RuleBasedMatchingProperty;
/**
* The tags used to organize, track, or control access for this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* An Event Stream resource of Amazon Connect Customer Profiles.
*
* @cloudformationResource AWS::CustomerProfiles::EventStream
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html
*/
export declare class CfnEventStream extends cdk.CfnResource implements cdk.IInspectable, IEventStreamRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnEventStream from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEventStream;
/**
* Checks whether the given object is a CfnEventStream
*/
static isCfnEventStream(x: any): x is CfnEventStream;
static arnForEventStream(resource: IEventStreamRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* The name of the event stream.
*/
private _eventStreamName;
/**
* The tags used to organize, track, or control access for this resource.
*/
private _tags?;
/**
* The StreamARN of the destination to deliver profile events to.
*/
private _uri;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::EventStream`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnEventStreamProps);
get eventStreamRef(): EventStreamReference;
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* The name of the event stream.
*/
get eventStreamName(): string;
/**
* The name of the event stream.
*/
set eventStreamName(value: string);
/**
* The tags used to organize, track, or control access for this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* The tags used to organize, track, or control access for this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The StreamARN of the destination to deliver profile events to.
*/
get uri(): string;
/**
* The StreamARN of the destination to deliver profile events to.
*/
set uri(value: string);
/**
* The timestamp of when the export was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* Details regarding the Kinesis stream.
*
* @cloudformationAttribute DestinationDetails
*/
get attrDestinationDetails(): cdk.IResolvable;
/**
* @cloudformationAttribute DestinationDetails.Status
*/
get attrDestinationDetailsStatus(): string;
/**
* @cloudformationAttribute DestinationDetails.Uri
*/
get attrDestinationDetailsUri(): string;
/**
* A unique identifier for the event stream.
*
* @cloudformationAttribute EventStreamArn
*/
get attrEventStreamArn(): string;
/**
* The operational state of destination stream for export.
*
* @cloudformationAttribute State
*/
get attrState(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnEventStream {
/**
* Details regarding the Kinesis stream.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventstream-destinationdetails.html
*/
interface DestinationDetailsProperty {
/**
* The status of enabling the Kinesis stream as a destination for export.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventstream-destinationdetails.html#cfn-customerprofiles-eventstream-destinationdetails-status
*/
readonly status: string;
/**
* The StreamARN of the destination to deliver profile events to.
*
* For example, arn:aws:kinesis:region:account-id:stream/stream-name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventstream-destinationdetails.html#cfn-customerprofiles-eventstream-destinationdetails-uri
*/
readonly uri: string;
}
}
/**
* Properties for defining a `CfnEventStream`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html
*/
export interface CfnEventStreamProps {
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-domainname
*/
readonly domainName: string;
/**
* The name of the event stream.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-eventstreamname
*/
readonly eventStreamName: string;
/**
* The tags used to organize, track, or control access for this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The StreamARN of the destination to deliver profile events to.
*
* For example, arn:aws:kinesis:region:account-id:stream/stream-name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-uri
*/
readonly uri: string;
}
/**
* Specifies an Amazon Connect Customer Profiles Integration.
*
* @cloudformationResource AWS::CustomerProfiles::Integration
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html
*/
export declare class CfnIntegration extends cdk.CfnResource implements cdk.IInspectable, IIntegrationRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnIntegration from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnIntegration;
/**
* Checks whether the given object is a CfnIntegration
*/
static isCfnIntegration(x: any): x is CfnIntegration;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* A list of unique names for active event triggers associated with the integration.
*/
private _eventTriggerNames?;
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*/
private _flowDefinition?;
/**
* The name of the profile object type mapping to use.
*/
private _objectTypeName?;
/**
* The object type mapping.
*/
private _objectTypeNames?;
/**
* Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
*/
private _scope?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags used to organize, track, or control access for this resource.
*/
private _tagsRaw?;
/**
* The URI of the S3 bucket or any other type of data source.
*/
private _uri?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::Integration`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnIntegrationProps);
get integrationRef(): IntegrationReference;
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* A list of unique names for active event triggers associated with the integration.
*/
get eventTriggerNames(): Array<string> | undefined;
/**
* A list of unique names for active event triggers associated with the integration.
*/
set eventTriggerNames(value: Array<string> | undefined);
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*/
get flowDefinition(): CfnIntegration.FlowDefinitionProperty | cdk.IResolvable | undefined;
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*/
set flowDefinition(value: CfnIntegration.FlowDefinitionProperty | cdk.IResolvable | undefined);
/**
* The name of the profile object type mapping to use.
*/
get objectTypeName(): string | undefined;
/**
* The name of the profile object type mapping to use.
*/
set objectTypeName(value: string | undefined);
/**
* The object type mapping.
*/
get objectTypeNames(): Array<cdk.IResolvable | CfnIntegration.ObjectTypeMappingProperty> | cdk.IResolvable | undefined;
/**
* The object type mapping.
*/
set objectTypeNames(value: Array<cdk.IResolvable | CfnIntegration.ObjectTypeMappingProperty> | cdk.IResolvable | undefined);
/**
* Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
*/
get scope(): string | undefined;
/**
* Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
*/
set scope(value: string | undefined);
/**
* The tags used to organize, track, or control access for this resource.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* The tags used to organize, track, or control access for this resource.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* The URI of the S3 bucket or any other type of data source.
*/
get uri(): string | undefined;
/**
* The URI of the S3 bucket or any other type of data source.
*/
set uri(value: string | undefined);
/**
* The timestamp of when the integration was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The timestamp of when the integration was most recently edited.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnIntegration {
/**
* A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html
*/
interface ObjectTypeMappingProperty {
/**
* The key.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-key
*/
readonly key: string;
/**
* The value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-value
*/
readonly value: string;
}
/**
* The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.
*
* Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html
*/
interface FlowDefinitionProperty {
/**
* A description of the flow you want to create.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-description
*/
readonly description?: string;
/**
* The specified name of the flow.
*
* Use underscores (_) or hyphens (-) only. Spaces are not allowed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-flowname
*/
readonly flowName: string;
/**
* The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-kmsarn
*/
readonly kmsArn: string;
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig
*/
readonly sourceFlowConfig: cdk.IResolvable | CfnIntegration.SourceFlowConfigProperty;
/**
* A list of tasks that Customer Profiles performs while transferring the data in the flow run.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-tasks
*/
readonly tasks: Array<cdk.IResolvable | CfnIntegration.TaskProperty> | cdk.IResolvable;
/**
* The trigger settings that determine how and when the flow runs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-triggerconfig
*/
readonly triggerConfig: cdk.IResolvable | CfnIntegration.TriggerConfigProperty;
}
/**
* The `Task` property type specifies the class for modeling different type of tasks.
*
* Task implementation varies based on the TaskType.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html
*/
interface TaskProperty {
/**
* The operation to be performed on the provided source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-connectoroperator
*/
readonly connectorOperator?: CfnIntegration.ConnectorOperatorProperty | cdk.IResolvable;
/**
* A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-destinationfield
*/
readonly destinationField?: string;
/**
* The source fields to which a particular task is applied.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-sourcefields
*/
readonly sourceFields: Array<string>;
/**
* A map used to store task-related information.
*
* The service looks for particular information based on the TaskType.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-taskproperties
*/
readonly taskProperties?: Array<cdk.IResolvable | CfnIntegration.TaskPropertiesMapProperty> | cdk.IResolvable;
/**
* Specifies the particular task implementation that Amazon AppFlow performs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-tasktype
*/
readonly taskType: string;
}
/**
* The operation to be performed on the provided source fields.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html
*/
interface ConnectorOperatorProperty {
/**
* The operation to be performed on the provided Marketo source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-marketo
*/
readonly marketo?: string;
/**
* The operation to be performed on the provided Amazon S3 source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-s3
*/
readonly s3?: string;
/**
* The operation to be performed on the provided Salesforce source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-salesforce
*/
readonly salesforce?: string;
/**
* The operation to be performed on the provided ServiceNow source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-servicenow
*/
readonly serviceNow?: string;
/**
* The operation to be performed on the provided Zendesk source fields.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-zendesk
*/
readonly zendesk?: string;
}
/**
* A map used to store task-related information.
*
* The execution service looks for particular information based on the `TaskType` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html
*/
interface TaskPropertiesMapProperty {
/**
* The task property key.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-operatorpropertykey
*/
readonly operatorPropertyKey: string;
/**
* The task property value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-property
*/
readonly property: string;
}
/**
* The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html
*/
interface TriggerConfigProperty {
/**
* Specifies the configuration details of a schedule-triggered flow that you define.
*
* Currently, these settings only apply to the Scheduled trigger type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggerproperties
*/
readonly triggerProperties?: cdk.IResolvable | CfnIntegration.TriggerPropertiesProperty;
/**
* Specifies the type of flow trigger.
*
* It can be OnDemand, Scheduled, or Event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggertype
*/
readonly triggerType: string;
}
/**
* Specifies the configuration details that control the trigger for a flow.
*
* Currently, these settings only apply to the Scheduled trigger type.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html
*/
interface TriggerPropertiesProperty {
/**
* Specifies the configuration details of a schedule-triggered flow that you define.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html#cfn-customerprofiles-integration-triggerproperties-scheduled
*/
readonly scheduled?: cdk.IResolvable | CfnIntegration.ScheduledTriggerPropertiesProperty;
}
/**
* Specifies the configuration details of a scheduled-trigger flow that you define.
*
* Currently, these settings only apply to the scheduled-trigger type.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html
*/
interface ScheduledTriggerPropertiesProperty {
/**
* Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-datapullmode
*/
readonly dataPullMode?: string;
/**
* Specifies the date range for the records to import from the connector in the first flow run.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-firstexecutionfrom
*/
readonly firstExecutionFrom?: number;
/**
* Specifies the scheduled end time for a scheduled-trigger flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleendtime
*/
readonly scheduleEndTime?: number;
/**
* The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleexpression
*/
readonly scheduleExpression: string;
/**
* Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleoffset
*/
readonly scheduleOffset?: number;
/**
* Specifies the scheduled start time for a scheduled-trigger flow.
*
* The value must be a date/time value in EPOCH format.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-schedulestarttime
*/
readonly scheduleStartTime?: number;
/**
* Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-timezone
*/
readonly timezone?: string;
}
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html
*/
interface SourceFlowConfigProperty {
/**
* The name of the Amazon AppFlow connector profile.
*
* This name must be unique for each connector profile in the AWS account .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectorprofilename
*/
readonly connectorProfileName?: string;
/**
* The type of connector, such as Salesforce, Marketo, and so on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectortype
*/
readonly connectorType: string;
/**
* Defines the configuration for a scheduled incremental data pull.
*
* If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-incrementalpullconfig
*/
readonly incrementalPullConfig?: CfnIntegration.IncrementalPullConfigProperty | cdk.IResolvable;
/**
* Specifies the information that is required to query a particular source connector.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-sourceconnectorproperties
*/
readonly sourceConnectorProperties: cdk.IResolvable | CfnIntegration.SourceConnectorPropertiesProperty;
}
/**
* Specifies the information that is required to query a particular Amazon AppFlow connector.
*
* Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html
*/
interface SourceConnectorPropertiesProperty {
/**
* The properties that are applied when Marketo is being used as a source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-marketo
*/
readonly marketo?: cdk.IResolvable | CfnIntegration.MarketoSourcePropertiesProperty;
/**
* The properties that are applied when Amazon S3 is being used as the flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-s3
*/
readonly s3?: cdk.IResolvable | CfnIntegration.S3SourcePropertiesProperty;
/**
* The properties that are applied when Salesforce is being used as a source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-salesforce
*/
readonly salesforce?: cdk.IResolvable | CfnIntegration.SalesforceSourcePropertiesProperty;
/**
* The properties that are applied when ServiceNow is being used as a source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-servicenow
*/
readonly serviceNow?: cdk.IResolvable | CfnIntegration.ServiceNowSourcePropertiesProperty;
/**
* The properties that are applied when using Zendesk as a flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-zendesk
*/
readonly zendesk?: cdk.IResolvable | CfnIntegration.ZendeskSourcePropertiesProperty;
}
/**
* The properties that are applied when Amazon S3 is being used as the flow source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html
*/
interface S3SourcePropertiesProperty {
/**
* The Amazon S3 bucket name where the source files are stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketname
*/
readonly bucketName: string;
/**
* The object key for the Amazon S3 bucket in which the source files are stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketprefix
*/
readonly bucketPrefix?: string;
}
/**
* The properties that are applied when ServiceNow is being used as a source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html
*/
interface ServiceNowSourcePropertiesProperty {
/**
* The object specified in the ServiceNow flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html#cfn-customerprofiles-integration-servicenowsourceproperties-object
*/
readonly object: string;
}
/**
* The properties that are applied when using Zendesk as a flow source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html
*/
interface ZendeskSourcePropertiesProperty {
/**
* The object specified in the Zendesk flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html#cfn-customerprofiles-integration-zendesksourceproperties-object
*/
readonly object: string;
}
/**
* The properties that are applied when Marketo is being used as a source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html
*/
interface MarketoSourcePropertiesProperty {
/**
* The object specified in the Marketo flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html#cfn-customerprofiles-integration-marketosourceproperties-object
*/
readonly object: string;
}
/**
* The properties that are applied when Salesforce is being used as a source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html
*/
interface SalesforceSourcePropertiesProperty {
/**
* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-enabledynamicfieldupdate
*/
readonly enableDynamicFieldUpdate?: boolean | cdk.IResolvable;
/**
* Indicates whether Amazon AppFlow includes deleted files in the flow run.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-includedeletedrecords
*/
readonly includeDeletedRecords?: boolean | cdk.IResolvable;
/**
* The object specified in the Salesforce flow source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-object
*/
readonly object: string;
}
/**
* Specifies the configuration used when importing incremental records from the source.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html
*/
interface IncrementalPullConfigProperty {
/**
* A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html#cfn-customerprofiles-integration-incrementalpullconfig-datetimetypefieldname
*/
readonly datetimeTypeFieldName?: string;
}
}
/**
* Properties for defining a `CfnIntegration`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html
*/
export interface CfnIntegrationProps {
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-domainname
*/
readonly domainName: string;
/**
* A list of unique names for active event triggers associated with the integration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-eventtriggernames
*/
readonly eventTriggerNames?: Array<string>;
/**
* The configuration that controls how Customer Profiles retrieves data from the source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-flowdefinition
*/
readonly flowDefinition?: CfnIntegration.FlowDefinitionProperty | cdk.IResolvable;
/**
* The name of the profile object type mapping to use.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypename
*/
readonly objectTypeName?: string;
/**
* The object type mapping.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypenames
*/
readonly objectTypeNames?: Array<cdk.IResolvable | CfnIntegration.ObjectTypeMappingProperty> | cdk.IResolvable;
/**
* Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-scope
*/
readonly scope?: string;
/**
* The tags used to organize, track, or control access for this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The URI of the S3 bucket or any other type of data source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-uri
*/
readonly uri?: string;
}
/**
* Specifies an Amazon Connect Customer Profiles Object Type Mapping.
*
* @cloudformationResource AWS::CustomerProfiles::ObjectType
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html
*/
export declare class CfnObjectType extends cdk.CfnResource implements cdk.IInspectable, IObjectTypeRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnObjectType from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnObjectType;
/**
* Checks whether the given object is a CfnObjectType
*/
static isCfnObjectType(x: any): x is CfnObjectType;
/**
* Indicates whether a profile should be created when data is received if one doesnt exist for an object of this type.
*/
private _allowProfileCreation?;
/**
* The description of the profile object type mapping.
*/
private _description;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
*/
private _encryptionKey?;
/**
* The number of days until the data of this type expires.
*/
private _expirationDays?;
/**
* A list of field definitions for the object type mapping.
*/
private _fields?;
/**
* A list of keys that can be used to map data to the profile or search for the profile.
*/
private _keys?;
/**
* The amount of profile object max count assigned to the object type.
*/
private _maxProfileObjectCount?;
/**
* The name of the profile object type.
*/
private _objectTypeName;
/**
* The format of your sourceLastUpdatedTimestamp that was previously set up.
*/
private _sourceLastUpdatedTimestampFormat?;
/**
* Defines the priority order of object types.
*/
private _sourcePriority?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags used to organize, track, or control access for this resource.
*/
private _tagsRaw?;
/**
* A unique identifier for the template mapping.
*/
private _templateId?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::ObjectType`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnObjectTypeProps);
get objectTypeRef(): ObjectTypeReference;
/**
* Indicates whether a profile should be created when data is received if one doesnt exist for an object of this type.
*/
get allowProfileCreation(): boolean | cdk.IResolvable | undefined;
/**
* Indicates whether a profile should be created when data is received if one doesnt exist for an object of this type.
*/
set allowProfileCreation(value: boolean | cdk.IResolvable | undefined);
/**
* The description of the profile object type mapping.
*/
get description(): string;
/**
* The description of the profile object type mapping.
*/
set description(value: string);
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
*/
get encryptionKey(): string | undefined;
/**
* The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
*/
set encryptionKey(value: string | undefined);
/**
* The number of days until the data of this type expires.
*/
get expirationDays(): number | undefined;
/**
* The number of days until the data of this type expires.
*/
set expirationDays(value: number | undefined);
/**
* A list of field definitions for the object type mapping.
*/
get fields(): Array<CfnObjectType.FieldMapProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* A list of field definitions for the object type mapping.
*/
set fields(value: Array<CfnObjectType.FieldMapProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* A list of keys that can be used to map data to the profile or search for the profile.
*/
get keys(): Array<cdk.IResolvable | CfnObjectType.KeyMapProperty> | cdk.IResolvable | undefined;
/**
* A list of keys that can be used to map data to the profile or search for the profile.
*/
set keys(value: Array<cdk.IResolvable | CfnObjectType.KeyMapProperty> | cdk.IResolvable | undefined);
/**
* The amount of profile object max count assigned to the object type.
*/
get maxProfileObjectCount(): number | undefined;
/**
* The amount of profile object max count assigned to the object type.
*/
set maxProfileObjectCount(value: number | undefined);
/**
* The name of the profile object type.
*/
get objectTypeName(): string;
/**
* The name of the profile object type.
*/
set objectTypeName(value: string);
/**
* The format of your sourceLastUpdatedTimestamp that was previously set up.
*/
get sourceLastUpdatedTimestampFormat(): string | undefined;
/**
* The format of your sourceLastUpdatedTimestamp that was previously set up.
*/
set sourceLastUpdatedTimestampFormat(value: string | undefined);
/**
* Defines the priority order of object types.
*/
get sourcePriority(): number | undefined;
/**
* Defines the priority order of object types.
*/
set sourcePriority(value: number | undefined);
/**
* The tags used to organize, track, or control access for this resource.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* The tags used to organize, track, or control access for this resource.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* A unique identifier for the template mapping.
*/
get templateId(): string | undefined;
/**
* A unique identifier for the template mapping.
*/
set templateId(value: string | undefined);
/**
* The timestamp of when the object type was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The timestamp of when the object type was most recently edited.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* The amount of provisioned profile object max count available.
*
* @cloudformationAttribute MaxAvailableProfileObjectCount
*/
get attrMaxAvailableProfileObjectCount(): number;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnObjectType {
/**
* A map of the name and ObjectType field.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html
*/
interface FieldMapProperty {
/**
* Name of the field.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-name
*/
readonly name?: string;
/**
* Represents a field in a ProfileObjectType.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-objecttypefield
*/
readonly objectTypeField?: cdk.IResolvable | CfnObjectType.ObjectTypeFieldProperty;
}
/**
* Represents a field in a ProfileObjectType.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html
*/
interface ObjectTypeFieldProperty {
/**
* The content type of the field.
*
* Used for determining equality when searching.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-contenttype
*/
readonly contentType?: string;
/**
* A field of a ProfileObject.
*
* For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-source
*/
readonly source?: string;
/**
* The location of the data in the standard ProfileObject model.
*
* For example: _profile.Address.PostalCode.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-target
*/
readonly target?: string;
}
/**
* A unique key map that can be used to map data to the profile.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html
*/
interface KeyMapProperty {
/**
* Name of the key.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-name
*/
readonly name?: string;
/**
* A list of ObjectTypeKey.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-objecttypekeylist
*/
readonly objectTypeKeyList?: Array<cdk.IResolvable | CfnObjectType.ObjectTypeKeyProperty> | cdk.IResolvable;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html
*/
interface ObjectTypeKeyProperty {
/**
* The reference for the key name of the fields map.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-fieldnames
*/
readonly fieldNames?: Array<string>;
/**
* The types of keys that a ProfileObject can have.
*
* Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers
*/
readonly standardIdentifiers?: Array<string>;
}
}
/**
* Properties for defining a `CfnObjectType`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html
*/
export interface CfnObjectTypeProps {
/**
* Indicates whether a profile should be created when data is received if one doesnt exist for an object of this type.
*
* The default is `FALSE` . If the AllowProfileCreation flag is set to `FALSE` , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE` , and if no match is found, then the service creates a new standard profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-allowprofilecreation
*/
readonly allowProfileCreation?: boolean | cdk.IResolvable;
/**
* The description of the profile object type mapping.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-description
*/
readonly description: string;
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-domainname
*/
readonly domainName: string;
/**
* The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
*
* If not specified the system will use the encryption key of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-encryptionkey
*/
readonly encryptionKey?: string;
/**
* The number of days until the data of this type expires.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-expirationdays
*/
readonly expirationDays?: number;
/**
* A list of field definitions for the object type mapping.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-fields
*/
readonly fields?: Array<CfnObjectType.FieldMapProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* A list of keys that can be used to map data to the profile or search for the profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-keys
*/
readonly keys?: Array<cdk.IResolvable | CfnObjectType.KeyMapProperty> | cdk.IResolvable;
/**
* The amount of profile object max count assigned to the object type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-maxprofileobjectcount
*/
readonly maxProfileObjectCount?: number;
/**
* The name of the profile object type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-objecttypename
*/
readonly objectTypeName: string;
/**
* The format of your sourceLastUpdatedTimestamp that was previously set up.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-sourcelastupdatedtimestampformat
*/
readonly sourceLastUpdatedTimestampFormat?: string;
/**
* Defines the priority order of object types.
*
* Lower value indicates higher priority.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-sourcepriority
*/
readonly sourcePriority?: number;
/**
* The tags used to organize, track, or control access for this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* A unique identifier for the template mapping.
*
* This can be used instead of specifying the Keys and Fields properties directly.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-templateid
*/
readonly templateId?: string;
}
/**
* Specifies the rules to perform an action based on customer ingested data.
*
* @cloudformationResource AWS::CustomerProfiles::EventTrigger
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html
*/
export declare class CfnEventTrigger extends cdk.CfnResource implements cdk.IInspectable, IEventTriggerRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnEventTrigger from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnEventTrigger;
/**
* Checks whether the given object is a CfnEventTrigger
*/
static isCfnEventTrigger(x: any): x is CfnEventTrigger;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the event trigger.
*/
private _description?;
/**
* The unique name of the domain.
*/
private _domainName;
/**
* A list of conditions that determine when an event should trigger the destination.
*/
private _eventTriggerConditions;
/**
* Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
*/
private _eventTriggerLimits?;
/**
* The unique name of the event trigger.
*/
private _eventTriggerName;
/**
* The unique name of the object type.
*/
private _objectTypeName;
/**
* The destination is triggered only for profiles that meet the criteria of a segment definition.
*/
private _segmentFilter?;
/**
* An array of key-value pairs to apply to this resource.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::EventTrigger`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnEventTriggerProps);
get eventTriggerRef(): EventTriggerReference;
/**
* The description of the event trigger.
*/
get description(): string | undefined;
/**
* The description of the event trigger.
*/
set description(value: string | undefined);
/**
* The unique name of the domain.
*/
get domainName(): string;
/**
* The unique name of the domain.
*/
set domainName(value: string);
/**
* A list of conditions that determine when an event should trigger the destination.
*/
get eventTriggerConditions(): Array<CfnEventTrigger.EventTriggerConditionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* A list of conditions that determine when an event should trigger the destination.
*/
set eventTriggerConditions(value: Array<CfnEventTrigger.EventTriggerConditionProperty | cdk.IResolvable> | cdk.IResolvable);
/**
* Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
*/
get eventTriggerLimits(): CfnEventTrigger.EventTriggerLimitsProperty | cdk.IResolvable | undefined;
/**
* Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
*/
set eventTriggerLimits(value: CfnEventTrigger.EventTriggerLimitsProperty | cdk.IResolvable | undefined);
/**
* The unique name of the event trigger.
*/
get eventTriggerName(): string;
/**
* The unique name of the event trigger.
*/
set eventTriggerName(value: string);
/**
* The unique name of the object type.
*/
get objectTypeName(): string;
/**
* The unique name of the object type.
*/
set objectTypeName(value: string);
/**
* The destination is triggered only for profiles that meet the criteria of a segment definition.
*/
get segmentFilter(): string | undefined;
/**
* The destination is triggered only for profiles that meet the criteria of a segment definition.
*/
set segmentFilter(value: string | undefined);
/**
* An array of key-value pairs to apply to this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An array of key-value pairs to apply to this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp of when the event trigger was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The timestamp of when the event trigger was most recently updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnEventTrigger {
/**
* Specifies the circumstances under which the event should trigger the destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html
*/
interface EventTriggerConditionProperty {
/**
* A list of dimensions to be evaluated for the event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-eventtriggerdimensions
*/
readonly eventTriggerDimensions: Array<CfnEventTrigger.EventTriggerDimensionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The operator used to combine multiple dimensions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-logicaloperator
*/
readonly logicalOperator: string;
}
/**
* A specific event dimension to be assessed.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.html
*/
interface EventTriggerDimensionProperty {
/**
* A list of object attributes to be evaluated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.html#cfn-customerprofiles-eventtrigger-eventtriggerdimension-objectattributes
*/
readonly objectAttributes: Array<cdk.IResolvable | CfnEventTrigger.ObjectAttributeProperty> | cdk.IResolvable;
}
/**
* The criteria that a specific object attribute must meet to trigger the destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html
*/
interface ObjectAttributeProperty {
/**
* The operator used to compare an attribute against a list of values.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-comparisonoperator
*/
readonly comparisonOperator: string;
/**
* A field defined within an object type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-fieldname
*/
readonly fieldName?: string;
/**
* An attribute contained within a source object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-source
*/
readonly source?: string;
/**
* The amount of time of the specified unit.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-values
*/
readonly values: Array<string>;
}
/**
* Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.html
*/
interface EventTriggerLimitsProperty {
/**
* Specifies that an event will only trigger the destination if it is processed within a certain latency period.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits-eventexpiration
*/
readonly eventExpiration?: number;
/**
* A list of time periods during which the limits apply.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits-periods
*/
readonly periods?: Array<cdk.IResolvable | CfnEventTrigger.PeriodProperty> | cdk.IResolvable;
}
/**
* Defines a limit and the time period during which it is enforced.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html
*/
interface PeriodProperty {
/**
* The maximum allowed number of destination invocations per profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-maxinvocationsperprofile
*/
readonly maxInvocationsPerProfile?: number;
/**
* The unit of time.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unit
*/
readonly unit: string;
/**
* If set to true, there is no limit on the number of destination invocations per profile.
*
* The default is false.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unlimited
*/
readonly unlimited?: boolean | cdk.IResolvable;
/**
* The amount of time of the specified unit.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-value
*/
readonly value: number;
}
}
/**
* Properties for defining a `CfnEventTrigger`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html
*/
export interface CfnEventTriggerProps {
/**
* The description of the event trigger.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-description
*/
readonly description?: string;
/**
* The unique name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-domainname
*/
readonly domainName: string;
/**
* A list of conditions that determine when an event should trigger the destination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerconditions
*/
readonly eventTriggerConditions: Array<CfnEventTrigger.EventTriggerConditionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits
*/
readonly eventTriggerLimits?: CfnEventTrigger.EventTriggerLimitsProperty | cdk.IResolvable;
/**
* The unique name of the event trigger.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggername
*/
readonly eventTriggerName: string;
/**
* The unique name of the object type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-objecttypename
*/
readonly objectTypeName: string;
/**
* The destination is triggered only for profiles that meet the criteria of a segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-segmentfilter
*/
readonly segmentFilter?: string;
/**
* An array of key-value pairs to apply to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Resource Type definition for AWS::CustomerProfiles::Recommender.
*
* @cloudformationResource AWS::CustomerProfiles::Recommender
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html
*/
export declare class CfnRecommender extends cdk.CfnResource implements cdk.IInspectable, IRecommenderRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnRecommender from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRecommender;
/**
* Checks whether the given object is a CfnRecommender
*/
static isCfnRecommender(x: any): x is CfnRecommender;
static arnForRecommender(resource: IRecommenderRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the recommender.
*/
private _description?;
/**
* The name of the domain for which the recommender will be created.
*/
private _domainName;
/**
* Configuration for the recommender.
*/
private _recommenderConfig?;
/**
* The name of the recommender.
*/
private _recommenderName;
/**
* The name of the recommender recipe.
*/
private _recommenderRecipeName;
/**
* The tags used to organize, track, or control access for this resource.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::Recommender`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnRecommenderProps);
get recommenderRef(): RecommenderReference;
/**
* The description of the recommender.
*/
get description(): string | undefined;
/**
* The description of the recommender.
*/
set description(value: string | undefined);
/**
* The name of the domain for which the recommender will be created.
*/
get domainName(): string;
/**
* The name of the domain for which the recommender will be created.
*/
set domainName(value: string);
/**
* Configuration for the recommender.
*/
get recommenderConfig(): cdk.IResolvable | CfnRecommender.RecommenderConfigProperty | undefined;
/**
* Configuration for the recommender.
*/
set recommenderConfig(value: cdk.IResolvable | CfnRecommender.RecommenderConfigProperty | undefined);
/**
* The name of the recommender.
*/
get recommenderName(): string;
/**
* The name of the recommender.
*/
set recommenderName(value: string);
/**
* The name of the recommender recipe.
*/
get recommenderRecipeName(): string;
/**
* The name of the recommender recipe.
*/
set recommenderRecipeName(value: string);
/**
* The tags used to organize, track, or control access for this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* The tags used to organize, track, or control access for this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp of when the recommender was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The reason for recommender failure.
*
* @cloudformationAttribute FailureReason
*/
get attrFailureReason(): string;
/**
* The timestamp of when the recommender was last updated.
*
* @cloudformationAttribute LastUpdatedAt
*/
get attrLastUpdatedAt(): string;
/**
* Information about the latest recommender update
*
* @cloudformationAttribute LatestRecommenderUpdate
*/
get attrLatestRecommenderUpdate(): cdk.IResolvable;
/**
* The Amazon Resource Name (ARN) of the recommender.
*
* @cloudformationAttribute RecommenderArn
*/
get attrRecommenderArn(): string;
/**
* The status of the recommender
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
/**
* @cloudformationAttribute TrainingMetrics
*/
get attrTrainingMetrics(): cdk.IResolvable;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnRecommender {
/**
* Configuration for the recommender.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderconfig.html
*/
interface RecommenderConfigProperty {
/**
* Configuration for events used in the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderconfig.html#cfn-customerprofiles-recommender-recommenderconfig-eventsconfig
*/
readonly eventsConfig?: CfnRecommender.EventsConfigProperty | cdk.IResolvable;
}
/**
* Configuration for events used in the recommender.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventsconfig.html
*/
interface EventsConfigProperty {
/**
* List of event parameters with their value thresholds.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventsconfig.html#cfn-customerprofiles-recommender-eventsconfig-eventparameterslist
*/
readonly eventParametersList: Array<CfnRecommender.EventParametersProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* Event parameters with type and value threshold.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html
*/
interface EventParametersProperty {
/**
* The type of event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventtype
*/
readonly eventType: string;
/**
* The threshold of the event type.
*
* Only events with a value greater or equal to this threshold will be considered for solution creation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventvaluethreshold
*/
readonly eventValueThreshold?: number;
}
/**
* Information about the latest recommender update.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html
*/
interface RecommenderUpdateProperty {
/**
* The timestamp of when the update was created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-creationdatetime
*/
readonly creationDateTime?: string;
/**
* The reason for update failure.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-failurereason
*/
readonly failureReason?: string;
/**
* The timestamp of when the update was last modified.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-lastupdateddatetime
*/
readonly lastUpdatedDateTime?: string;
/**
* Configuration for the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-recommenderconfig
*/
readonly recommenderConfig?: cdk.IResolvable | CfnRecommender.RecommenderConfigProperty;
/**
* The status of the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-status
*/
readonly status?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html
*/
interface TrainingMetricsProperty {
/**
* Training metrics by type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-metrics
*/
readonly metrics?: cdk.IResolvable | CfnRecommender.MetricsProperty;
/**
* Timestamp of the training metrics.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-time
*/
readonly time?: string;
}
/**
* Training metrics by type.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html
*/
interface MetricsProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-coverage
*/
readonly coverage?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-freshness
*/
readonly freshness?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-hit
*/
readonly hit?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-popularity
*/
readonly popularity?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-recall
*/
readonly recall?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-similarity
*/
readonly similarity?: number;
}
}
/**
* Properties for defining a `CfnRecommender`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html
*/
export interface CfnRecommenderProps {
/**
* The description of the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-description
*/
readonly description?: string;
/**
* The name of the domain for which the recommender will be created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-domainname
*/
readonly domainName: string;
/**
* Configuration for the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderconfig
*/
readonly recommenderConfig?: cdk.IResolvable | CfnRecommender.RecommenderConfigProperty;
/**
* The name of the recommender.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommendername
*/
readonly recommenderName: string;
/**
* The name of the recommender recipe.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderrecipename
*/
readonly recommenderRecipeName: string;
/**
* The tags used to organize, track, or control access for this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* A segment definition resource of Amazon Connect Customer Profiles.
*
* @cloudformationResource AWS::CustomerProfiles::SegmentDefinition
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html
*/
export declare class CfnSegmentDefinition extends cdk.CfnResource implements cdk.IInspectable, ISegmentDefinitionRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnSegmentDefinition from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSegmentDefinition;
/**
* Checks whether the given object is a CfnSegmentDefinition
*/
static isCfnSegmentDefinition(x: any): x is CfnSegmentDefinition;
static arnForSegmentDefinition(resource: ISegmentDefinitionRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the segment definition.
*/
private _description?;
/**
* Display name of the segment definition.
*/
private _displayName;
/**
* The name of the domain.
*/
private _domainName;
/**
* Name of the segment definition.
*/
private _segmentDefinitionName;
/**
* Contains all groups of the segment definition.
*/
private _segmentGroups?;
/**
* Defines how segments should be sorted and ordered in the results.
*/
private _segmentSort?;
/**
* The SQL query that defines the segment criteria.
*/
private _segmentSqlQuery?;
/**
* The tags belonging to the segment definition.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::CustomerProfiles::SegmentDefinition`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnSegmentDefinitionProps);
get segmentDefinitionRef(): SegmentDefinitionReference;
/**
* The description of the segment definition.
*/
get description(): string | undefined;
/**
* The description of the segment definition.
*/
set description(value: string | undefined);
/**
* Display name of the segment definition.
*/
get displayName(): string;
/**
* Display name of the segment definition.
*/
set displayName(value: string);
/**
* The name of the domain.
*/
get domainName(): string;
/**
* The name of the domain.
*/
set domainName(value: string);
/**
* Name of the segment definition.
*/
get segmentDefinitionName(): string;
/**
* Name of the segment definition.
*/
set segmentDefinitionName(value: string);
/**
* Contains all groups of the segment definition.
*/
get segmentGroups(): cdk.IResolvable | CfnSegmentDefinition.SegmentGroupProperty | undefined;
/**
* Contains all groups of the segment definition.
*/
set segmentGroups(value: cdk.IResolvable | CfnSegmentDefinition.SegmentGroupProperty | undefined);
/**
* Defines how segments should be sorted and ordered in the results.
*/
get segmentSort(): cdk.IResolvable | CfnSegmentDefinition.SegmentSortProperty | undefined;
/**
* Defines how segments should be sorted and ordered in the results.
*/
set segmentSort(value: cdk.IResolvable | CfnSegmentDefinition.SegmentSortProperty | undefined);
/**
* The SQL query that defines the segment criteria.
*/
get segmentSqlQuery(): string | undefined;
/**
* The SQL query that defines the segment criteria.
*/
set segmentSqlQuery(value: string | undefined);
/**
* The tags belonging to the segment definition.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* The tags belonging to the segment definition.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* When the segment definition was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The arn of the segment definition.
*
* @cloudformationAttribute SegmentDefinitionArn
*/
get attrSegmentDefinitionArn(): string;
/**
* The segment type.
*
* Classic : Segments created using traditional SegmentGroup structure
*
* Enhanced : Segments created using SQL queries
*
* @cloudformationAttribute SegmentType
*/
get attrSegmentType(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnSegmentDefinition {
/**
* Contains all groups of the segment definition.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html
*/
interface SegmentGroupProperty {
/**
* Holds the list of groups within the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-groups
*/
readonly groups?: Array<CfnSegmentDefinition.GroupProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Defines whether to include or exclude the profiles that fit the segment criteria.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-include
*/
readonly include?: string;
}
/**
* Contains dimensions that determine what to segment on.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html
*/
interface GroupProperty {
/**
* Defines the attributes to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-dimensions
*/
readonly dimensions?: Array<CfnSegmentDefinition.DimensionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Defines the starting source of data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcesegments
*/
readonly sourceSegments?: Array<cdk.IResolvable | CfnSegmentDefinition.SourceSegmentProperty> | cdk.IResolvable;
/**
* Defines how to interact with the source data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcetype
*/
readonly sourceType?: string;
/**
* Defines how to interact with the profiles found in the current filtering.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-type
*/
readonly type?: string;
}
/**
* Defines the attribute to segment on.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html
*/
interface DimensionProperty {
/**
* Object that holds the calculated attributes to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes
*/
readonly calculatedAttributes?: cdk.IResolvable | Record<string, CfnSegmentDefinition.CalculatedAttributeDimensionProperty | cdk.IResolvable>;
/**
* Object that holds the profile attributes to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-profileattributes
*/
readonly profileAttributes?: cdk.IResolvable | CfnSegmentDefinition.ProfileAttributesProperty;
}
/**
* The object used to segment on attributes within the customer profile.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html
*/
interface ProfileAttributesProperty {
/**
* A field to describe values to segment on within account number.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber
*/
readonly accountNumber?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within additional information.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation
*/
readonly additionalInformation?: CfnSegmentDefinition.ExtraLengthValueProfileDimensionProperty | cdk.IResolvable;
/**
* A field to describe values to segment on within address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-address
*/
readonly address?: CfnSegmentDefinition.AddressDimensionProperty | cdk.IResolvable;
/**
* A field to describe values to segment on within attributes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-attributes
*/
readonly attributes?: cdk.IResolvable | Record<string, CfnSegmentDefinition.AttributeDimensionProperty | cdk.IResolvable>;
/**
* A field to describe values to segment on within billing address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress
*/
readonly billingAddress?: CfnSegmentDefinition.AddressDimensionProperty | cdk.IResolvable;
/**
* A field to describe values to segment on within birthDate.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate
*/
readonly birthDate?: CfnSegmentDefinition.DateDimensionProperty | cdk.IResolvable;
/**
* A field to describe values to segment on within business email address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress
*/
readonly businessEmailAddress?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within business name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessname
*/
readonly businessName?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within business phone number.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber
*/
readonly businessPhoneNumber?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within email address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress
*/
readonly emailAddress?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within first name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-firstname
*/
readonly firstName?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within genderString.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring
*/
readonly genderString?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within home phone number.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber
*/
readonly homePhoneNumber?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within last name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-lastname
*/
readonly lastName?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within mailing address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress
*/
readonly mailingAddress?: CfnSegmentDefinition.AddressDimensionProperty | cdk.IResolvable;
/**
* A field to describe values to segment on within middle name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-middlename
*/
readonly middleName?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within mobile phone number.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber
*/
readonly mobilePhoneNumber?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within partyTypeString.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring
*/
readonly partyTypeString?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within personal email address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress
*/
readonly personalEmailAddress?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* A field to describe values to segment on within phone number.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber
*/
readonly phoneNumber?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The type of profile.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype
*/
readonly profileType?: cdk.IResolvable | CfnSegmentDefinition.ProfileTypeDimensionProperty;
/**
* A field to describe values to segment on within shipping address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress
*/
readonly shippingAddress?: CfnSegmentDefinition.AddressDimensionProperty | cdk.IResolvable;
}
/**
* Object that segments on various Customer profile's fields that are larger than normal.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html
*/
interface ProfileDimensionProperty {
/**
* The action to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype
*/
readonly dimensionType: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-values
*/
readonly values: Array<string>;
}
/**
* Object that segments on various Customer profile's fields that are larger than normal.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html
*/
interface ExtraLengthValueProfileDimensionProperty {
/**
* The action to segment with.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype
*/
readonly dimensionType: string;
/**
* The values to apply the DimensionType on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values
*/
readonly values: Array<string>;
}
/**
* Object that segments on various Customer Profile's date fields.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html
*/
interface DateDimensionProperty {
/**
* The action to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype
*/
readonly dimensionType: string;
/**
* The values to apply the DimensionType on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-values
*/
readonly values: Array<string>;
}
/**
* Object that segments on Customer Profile's address object.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html
*/
interface AddressDimensionProperty {
/**
* The city belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-city
*/
readonly city?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The country belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-country
*/
readonly country?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The county belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-county
*/
readonly county?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The postal code belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode
*/
readonly postalCode?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The province belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-province
*/
readonly province?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
/**
* The state belonging to the address.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-state
*/
readonly state?: cdk.IResolvable | CfnSegmentDefinition.ProfileDimensionProperty;
}
/**
* Object that defines how to filter the incoming objects for the calculated attribute.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html
*/
interface AttributeDimensionProperty {
/**
* The action to segment with.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype
*/
readonly dimensionType: string;
/**
* The values to apply the DimensionType on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-values
*/
readonly values: Array<string>;
}
/**
* Specifies profile type based criteria for a segment.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiletypedimension.html
*/
interface ProfileTypeDimensionProperty {
/**
* The action to segment on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiletypedimension.html#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype
*/
readonly dimensionType: string;
/**
* The values to apply the DimensionType on.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiletypedimension.html#cfn-customerprofiles-segmentdefinition-profiletypedimension-values
*/
readonly values: Array<string>;
}
/**
* Object that segments on Customer Profile's Calculated Attributes.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html
*/
interface CalculatedAttributeDimensionProperty {
/**
* Applies the given condition over the initial Calculated Attribute's definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides
*/
readonly conditionOverrides?: CfnSegmentDefinition.ConditionOverridesProperty | cdk.IResolvable;
/**
* The action to segment with.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype
*/
readonly dimensionType: string;
/**
* The values to apply the DimensionType with.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values
*/
readonly values: Array<string>;
}
/**
* An object to override the original condition block of a calculated attribute.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html
*/
interface ConditionOverridesProperty {
/**
* The relative time period over which data is included in the aggregation for this override.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html#cfn-customerprofiles-segmentdefinition-conditionoverrides-range
*/
readonly range?: cdk.IResolvable | CfnSegmentDefinition.RangeOverrideProperty;
}
/**
* Overrides the original range on a calculated attribute definition.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html
*/
interface RangeOverrideProperty {
/**
* The end time of when to include objects.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-end
*/
readonly end?: number;
/**
* The start time of when to include objects.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-start
*/
readonly start: number;
/**
* The unit for start and end.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-unit
*/
readonly unit: string;
}
/**
* The source segments to build off of.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.html
*/
interface SourceSegmentProperty {
/**
* The name of the source segment.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.html#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname
*/
readonly segmentDefinitionName?: string;
}
/**
* Defines how segments should be sorted and ordered in the results.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentsort.html
*/
interface SegmentSortProperty {
/**
* A list of attributes used to sort the segments and their ordering preferences.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentsort.html#cfn-customerprofiles-segmentdefinition-segmentsort-attributes
*/
readonly attributes: Array<cdk.IResolvable | CfnSegmentDefinition.SortAttributeProperty> | cdk.IResolvable;
}
/**
* Defines the characteristics and rules for sorting by a specific attribute.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html
*/
interface SortAttributeProperty {
/**
* The data type of the sort attribute (e.g., string, number, date).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-datatype
*/
readonly dataType?: string;
/**
* The name of the attribute to sort by.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-name
*/
readonly name: string;
/**
* The sort order for the attribute (ascending or descending).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-order
*/
readonly order: string;
/**
* The type of attribute (e.g., profile, calculated).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-type
*/
readonly type?: string;
}
}
/**
* Properties for defining a `CfnSegmentDefinition`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html
*/
export interface CfnSegmentDefinitionProps {
/**
* The description of the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-description
*/
readonly description?: string;
/**
* Display name of the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-displayname
*/
readonly displayName: string;
/**
* The name of the domain.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-domainname
*/
readonly domainName: string;
/**
* Name of the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionname
*/
readonly segmentDefinitionName: string;
/**
* Contains all groups of the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentgroups
*/
readonly segmentGroups?: cdk.IResolvable | CfnSegmentDefinition.SegmentGroupProperty;
/**
* Defines how segments should be sorted and ordered in the results.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsort
*/
readonly segmentSort?: cdk.IResolvable | CfnSegmentDefinition.SegmentSortProperty;
/**
* The SQL query that defines the segment criteria.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsqlquery
*/
readonly segmentSqlQuery?: string;
/**
* The tags belonging to the segment definition.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
export type { ICalculatedAttributeDefinitionRef, CalculatedAttributeDefinitionReference };
export type { IDomainRef, DomainReference };
export type { IEventStreamRef, EventStreamReference };
export type { IIntegrationRef, IntegrationReference };
export type { IObjectTypeRef, ObjectTypeReference };
export type { IEventTriggerRef, EventTriggerReference };
export type { IRecommenderRef, RecommenderReference };
export type { ISegmentDefinitionRef, SegmentDefinitionReference };