interface CfnCampaignMixinProps

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

Properties for CfnCampaignPropsMixin.

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 as connectcampaignsv2_mixins } from '@aws-cdk/mixins-preview/aws-connectcampaignsv2';

declare const agentlessConfig: any;
const cfnCampaignMixinProps: connectcampaignsv2_mixins.CfnCampaignMixinProps = {
  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',
};

Properties

Name	Type	Description
channelSubtypeConfig?	IResolvable | ChannelSubtypeConfigProperty	Contains channel subtype configuration for an outbound campaign.
communicationLimitsOverride?	IResolvable | CommunicationLimitsConfigProperty	Communication limits configuration for an outbound campaign.
communicationTimeConfig?	IResolvable | CommunicationTimeConfigProperty	Contains communication time configuration for an outbound campaign.
connectCampaignFlowArn?	string	The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
connectInstanceId?	string	The identifier of the Amazon Connect instance.
name?	string	The name of the outbound campaign.
schedule?	IResolvable | ScheduleProperty	Contains the schedule configuration.
source?	IResolvable | SourceProperty	Contains source configuration.
tags?	CfnTag[]	The tags used to organize, track, or control access for this resource.
type?	string	The type of campaign.

---

channelSubtypeConfig?

Type: IResolvable | ChannelSubtypeConfigProperty (optional)

Contains channel subtype configuration for an outbound campaign.

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

---

communicationLimitsOverride?

Type: IResolvable | CommunicationLimitsConfigProperty (optional)

Communication limits configuration for an outbound campaign.

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

---

communicationTimeConfig?

Type: IResolvable | CommunicationTimeConfigProperty (optional)

Contains communication time configuration for an outbound campaign.

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

---

connectCampaignFlowArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.

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

---

connectInstanceId?

Type: string (optional)

The identifier of the Amazon Connect instance.

You can find the instanceId in the ARN of the instance.

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

---

name?

Type: string (optional)

The name of the outbound campaign.

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

---

schedule?

Type: IResolvable | ScheduleProperty (optional)

Contains the schedule configuration.

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

---

source?

Type: IResolvable | SourceProperty (optional)

Contains source configuration.

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

---

tags?

Type: CfnTag[] (optional)

The tags used to organize, track, or control access for this resource.

For example, { "tags": {"key1":"value1", "key2":"value2"} } .

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

---

type?

Type: string (optional)

The type of campaign.

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