class CfnCampaignPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ConnectCampaignsV2.Mixins.CfnCampaignPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsconnectcampaignsv2/mixins#CfnCampaignPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.connectcampaignsv2.mixins.CfnCampaignPropsMixin
Python	aws_cdk.mixins_preview.aws_connectcampaignsv2.mixins.CfnCampaignPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_connectcampaignsv2 » mixins » CfnCampaignPropsMixin

Implements IMixin

Extends Mixin

Creates an outbound campaign.

• For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag. For example, { "tags": {"owner": "arn:aws:connect:{REGION}:{AWS_ACCOUNT_ID}:instance/{CONNECT_INSTANCE_ID}"}} .
• After a campaign is created, you can't add/remove source.
• Configuring maximum ring time is not supported for the Preview dial mode.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as connectcampaignsv2_mixins } from '@aws-cdk/mixins-preview/aws-connectcampaignsv2';

declare const agentlessConfig: any;
const cfnCampaignPropsMixin = new connectcampaignsv2_mixins.CfnCampaignPropsMixin({
  channelSubtypeConfig: {
    email: {
      capacity: 123,
      defaultOutboundConfig: {
        connectSourceEmailAddress: 'connectSourceEmailAddress',
        sourceEmailAddressDisplayName: 'sourceEmailAddressDisplayName',
        wisdomTemplateArn: 'wisdomTemplateArn',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
      },
    },
    sms: {
      capacity: 123,
      defaultOutboundConfig: {
        connectSourcePhoneNumberArn: 'connectSourcePhoneNumberArn',
        wisdomTemplateArn: 'wisdomTemplateArn',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
      },
    },
    telephony: {
      capacity: 123,
      connectQueueId: 'connectQueueId',
      defaultOutboundConfig: {
        answerMachineDetectionConfig: {
          awaitAnswerMachinePrompt: false,
          enableAnswerMachineDetection: false,
        },
        connectContactFlowId: 'connectContactFlowId',
        connectSourcePhoneNumber: 'connectSourcePhoneNumber',
        ringTimeout: 123,
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
        predictiveConfig: {
          bandwidthAllocation: 123,
        },
        previewConfig: {
          agentActions: ['agentActions'],
          bandwidthAllocation: 123,
          timeoutConfig: {
            durationInSeconds: 123,
          },
        },
        progressiveConfig: {
          bandwidthAllocation: 123,
        },
      },
    },
    whatsApp: {
      capacity: 123,
      defaultOutboundConfig: {
        connectSourcePhoneNumberArn: 'connectSourcePhoneNumberArn',
        wisdomTemplateArn: 'wisdomTemplateArn',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
      },
    },
  },
  communicationLimitsOverride: {
    allChannelsSubtypes: {
      communicationLimitList: [{
        frequency: 123,
        maxCountPerRecipient: 123,
        unit: 'unit',
      }],
    },
    instanceLimitsHandling: 'instanceLimitsHandling',
  },
  communicationTimeConfig: {
    email: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          name: 'name',
          startDate: 'startDate',
        }],
      },
    },
    localTimeZoneConfig: {
      defaultTimeZone: 'defaultTimeZone',
      localTimeZoneDetection: ['localTimeZoneDetection'],
    },
    sms: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          name: 'name',
          startDate: 'startDate',
        }],
      },
    },
    telephony: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          name: 'name',
          startDate: 'startDate',
        }],
      },
    },
    whatsApp: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          name: 'name',
          startDate: 'startDate',
        }],
      },
    },
  },
  connectCampaignFlowArn: 'connectCampaignFlowArn',
  connectInstanceId: 'connectInstanceId',
  name: 'name',
  schedule: {
    endTime: 'endTime',
    refreshFrequency: 'refreshFrequency',
    startTime: 'startTime',
  },
  source: {
    customerProfilesSegmentArn: 'customerProfilesSegmentArn',
    eventTrigger: {
      customerProfilesDomainArn: 'customerProfilesDomainArn',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnCampaignPropsMixin(props: CfnCampaignMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCampaignMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ConnectCampaignsV2::Campaign.

Properties

Name	Type	Description
props	CfnCampaignMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCampaignMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.