UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

718 lines (717 loc) 33.6 kB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * Definition of AWS::ConnectCampaignsV2::Campaign Resource Type. * * @cloudformationResource AWS::ConnectCampaignsV2::Campaign * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html */ export declare class CfnCampaign extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnCampaign 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): CfnCampaign; /** * Amazon Connect Campaign Arn * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The possible types of channel subtype config parameters. */ channelSubtypeConfig: CfnCampaign.ChannelSubtypeConfigProperty | cdk.IResolvable; /** * Communication limits config. */ communicationLimitsOverride?: CfnCampaign.CommunicationLimitsConfigProperty | cdk.IResolvable; /** * Campaign communication time config. */ communicationTimeConfig?: CfnCampaign.CommunicationTimeConfigProperty | cdk.IResolvable; /** * Arn. */ connectCampaignFlowArn?: string; /** * Amazon Connect Instance Id. */ connectInstanceId: string; /** * Campaign name. */ name: string; /** * Campaign schedule. */ schedule?: cdk.IResolvable | CfnCampaign.ScheduleProperty; /** * The possible types of channel config parameters. */ source?: cdk.IResolvable | CfnCampaign.SourceProperty; /** * One or more tags. */ tags?: Array<cdk.CfnTag>; /** * @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: CfnCampaignProps); 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 CfnCampaign { /** * The possible types of channel subtype config parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html */ interface ChannelSubtypeConfigProperty { /** * Email Channel Subtype config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-email */ readonly email?: CfnCampaign.EmailChannelSubtypeConfigProperty | cdk.IResolvable; /** * SMS Channel Subtype config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-sms */ readonly sms?: cdk.IResolvable | CfnCampaign.SmsChannelSubtypeConfigProperty; /** * Telephony Channel Subtype config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-telephony */ readonly telephony?: cdk.IResolvable | CfnCampaign.TelephonyChannelSubtypeConfigProperty; } /** * Telephony Channel Subtype config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html */ interface TelephonyChannelSubtypeConfigProperty { /** * Allocates outbound capacity for the specific channel of this campaign between multiple active campaigns. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-capacity */ readonly capacity?: number; /** * The queue for the call. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-connectqueueid */ readonly connectQueueId?: string; /** * Default Telephone Outbound config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-defaultoutboundconfig */ readonly defaultOutboundConfig: cdk.IResolvable | CfnCampaign.TelephonyOutboundConfigProperty; /** * Telephony Outbound Mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-outboundmode */ readonly outboundMode: cdk.IResolvable | CfnCampaign.TelephonyOutboundModeProperty; } /** * Telephony Outbound Mode. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html */ interface TelephonyOutboundModeProperty { /** * Agentless config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-agentlessconfig */ readonly agentlessConfig?: any | cdk.IResolvable; /** * Predictive config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-predictiveconfig */ readonly predictiveConfig?: cdk.IResolvable | CfnCampaign.PredictiveConfigProperty; /** * Progressive config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-progressiveconfig */ readonly progressiveConfig?: cdk.IResolvable | CfnCampaign.ProgressiveConfigProperty; } /** * Progressive config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-progressiveconfig.html */ interface ProgressiveConfigProperty { /** * The bandwidth allocation of a queue resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-progressiveconfig.html#cfn-connectcampaignsv2-campaign-progressiveconfig-bandwidthallocation */ readonly bandwidthAllocation: number; } /** * Predictive config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-predictiveconfig.html */ interface PredictiveConfigProperty { /** * The bandwidth allocation of a queue resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-predictiveconfig.html#cfn-connectcampaignsv2-campaign-predictiveconfig-bandwidthallocation */ readonly bandwidthAllocation: number; } /** * Default Telephone Outbound config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html */ interface TelephonyOutboundConfigProperty { /** * The configuration used for answering machine detection during outbound calls. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-answermachinedetectionconfig */ readonly answerMachineDetectionConfig?: CfnCampaign.AnswerMachineDetectionConfigProperty | cdk.IResolvable; /** * The identifier of the contact flow for the outbound call. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-connectcontactflowid */ readonly connectContactFlowId: string; /** * The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-connectsourcephonenumber */ readonly connectSourcePhoneNumber?: string; } /** * The configuration used for answering machine detection during outbound calls. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.html */ interface AnswerMachineDetectionConfigProperty { /** * Enables detection of prompts (e.g., beep after after a voicemail greeting). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.html#cfn-connectcampaignsv2-campaign-answermachinedetectionconfig-awaitanswermachineprompt */ readonly awaitAnswerMachinePrompt?: boolean | cdk.IResolvable; /** * Flag to decided whether outbound calls should have answering machine detection enabled or not. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.html#cfn-connectcampaignsv2-campaign-answermachinedetectionconfig-enableanswermachinedetection */ readonly enableAnswerMachineDetection: boolean | cdk.IResolvable; } /** * SMS Channel Subtype config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html */ interface SmsChannelSubtypeConfigProperty { /** * Allocates outbound capacity for the specific channel of this campaign between multiple active campaigns. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-capacity */ readonly capacity?: number; /** * Default SMS outbound config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-defaultoutboundconfig */ readonly defaultOutboundConfig: cdk.IResolvable | CfnCampaign.SmsOutboundConfigProperty; /** * SMS Outbound Mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-outboundmode */ readonly outboundMode: cdk.IResolvable | CfnCampaign.SmsOutboundModeProperty; } /** * SMS Outbound Mode. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundmode.html */ interface SmsOutboundModeProperty { /** * Agentless config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundmode.html#cfn-connectcampaignsv2-campaign-smsoutboundmode-agentlessconfig */ readonly agentlessConfig?: any | cdk.IResolvable; } /** * Default SMS outbound config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.html */ interface SmsOutboundConfigProperty { /** * Arn. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.html#cfn-connectcampaignsv2-campaign-smsoutboundconfig-connectsourcephonenumberarn */ readonly connectSourcePhoneNumberArn: string; /** * Arn. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.html#cfn-connectcampaignsv2-campaign-smsoutboundconfig-wisdomtemplatearn */ readonly wisdomTemplateArn: string; } /** * Email Channel Subtype config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html */ interface EmailChannelSubtypeConfigProperty { /** * Allocates outbound capacity for the specific channel of this campaign between multiple active campaigns. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-capacity */ readonly capacity?: number; /** * Default SMS outbound config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-defaultoutboundconfig */ readonly defaultOutboundConfig: CfnCampaign.EmailOutboundConfigProperty | cdk.IResolvable; /** * Email Outbound Mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-outboundmode */ readonly outboundMode: CfnCampaign.EmailOutboundModeProperty | cdk.IResolvable; } /** * Email Outbound Mode. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundmode.html */ interface EmailOutboundModeProperty { /** * Agentless config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundmode.html#cfn-connectcampaignsv2-campaign-emailoutboundmode-agentlessconfig */ readonly agentlessConfig?: any | cdk.IResolvable; } /** * Default SMS outbound config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html */ interface EmailOutboundConfigProperty { /** * Email address used for Email messages. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-connectsourceemailaddress */ readonly connectSourceEmailAddress: string; /** * The name of the source email address display name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-sourceemailaddressdisplayname */ readonly sourceEmailAddressDisplayName?: string; /** * Arn. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-wisdomtemplatearn */ readonly wisdomTemplateArn: string; } /** * The possible types of channel config parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-source.html */ interface SourceProperty { /** * Arn. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-source.html#cfn-connectcampaignsv2-campaign-source-customerprofilessegmentarn */ readonly customerProfilesSegmentArn: string; } /** * Campaign schedule. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html */ interface ScheduleProperty { /** * Timestamp with no UTC offset or timezone. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-endtime */ readonly endTime: string; /** * Time duration in ISO 8601 format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-refreshfrequency */ readonly refreshFrequency?: string; /** * Timestamp with no UTC offset or timezone. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-starttime */ readonly startTime: string; } /** * Campaign communication time config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html */ interface CommunicationTimeConfigProperty { /** * Time window config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-email */ readonly email?: cdk.IResolvable | CfnCampaign.TimeWindowProperty; /** * Local time zone config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-localtimezoneconfig */ readonly localTimeZoneConfig: cdk.IResolvable | CfnCampaign.LocalTimeZoneConfigProperty; /** * Time window config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-sms */ readonly sms?: cdk.IResolvable | CfnCampaign.TimeWindowProperty; /** * Time window config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-telephony */ readonly telephony?: cdk.IResolvable | CfnCampaign.TimeWindowProperty; } /** * Local time zone config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.html */ interface LocalTimeZoneConfigProperty { /** * Time Zone Id in the IANA format. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.html#cfn-connectcampaignsv2-campaign-localtimezoneconfig-defaulttimezone */ readonly defaultTimeZone?: string; /** * Local TimeZone Detection method list. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.html#cfn-connectcampaignsv2-campaign-localtimezoneconfig-localtimezonedetection */ readonly localTimeZoneDetection?: Array<string>; } /** * Time window config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.html */ interface TimeWindowProperty { /** * Open Hours config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.html#cfn-connectcampaignsv2-campaign-timewindow-openhours */ readonly openHours: cdk.IResolvable | CfnCampaign.OpenHoursProperty; /** * Restricted period config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.html#cfn-connectcampaignsv2-campaign-timewindow-restrictedperiods */ readonly restrictedPeriods?: cdk.IResolvable | CfnCampaign.RestrictedPeriodsProperty; } /** * Open Hours config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-openhours.html */ interface OpenHoursProperty { /** * Daily Hours map. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-openhours.html#cfn-connectcampaignsv2-campaign-openhours-dailyhours */ readonly dailyHours: Array<CfnCampaign.DailyHourProperty | cdk.IResolvable> | cdk.IResolvable; } /** * Daily Hour. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.html */ interface DailyHourProperty { /** * Day of week. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.html#cfn-connectcampaignsv2-campaign-dailyhour-key */ readonly key?: string; /** * List of time range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.html#cfn-connectcampaignsv2-campaign-dailyhour-value */ readonly value?: Array<cdk.IResolvable | CfnCampaign.TimeRangeProperty> | cdk.IResolvable; } /** * Time range in 24 hour format. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.html */ interface TimeRangeProperty { /** * Time in ISO 8601 format, e.g. T23:11. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.html#cfn-connectcampaignsv2-campaign-timerange-endtime */ readonly endTime: string; /** * Time in ISO 8601 format, e.g. T23:11. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.html#cfn-connectcampaignsv2-campaign-timerange-starttime */ readonly startTime: string; } /** * Restricted period config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiods.html */ interface RestrictedPeriodsProperty { /** * List of restricted period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiods.html#cfn-connectcampaignsv2-campaign-restrictedperiods-restrictedperiodlist */ readonly restrictedPeriodList: Array<cdk.IResolvable | CfnCampaign.RestrictedPeriodProperty> | cdk.IResolvable; } /** * Restricted period. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html */ interface RestrictedPeriodProperty { /** * Date in ISO 8601 format, e.g. 2024-01-01. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-enddate */ readonly endDate: string; /** * The name of a restricted period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-name */ readonly name?: string; /** * Date in ISO 8601 format, e.g. 2024-01-01. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-startdate */ readonly startDate: string; } /** * Communication limits config. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimitsconfig.html */ interface CommunicationLimitsConfigProperty { /** * Communication limits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimitsconfig.html#cfn-connectcampaignsv2-campaign-communicationlimitsconfig-allchannelssubtypes */ readonly allChannelsSubtypes?: CfnCampaign.CommunicationLimitsProperty | cdk.IResolvable; } /** * Communication limits. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimits.html */ interface CommunicationLimitsProperty { /** * List of communication limit. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimits.html#cfn-connectcampaignsv2-campaign-communicationlimits-communicationlimitlist */ readonly communicationLimitList?: Array<CfnCampaign.CommunicationLimitProperty | cdk.IResolvable> | cdk.IResolvable; } /** * Communication Limit. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html */ interface CommunicationLimitProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-frequency */ readonly frequency: number; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-maxcountperrecipient */ readonly maxCountPerRecipient: number; /** * The communication limit time unit. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-unit */ readonly unit: string; } } /** * Properties for defining a `CfnCampaign` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html */ export interface CfnCampaignProps { /** * The possible types of channel subtype config parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig */ readonly channelSubtypeConfig: CfnCampaign.ChannelSubtypeConfigProperty | cdk.IResolvable; /** * Communication limits config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-communicationlimitsoverride */ readonly communicationLimitsOverride?: CfnCampaign.CommunicationLimitsConfigProperty | cdk.IResolvable; /** * Campaign communication time config. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig */ readonly communicationTimeConfig?: CfnCampaign.CommunicationTimeConfigProperty | cdk.IResolvable; /** * Arn. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-connectcampaignflowarn */ readonly connectCampaignFlowArn?: string; /** * Amazon Connect Instance Id. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-connectinstanceid */ readonly connectInstanceId: string; /** * Campaign name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-name */ readonly name: string; /** * Campaign schedule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-schedule */ readonly schedule?: cdk.IResolvable | CfnCampaign.ScheduleProperty; /** * The possible types of channel config parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-source */ readonly source?: cdk.IResolvable | CfnCampaign.SourceProperty; /** * One or more tags. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html#cfn-connectcampaignsv2-campaign-tags */ readonly tags?: Array<cdk.CfnTag>; }