CfnCampaignProps

class aws_cdk.aws_connectcampaignsv2.CfnCampaignProps(*, channel_subtype_config, connect_instance_id, name, communication_limits_override=None, communication_time_config=None, connect_campaign_flow_arn=None, schedule=None, source=None, tags=None)

Bases: object

Properties for defining a CfnCampaign.

Parameters:

channel_subtype_config (Union[IResolvable, ChannelSubtypeConfigProperty, Dict[str, Any]]) – Contains channel subtype configuration for an outbound campaign.
connect_instance_id (str) – The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name (str) – The name of the outbound campaign.
communication_limits_override (Union[IResolvable, CommunicationLimitsConfigProperty, Dict[str, Any], None]) – Communication limits configuration for an outbound campaign.
communication_time_config (Union[IResolvable, CommunicationTimeConfigProperty, Dict[str, Any], None]) – Contains communication time configuration for an outbound campaign.
connect_campaign_flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
schedule (Union[IResolvable, ScheduleProperty, Dict[str, Any], None]) – Contains the schedule configuration.
source (Union[IResolvable, SourceProperty, Dict[str, Any], None]) – Contains source configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} } .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

cfn_campaign_props = connectcampaignsv2.CfnCampaignProps(
    channel_subtype_config=connectcampaignsv2.CfnCampaign.ChannelSubtypeConfigProperty(
        email=connectcampaignsv2.CfnCampaign.EmailChannelSubtypeConfigProperty(
            default_outbound_config=connectcampaignsv2.CfnCampaign.EmailOutboundConfigProperty(
                connect_source_email_address="connectSourceEmailAddress",
                wisdom_template_arn="wisdomTemplateArn",

                # the properties below are optional
                source_email_address_display_name="sourceEmailAddressDisplayName"
            ),
            outbound_mode=connectcampaignsv2.CfnCampaign.EmailOutboundModeProperty(
                agentless_config=agentless_config
            ),

            # the properties below are optional
            capacity=123
        ),
        sms=connectcampaignsv2.CfnCampaign.SmsChannelSubtypeConfigProperty(
            default_outbound_config=connectcampaignsv2.CfnCampaign.SmsOutboundConfigProperty(
                connect_source_phone_number_arn="connectSourcePhoneNumberArn",
                wisdom_template_arn="wisdomTemplateArn"
            ),
            outbound_mode=connectcampaignsv2.CfnCampaign.SmsOutboundModeProperty(
                agentless_config=agentless_config
            ),

            # the properties below are optional
            capacity=123
        ),
        telephony=connectcampaignsv2.CfnCampaign.TelephonyChannelSubtypeConfigProperty(
            default_outbound_config=connectcampaignsv2.CfnCampaign.TelephonyOutboundConfigProperty(
                connect_contact_flow_id="connectContactFlowId",

                # the properties below are optional
                answer_machine_detection_config=connectcampaignsv2.CfnCampaign.AnswerMachineDetectionConfigProperty(
                    enable_answer_machine_detection=False,

                    # the properties below are optional
                    await_answer_machine_prompt=False
                ),
                connect_source_phone_number="connectSourcePhoneNumber",
                ring_timeout=123
            ),
            outbound_mode=connectcampaignsv2.CfnCampaign.TelephonyOutboundModeProperty(
                agentless_config=agentless_config,
                predictive_config=connectcampaignsv2.CfnCampaign.PredictiveConfigProperty(
                    bandwidth_allocation=123
                ),
                preview_config=connectcampaignsv2.CfnCampaign.PreviewConfigProperty(
                    bandwidth_allocation=123,
                    timeout_config=connectcampaignsv2.CfnCampaign.TimeoutConfigProperty(
                        duration_in_seconds=123
                    ),

                    # the properties below are optional
                    agent_actions=["agentActions"]
                ),
                progressive_config=connectcampaignsv2.CfnCampaign.ProgressiveConfigProperty(
                    bandwidth_allocation=123
                )
            ),

            # the properties below are optional
            capacity=123,
            connect_queue_id="connectQueueId"
        )
    ),
    connect_instance_id="connectInstanceId",
    name="name",

    # the properties below are optional
    communication_limits_override=connectcampaignsv2.CfnCampaign.CommunicationLimitsConfigProperty(
        all_channels_subtypes=connectcampaignsv2.CfnCampaign.CommunicationLimitsProperty(
            communication_limit_list=[connectcampaignsv2.CfnCampaign.CommunicationLimitProperty(
                frequency=123,
                max_count_per_recipient=123,
                unit="unit"
            )]
        ),
        instance_limits_handling="instanceLimitsHandling"
    ),
    communication_time_config=connectcampaignsv2.CfnCampaign.CommunicationTimeConfigProperty(
        local_time_zone_config=connectcampaignsv2.CfnCampaign.LocalTimeZoneConfigProperty(
            default_time_zone="defaultTimeZone",
            local_time_zone_detection=["localTimeZoneDetection"]
        ),

        # the properties below are optional
        email=connectcampaignsv2.CfnCampaign.TimeWindowProperty(
            open_hours=connectcampaignsv2.CfnCampaign.OpenHoursProperty(
                daily_hours=[connectcampaignsv2.CfnCampaign.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2.CfnCampaign.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),

            # the properties below are optional
            restricted_periods=connectcampaignsv2.CfnCampaign.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2.CfnCampaign.RestrictedPeriodProperty(
                    end_date="endDate",
                    start_date="startDate",

                    # the properties below are optional
                    name="name"
                )]
            )
        ),
        sms=connectcampaignsv2.CfnCampaign.TimeWindowProperty(
            open_hours=connectcampaignsv2.CfnCampaign.OpenHoursProperty(
                daily_hours=[connectcampaignsv2.CfnCampaign.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2.CfnCampaign.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),

            # the properties below are optional
            restricted_periods=connectcampaignsv2.CfnCampaign.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2.CfnCampaign.RestrictedPeriodProperty(
                    end_date="endDate",
                    start_date="startDate",

                    # the properties below are optional
                    name="name"
                )]
            )
        ),
        telephony=connectcampaignsv2.CfnCampaign.TimeWindowProperty(
            open_hours=connectcampaignsv2.CfnCampaign.OpenHoursProperty(
                daily_hours=[connectcampaignsv2.CfnCampaign.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2.CfnCampaign.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),

            # the properties below are optional
            restricted_periods=connectcampaignsv2.CfnCampaign.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2.CfnCampaign.RestrictedPeriodProperty(
                    end_date="endDate",
                    start_date="startDate",

                    # the properties below are optional
                    name="name"
                )]
            )
        )
    ),
    connect_campaign_flow_arn="connectCampaignFlowArn",
    schedule=connectcampaignsv2.CfnCampaign.ScheduleProperty(
        end_time="endTime",
        start_time="startTime",

        # the properties below are optional
        refresh_frequency="refreshFrequency"
    ),
    source=connectcampaignsv2.CfnCampaign.SourceProperty(
        customer_profiles_segment_arn="customerProfilesSegmentArn",
        event_trigger=connectcampaignsv2.CfnCampaign.EventTriggerProperty(
            customer_profiles_domain_arn="customerProfilesDomainArn"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)