CfnCampaignPropsMixin

class aws_cdk.mixins_preview.aws_connectcampaignsv2.mixins.CfnCampaignPropsMixin(props, *, strategy=None)

Bases: 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.

See:

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

CloudformationResource:

AWS::ConnectCampaignsV2::Campaign

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

cfn_campaign_props_mixin = connectcampaignsv2_mixins.CfnCampaignPropsMixin(connectcampaignsv2_mixins.CfnCampaignMixinProps(
    channel_subtype_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ChannelSubtypeConfigProperty(
        email=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailChannelSubtypeConfigProperty(
            capacity=123,
            default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundConfigProperty(
                connect_source_email_address="connectSourceEmailAddress",
                source_email_address_display_name="sourceEmailAddressDisplayName",
                wisdom_template_arn="wisdomTemplateArn"
            ),
            outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundModeProperty(
                agentless_config=agentless_config
            )
        ),
        sms=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsChannelSubtypeConfigProperty(
            capacity=123,
            default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundConfigProperty(
                connect_source_phone_number_arn="connectSourcePhoneNumberArn",
                wisdom_template_arn="wisdomTemplateArn"
            ),
            outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundModeProperty(
                agentless_config=agentless_config
            )
        ),
        telephony=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyChannelSubtypeConfigProperty(
            capacity=123,
            connect_queue_id="connectQueueId",
            default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundConfigProperty(
                answer_machine_detection_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
                    await_answer_machine_prompt=False,
                    enable_answer_machine_detection=False
                ),
                connect_contact_flow_id="connectContactFlowId",
                connect_source_phone_number="connectSourcePhoneNumber",
                ring_timeout=123
            ),
            outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundModeProperty(
                agentless_config=agentless_config,
                predictive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PredictiveConfigProperty(
                    bandwidth_allocation=123
                ),
                preview_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PreviewConfigProperty(
                    agent_actions=["agentActions"],
                    bandwidth_allocation=123,
                    timeout_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
                        duration_in_seconds=123
                    )
                ),
                progressive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ProgressiveConfigProperty(
                    bandwidth_allocation=123
                )
            )
        )
    ),
    communication_limits_override=connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitsConfigProperty(
        all_channels_subtypes=connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitsProperty(
            communication_limit_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitProperty(
                frequency=123,
                max_count_per_recipient=123,
                unit="unit"
            )]
        ),
        instance_limits_handling="instanceLimitsHandling"
    ),
    communication_time_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationTimeConfigProperty(
        email=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
            open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
                daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),
            restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                    end_date="endDate",
                    name="name",
                    start_date="startDate"
                )]
            )
        ),
        local_time_zone_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.LocalTimeZoneConfigProperty(
            default_time_zone="defaultTimeZone",
            local_time_zone_detection=["localTimeZoneDetection"]
        ),
        sms=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
            open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
                daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),
            restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                    end_date="endDate",
                    name="name",
                    start_date="startDate"
                )]
            )
        ),
        telephony=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
            open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
                daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                    key="key",
                    value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                        end_time="endTime",
                        start_time="startTime"
                    )]
                )]
            ),
            restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
                restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                    end_date="endDate",
                    name="name",
                    start_date="startDate"
                )]
            )
        )
    ),
    connect_campaign_flow_arn="connectCampaignFlowArn",
    connect_instance_id="connectInstanceId",
    name="name",
    schedule=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ScheduleProperty(
        end_time="endTime",
        refresh_frequency="refreshFrequency",
        start_time="startTime"
    ),
    source=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SourceProperty(
        customer_profiles_segment_arn="customerProfilesSegmentArn",
        event_trigger=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EventTriggerProperty(
            customer_profiles_domain_arn="customerProfilesDomainArn"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnCampaignMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['channelSubtypeConfig', 'communicationLimitsOverride', 'communicationTimeConfig', 'connectCampaignFlowArn', 'connectInstanceId', 'name', 'schedule', 'source', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AnswerMachineDetectionConfigProperty

class CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(*, await_answer_machine_prompt=None, enable_answer_machine_detection=None)

Bases: object

Contains answering machine detection configuration.

Parameters:

  • await_answer_machine_prompt (Union[bool, IResolvable, None]) – Whether or not waiting for an answer machine prompt is enabled.

  • enable_answer_machine_detection (Union[bool, IResolvable, None]) – Enables answering machine detection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

answer_machine_detection_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
    await_answer_machine_prompt=False,
    enable_answer_machine_detection=False
)

Attributes

await_answer_machine_prompt

Whether or not waiting for an answer machine prompt is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.html#cfn-connectcampaignsv2-campaign-answermachinedetectionconfig-awaitanswermachineprompt

enable_answer_machine_detection

Enables answering machine detection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-answermachinedetectionconfig.html#cfn-connectcampaignsv2-campaign-answermachinedetectionconfig-enableanswermachinedetection

ChannelSubtypeConfigProperty

class CfnCampaignPropsMixin.ChannelSubtypeConfigProperty(*, email=None, sms=None, telephony=None)

Bases: object

Contains channel subtype configuration for an outbound campaign.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

channel_subtype_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.ChannelSubtypeConfigProperty(
    email=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailChannelSubtypeConfigProperty(
        capacity=123,
        default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundConfigProperty(
            connect_source_email_address="connectSourceEmailAddress",
            source_email_address_display_name="sourceEmailAddressDisplayName",
            wisdom_template_arn="wisdomTemplateArn"
        ),
        outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundModeProperty(
            agentless_config=agentless_config
        )
    ),
    sms=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsChannelSubtypeConfigProperty(
        capacity=123,
        default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundConfigProperty(
            connect_source_phone_number_arn="connectSourcePhoneNumberArn",
            wisdom_template_arn="wisdomTemplateArn"
        ),
        outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundModeProperty(
            agentless_config=agentless_config
        )
    ),
    telephony=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyChannelSubtypeConfigProperty(
        capacity=123,
        connect_queue_id="connectQueueId",
        default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundConfigProperty(
            answer_machine_detection_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
                await_answer_machine_prompt=False,
                enable_answer_machine_detection=False
            ),
            connect_contact_flow_id="connectContactFlowId",
            connect_source_phone_number="connectSourcePhoneNumber",
            ring_timeout=123
        ),
        outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundModeProperty(
            agentless_config=agentless_config,
            predictive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PredictiveConfigProperty(
                bandwidth_allocation=123
            ),
            preview_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PreviewConfigProperty(
                agent_actions=["agentActions"],
                bandwidth_allocation=123,
                timeout_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
                    duration_in_seconds=123
                )
            ),
            progressive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ProgressiveConfigProperty(
                bandwidth_allocation=123
            )
        )
    )
)

Attributes

email

The configuration of the email channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-email

sms

The configuration of the SMS channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-sms

telephony

The configuration of the telephony channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-channelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-channelsubtypeconfig-telephony

CommunicationLimitProperty

class CfnCampaignPropsMixin.CommunicationLimitProperty(*, frequency=None, max_count_per_recipient=None, unit=None)

Bases: object

Contains information about a communication limit.

Parameters:

  • frequency (Union[int, float, None]) – The frequency of communication limit evaluation.

  • max_count_per_recipient (Union[int, float, None]) – The maximum outreaching count for each recipient.

  • unit (Optional[str]) – The unit of communication limit evaluation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

communication_limit_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitProperty(
    frequency=123,
    max_count_per_recipient=123,
    unit="unit"
)

Attributes

frequency

The frequency of communication limit evaluation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-frequency

max_count_per_recipient

The maximum outreaching count for each recipient.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-maxcountperrecipient

unit

The unit of communication limit evaluation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimit.html#cfn-connectcampaignsv2-campaign-communicationlimit-unit

CommunicationLimitsConfigProperty

class CfnCampaignPropsMixin.CommunicationLimitsConfigProperty(*, all_channels_subtypes=None, instance_limits_handling=None)

Bases: object

Contains the communication limits configuration for an outbound campaign.

Parameters:

  • all_channels_subtypes (Union[IResolvable, CommunicationLimitsProperty, Dict[str, Any], None]) – The CommunicationLimits that apply to all channel subtypes defined in an outbound campaign.

  • instance_limits_handling (Optional[str]) – Opt-in or Opt-out from instance-level limits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimitsconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

communication_limits_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitsConfigProperty(
    all_channels_subtypes=connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitsProperty(
        communication_limit_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitProperty(
            frequency=123,
            max_count_per_recipient=123,
            unit="unit"
        )]
    ),
    instance_limits_handling="instanceLimitsHandling"
)

Attributes

all_channels_subtypes

The CommunicationLimits that apply to all channel subtypes defined in an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimitsconfig.html#cfn-connectcampaignsv2-campaign-communicationlimitsconfig-allchannelssubtypes

instance_limits_handling

Opt-in or Opt-out from instance-level limits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimitsconfig.html#cfn-connectcampaignsv2-campaign-communicationlimitsconfig-instancelimitshandling

CommunicationLimitsProperty

class CfnCampaignPropsMixin.CommunicationLimitsProperty(*, communication_limit_list=None)

Bases: object

Contains information about communication limits.

Parameters:

communication_limit_list (Union[IResolvable, Sequence[Union[IResolvable, CommunicationLimitProperty, Dict[str, Any]]], None]) – The list of CommunicationLimits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimits.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

communication_limits_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitsProperty(
    communication_limit_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationLimitProperty(
        frequency=123,
        max_count_per_recipient=123,
        unit="unit"
    )]
)

Attributes

communication_limit_list

The list of CommunicationLimits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationlimits.html#cfn-connectcampaignsv2-campaign-communicationlimits-communicationlimitlist

CommunicationTimeConfigProperty

class CfnCampaignPropsMixin.CommunicationTimeConfigProperty(*, email=None, local_time_zone_config=None, sms=None, telephony=None)

Bases: object

Communication time configuration for an outbound campaign.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

communication_time_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.CommunicationTimeConfigProperty(
    email=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
        open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
            daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                key="key",
                value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                    end_time="endTime",
                    start_time="startTime"
                )]
            )]
        ),
        restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
            restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                end_date="endDate",
                name="name",
                start_date="startDate"
            )]
        )
    ),
    local_time_zone_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.LocalTimeZoneConfigProperty(
        default_time_zone="defaultTimeZone",
        local_time_zone_detection=["localTimeZoneDetection"]
    ),
    sms=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
        open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
            daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                key="key",
                value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                    end_time="endTime",
                    start_time="startTime"
                )]
            )]
        ),
        restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
            restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                end_date="endDate",
                name="name",
                start_date="startDate"
            )]
        )
    ),
    telephony=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
        open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
            daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
                key="key",
                value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                    end_time="endTime",
                    start_time="startTime"
                )]
            )]
        ),
        restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
            restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
                end_date="endDate",
                name="name",
                start_date="startDate"
            )]
        )
    )
)

Attributes

email

The communication time configuration for the email channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-email

local_time_zone_config

The local timezone configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-localtimezoneconfig

sms

The communication time configuration for the SMS channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-sms

telephony

The communication time configuration for the telephony channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-communicationtimeconfig.html#cfn-connectcampaignsv2-campaign-communicationtimeconfig-telephony

DailyHourProperty

class CfnCampaignPropsMixin.DailyHourProperty(*, key=None, value=None)

Bases: object

The daily hours configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

daily_hour_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
    key="key",
    value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
        end_time="endTime",
        start_time="startTime"
    )]
)

Attributes

key

The key for DailyHour.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.html#cfn-connectcampaignsv2-campaign-dailyhour-key

value

The value for DailyHour.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-dailyhour.html#cfn-connectcampaignsv2-campaign-dailyhour-value

EmailChannelSubtypeConfigProperty

class CfnCampaignPropsMixin.EmailChannelSubtypeConfigProperty(*, capacity=None, default_outbound_config=None, outbound_mode=None)

Bases: object

The configuration for the email channel subtype.

Parameters:

  • capacity (Union[int, float, None]) – The allocation of email capacity between multiple running outbound campaigns.

  • default_outbound_config (Union[IResolvable, EmailOutboundConfigProperty, Dict[str, Any], None]) – The default email outbound configuration of an outbound campaign.

  • outbound_mode (Union[IResolvable, EmailOutboundModeProperty, Dict[str, Any], None]) – The outbound mode for email of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

email_channel_subtype_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailChannelSubtypeConfigProperty(
    capacity=123,
    default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundConfigProperty(
        connect_source_email_address="connectSourceEmailAddress",
        source_email_address_display_name="sourceEmailAddressDisplayName",
        wisdom_template_arn="wisdomTemplateArn"
    ),
    outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundModeProperty(
        agentless_config=agentless_config
    )
)

Attributes

capacity

The allocation of email capacity between multiple running outbound campaigns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-capacity

default_outbound_config

The default email outbound configuration of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-defaultoutboundconfig

outbound_mode

The outbound mode for email of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailchannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-emailchannelsubtypeconfig-outboundmode

EmailOutboundConfigProperty

class CfnCampaignPropsMixin.EmailOutboundConfigProperty(*, connect_source_email_address=None, source_email_address_display_name=None, wisdom_template_arn=None)

Bases: object

The outbound configuration for email.

Parameters:

  • connect_source_email_address (Optional[str]) – The Amazon Connect source email address.

  • source_email_address_display_name (Optional[str]) – The display name for the Amazon Connect source email address.

  • wisdom_template_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Q in Connect template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

email_outbound_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundConfigProperty(
    connect_source_email_address="connectSourceEmailAddress",
    source_email_address_display_name="sourceEmailAddressDisplayName",
    wisdom_template_arn="wisdomTemplateArn"
)

Attributes

connect_source_email_address

The Amazon Connect source email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-connectsourceemailaddress

source_email_address_display_name

The display name for the Amazon Connect source email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-sourceemailaddressdisplayname

wisdom_template_arn

The Amazon Resource Name (ARN) of the Amazon Q in Connect template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundconfig.html#cfn-connectcampaignsv2-campaign-emailoutboundconfig-wisdomtemplatearn

EmailOutboundModeProperty

class CfnCampaignPropsMixin.EmailOutboundModeProperty(*, agentless_config=None)

Bases: object

Contains information about email outbound mode.

Parameters:

agentless_config (Any) – The agentless outbound mode configuration for email.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundmode.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

email_outbound_mode_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.EmailOutboundModeProperty(
    agentless_config=agentless_config
)

Attributes

agentless_config

The agentless outbound mode configuration for email.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-emailoutboundmode.html#cfn-connectcampaignsv2-campaign-emailoutboundmode-agentlessconfig

EventTriggerProperty

class CfnCampaignPropsMixin.EventTriggerProperty(*, customer_profiles_domain_arn=None)

Bases: object

The event trigger of the campaign.

Parameters:

customer_profiles_domain_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Customer Profiles domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-eventtrigger.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

event_trigger_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.EventTriggerProperty(
    customer_profiles_domain_arn="customerProfilesDomainArn"
)

Attributes

customer_profiles_domain_arn

The Amazon Resource Name (ARN) of the Customer Profiles domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-eventtrigger.html#cfn-connectcampaignsv2-campaign-eventtrigger-customerprofilesdomainarn

LocalTimeZoneConfigProperty

class CfnCampaignPropsMixin.LocalTimeZoneConfigProperty(*, default_time_zone=None, local_time_zone_detection=None)

Bases: object

The configuration of timezone for recipient.

Parameters:

  • default_time_zone (Optional[str]) – The timezone to use for all recipients.

  • local_time_zone_detection (Optional[Sequence[str]]) – Detects methods for the recipient’s timezone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

local_time_zone_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.LocalTimeZoneConfigProperty(
    default_time_zone="defaultTimeZone",
    local_time_zone_detection=["localTimeZoneDetection"]
)

Attributes

default_time_zone

The timezone to use for all recipients.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.html#cfn-connectcampaignsv2-campaign-localtimezoneconfig-defaulttimezone

local_time_zone_detection

Detects methods for the recipient’s timezone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-localtimezoneconfig.html#cfn-connectcampaignsv2-campaign-localtimezoneconfig-localtimezonedetection

OpenHoursProperty

class CfnCampaignPropsMixin.OpenHoursProperty(*, daily_hours=None)

Bases: object

Contains information about open hours.

Parameters:

daily_hours (Union[IResolvable, Sequence[Union[IResolvable, DailyHourProperty, Dict[str, Any]]], None]) – The daily hours configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-openhours.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

open_hours_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
    daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
        key="key",
        value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
            end_time="endTime",
            start_time="startTime"
        )]
    )]
)

Attributes

daily_hours

The daily hours configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-openhours.html#cfn-connectcampaignsv2-campaign-openhours-dailyhours

PredictiveConfigProperty

class CfnCampaignPropsMixin.PredictiveConfigProperty(*, bandwidth_allocation=None)

Bases: object

Contains predictive outbound mode configuration.

Parameters:

bandwidth_allocation (Union[int, float, None]) – Bandwidth allocation for the predictive outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-predictiveconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

predictive_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.PredictiveConfigProperty(
    bandwidth_allocation=123
)

Attributes

bandwidth_allocation

Bandwidth allocation for the predictive outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-predictiveconfig.html#cfn-connectcampaignsv2-campaign-predictiveconfig-bandwidthallocation

PreviewConfigProperty

class CfnCampaignPropsMixin.PreviewConfigProperty(*, agent_actions=None, bandwidth_allocation=None, timeout_config=None)

Bases: object

Contains preview outbound mode configuration.

Parameters:

  • agent_actions (Optional[Sequence[str]]) – Agent actions for the preview outbound mode.

  • bandwidth_allocation (Union[int, float, None]) – Bandwidth allocation for the preview outbound mode.

  • timeout_config (Union[IResolvable, TimeoutConfigProperty, Dict[str, Any], None]) – Countdown timer configuration for preview outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-previewconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

preview_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.PreviewConfigProperty(
    agent_actions=["agentActions"],
    bandwidth_allocation=123,
    timeout_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
        duration_in_seconds=123
    )
)

Attributes

agent_actions

Agent actions for the preview outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-previewconfig.html#cfn-connectcampaignsv2-campaign-previewconfig-agentactions

bandwidth_allocation

Bandwidth allocation for the preview outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-previewconfig.html#cfn-connectcampaignsv2-campaign-previewconfig-bandwidthallocation

timeout_config

Countdown timer configuration for preview outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-previewconfig.html#cfn-connectcampaignsv2-campaign-previewconfig-timeoutconfig

ProgressiveConfigProperty

class CfnCampaignPropsMixin.ProgressiveConfigProperty(*, bandwidth_allocation=None)

Bases: object

Contains the progressive outbound mode configuration.

Parameters:

bandwidth_allocation (Union[int, float, None]) – Bandwidth allocation for the progressive outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-progressiveconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

progressive_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.ProgressiveConfigProperty(
    bandwidth_allocation=123
)

Attributes

bandwidth_allocation

Bandwidth allocation for the progressive outbound mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-progressiveconfig.html#cfn-connectcampaignsv2-campaign-progressiveconfig-bandwidthallocation

RestrictedPeriodProperty

class CfnCampaignPropsMixin.RestrictedPeriodProperty(*, end_date=None, name=None, start_date=None)

Bases: object

Contains information about a restricted period.

Parameters:

  • end_date (Optional[str]) – The end date of the restricted period.

  • name (Optional[str]) – The name of the restricted period.

  • start_date (Optional[str]) – The start date of the restricted period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

restricted_period_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
    end_date="endDate",
    name="name",
    start_date="startDate"
)

Attributes

end_date

The end date of the restricted period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-enddate

name

The name of the restricted period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-name

start_date

The start date of the restricted period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiod.html#cfn-connectcampaignsv2-campaign-restrictedperiod-startdate

RestrictedPeriodsProperty

class CfnCampaignPropsMixin.RestrictedPeriodsProperty(*, restricted_period_list=None)

Bases: object

Contains information about restricted periods.

Parameters:

restricted_period_list (Union[IResolvable, Sequence[Union[IResolvable, RestrictedPeriodProperty, Dict[str, Any]]], None]) – The restricted period list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiods.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

restricted_periods_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
    restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
        end_date="endDate",
        name="name",
        start_date="startDate"
    )]
)

Attributes

restricted_period_list

The restricted period list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-restrictedperiods.html#cfn-connectcampaignsv2-campaign-restrictedperiods-restrictedperiodlist

ScheduleProperty

class CfnCampaignPropsMixin.ScheduleProperty(*, end_time=None, refresh_frequency=None, start_time=None)

Bases: object

Contains the schedule configuration.

Parameters:

  • end_time (Optional[str]) – The end time of the schedule in UTC.

  • refresh_frequency (Optional[str]) – The refresh frequency of the campaign.

  • start_time (Optional[str]) – The start time of the schedule in UTC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

schedule_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.ScheduleProperty(
    end_time="endTime",
    refresh_frequency="refreshFrequency",
    start_time="startTime"
)

Attributes

end_time

The end time of the schedule in UTC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-endtime

refresh_frequency

The refresh frequency of the campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-refreshfrequency

start_time

The start time of the schedule in UTC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-schedule.html#cfn-connectcampaignsv2-campaign-schedule-starttime

SmsChannelSubtypeConfigProperty

class CfnCampaignPropsMixin.SmsChannelSubtypeConfigProperty(*, capacity=None, default_outbound_config=None, outbound_mode=None)

Bases: object

The configuration for the SMS channel subtype.

Parameters:

  • capacity (Union[int, float, None]) – The allocation of SMS capacity between multiple running outbound campaigns.

  • default_outbound_config (Union[IResolvable, SmsOutboundConfigProperty, Dict[str, Any], None]) – The default SMS outbound configuration of an outbound campaign.

  • outbound_mode (Union[IResolvable, SmsOutboundModeProperty, Dict[str, Any], None]) – The outbound mode of SMS for an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

sms_channel_subtype_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsChannelSubtypeConfigProperty(
    capacity=123,
    default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundConfigProperty(
        connect_source_phone_number_arn="connectSourcePhoneNumberArn",
        wisdom_template_arn="wisdomTemplateArn"
    ),
    outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundModeProperty(
        agentless_config=agentless_config
    )
)

Attributes

capacity

The allocation of SMS capacity between multiple running outbound campaigns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-capacity

default_outbound_config

The default SMS outbound configuration of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-defaultoutboundconfig

outbound_mode

The outbound mode of SMS for an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smschannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-smschannelsubtypeconfig-outboundmode

SmsOutboundConfigProperty

class CfnCampaignPropsMixin.SmsOutboundConfigProperty(*, connect_source_phone_number_arn=None, wisdom_template_arn=None)

Bases: object

The outbound configuration for SMS.

Parameters:

  • connect_source_phone_number_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Connect source SMS phone number.

  • wisdom_template_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Q in Connect template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

sms_outbound_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundConfigProperty(
    connect_source_phone_number_arn="connectSourcePhoneNumberArn",
    wisdom_template_arn="wisdomTemplateArn"
)

Attributes

connect_source_phone_number_arn

The Amazon Resource Name (ARN) of the Amazon Connect source SMS phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.html#cfn-connectcampaignsv2-campaign-smsoutboundconfig-connectsourcephonenumberarn

wisdom_template_arn

The Amazon Resource Name (ARN) of the Amazon Q in Connect template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundconfig.html#cfn-connectcampaignsv2-campaign-smsoutboundconfig-wisdomtemplatearn

SmsOutboundModeProperty

class CfnCampaignPropsMixin.SmsOutboundModeProperty(*, agentless_config=None)

Bases: object

Contains information about the SMS outbound mode.

Parameters:

agentless_config (Any) – Contains agentless outbound mode configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundmode.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

sms_outbound_mode_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.SmsOutboundModeProperty(
    agentless_config=agentless_config
)

Attributes

agentless_config

Contains agentless outbound mode configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-smsoutboundmode.html#cfn-connectcampaignsv2-campaign-smsoutboundmode-agentlessconfig

SourceProperty

class CfnCampaignPropsMixin.SourceProperty(*, customer_profiles_segment_arn=None, event_trigger=None)

Bases: object

Contains source configuration.

Parameters:

  • customer_profiles_segment_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Customer Profiles segment.

  • event_trigger (Union[IResolvable, EventTriggerProperty, Dict[str, Any], None]) – The event trigger of the campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-source.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

source_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.SourceProperty(
    customer_profiles_segment_arn="customerProfilesSegmentArn",
    event_trigger=connectcampaignsv2_mixins.CfnCampaignPropsMixin.EventTriggerProperty(
        customer_profiles_domain_arn="customerProfilesDomainArn"
    )
)

Attributes

customer_profiles_segment_arn

The Amazon Resource Name (ARN) of the Customer Profiles segment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-source.html#cfn-connectcampaignsv2-campaign-source-customerprofilessegmentarn

event_trigger

The event trigger of the campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-source.html#cfn-connectcampaignsv2-campaign-source-eventtrigger

TelephonyChannelSubtypeConfigProperty

class CfnCampaignPropsMixin.TelephonyChannelSubtypeConfigProperty(*, capacity=None, connect_queue_id=None, default_outbound_config=None, outbound_mode=None)

Bases: object

The configuration for the telephony channel subtype.

Parameters:

  • capacity (Union[int, float, None]) – The allocation of telephony capacity between multiple running outbound campaigns.

  • connect_queue_id (Optional[str]) – The identifier of the Amazon Connect queue associated with telephony outbound requests of an outbound campaign.

  • default_outbound_config (Union[IResolvable, TelephonyOutboundConfigProperty, Dict[str, Any], None]) – The default telephony outbound configuration of an outbound campaign.

  • outbound_mode (Union[IResolvable, TelephonyOutboundModeProperty, Dict[str, Any], None]) – The outbound mode of telephony for an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

telephony_channel_subtype_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyChannelSubtypeConfigProperty(
    capacity=123,
    connect_queue_id="connectQueueId",
    default_outbound_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundConfigProperty(
        answer_machine_detection_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
            await_answer_machine_prompt=False,
            enable_answer_machine_detection=False
        ),
        connect_contact_flow_id="connectContactFlowId",
        connect_source_phone_number="connectSourcePhoneNumber",
        ring_timeout=123
    ),
    outbound_mode=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundModeProperty(
        agentless_config=agentless_config,
        predictive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PredictiveConfigProperty(
            bandwidth_allocation=123
        ),
        preview_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PreviewConfigProperty(
            agent_actions=["agentActions"],
            bandwidth_allocation=123,
            timeout_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
                duration_in_seconds=123
            )
        ),
        progressive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ProgressiveConfigProperty(
            bandwidth_allocation=123
        )
    )
)

Attributes

capacity

The allocation of telephony capacity between multiple running outbound campaigns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-capacity

connect_queue_id

The identifier of the Amazon Connect queue associated with telephony outbound requests of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-connectqueueid

default_outbound_config

The default telephony outbound configuration of an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-defaultoutboundconfig

outbound_mode

The outbound mode of telephony for an outbound campaign.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonychannelsubtypeconfig.html#cfn-connectcampaignsv2-campaign-telephonychannelsubtypeconfig-outboundmode

TelephonyOutboundConfigProperty

class CfnCampaignPropsMixin.TelephonyOutboundConfigProperty(*, answer_machine_detection_config=None, connect_contact_flow_id=None, connect_source_phone_number=None, ring_timeout=None)

Bases: object

The outbound configuration for telephony.

Parameters:

  • answer_machine_detection_config (Union[IResolvable, AnswerMachineDetectionConfigProperty, Dict[str, Any], None]) – The answering machine detection configuration.

  • connect_contact_flow_id (Optional[str]) – The identifier of the published Amazon Connect contact flow.

  • connect_source_phone_number (Optional[str]) – The Amazon Connect source phone number.

  • ring_timeout (Union[int, float, None]) – Maximum ring time for outbound calls in seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

telephony_outbound_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundConfigProperty(
    answer_machine_detection_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
        await_answer_machine_prompt=False,
        enable_answer_machine_detection=False
    ),
    connect_contact_flow_id="connectContactFlowId",
    connect_source_phone_number="connectSourcePhoneNumber",
    ring_timeout=123
)

Attributes

answer_machine_detection_config

The answering machine detection configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-answermachinedetectionconfig

connect_contact_flow_id

The identifier of the published Amazon Connect contact flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-connectcontactflowid

connect_source_phone_number

The Amazon Connect source phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-connectsourcephonenumber

ring_timeout

Maximum ring time for outbound calls in seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundconfig.html#cfn-connectcampaignsv2-campaign-telephonyoutboundconfig-ringtimeout

TelephonyOutboundModeProperty

class CfnCampaignPropsMixin.TelephonyOutboundModeProperty(*, agentless_config=None, predictive_config=None, preview_config=None, progressive_config=None)

Bases: object

Contains information about telephony outbound mode.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

# agentless_config: Any

telephony_outbound_mode_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TelephonyOutboundModeProperty(
    agentless_config=agentless_config,
    predictive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PredictiveConfigProperty(
        bandwidth_allocation=123
    ),
    preview_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.PreviewConfigProperty(
        agent_actions=["agentActions"],
        bandwidth_allocation=123,
        timeout_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
            duration_in_seconds=123
        )
    ),
    progressive_config=connectcampaignsv2_mixins.CfnCampaignPropsMixin.ProgressiveConfigProperty(
        bandwidth_allocation=123
    )
)

Attributes

agentless_config

The agentless outbound mode configuration for telephony.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-agentlessconfig

predictive_config

Contains predictive outbound mode configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-predictiveconfig

preview_config

Contains preview outbound mode configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-previewconfig

progressive_config

Contains progressive telephony outbound mode configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-telephonyoutboundmode.html#cfn-connectcampaignsv2-campaign-telephonyoutboundmode-progressiveconfig

TimeRangeProperty

class CfnCampaignPropsMixin.TimeRangeProperty(*, end_time=None, start_time=None)

Bases: object

Contains information about a time range.

Parameters:

  • end_time (Optional[str]) – The end time of the time range.

  • start_time (Optional[str]) – The start time of the time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

time_range_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
    end_time="endTime",
    start_time="startTime"
)

Attributes

end_time

The end time of the time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.html#cfn-connectcampaignsv2-campaign-timerange-endtime

start_time

The start time of the time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timerange.html#cfn-connectcampaignsv2-campaign-timerange-starttime

TimeWindowProperty

class CfnCampaignPropsMixin.TimeWindowProperty(*, open_hours=None, restricted_periods=None)

Bases: object

Contains information about a time window.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

time_window_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeWindowProperty(
    open_hours=connectcampaignsv2_mixins.CfnCampaignPropsMixin.OpenHoursProperty(
        daily_hours=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.DailyHourProperty(
            key="key",
            value=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeRangeProperty(
                end_time="endTime",
                start_time="startTime"
            )]
        )]
    ),
    restricted_periods=connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodsProperty(
        restricted_period_list=[connectcampaignsv2_mixins.CfnCampaignPropsMixin.RestrictedPeriodProperty(
            end_date="endDate",
            name="name",
            start_date="startDate"
        )]
    )
)

Attributes

open_hours

The open hours configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.html#cfn-connectcampaignsv2-campaign-timewindow-openhours

restricted_periods

The restricted periods configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timewindow.html#cfn-connectcampaignsv2-campaign-timewindow-restrictedperiods

TimeoutConfigProperty

class CfnCampaignPropsMixin.TimeoutConfigProperty(*, duration_in_seconds=None)

Bases: object

Contains preview outbound mode timeout configuration.

Parameters:

duration_in_seconds (Union[int, float, None]) – Duration in seconds for the countdown timer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timeoutconfig.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.mixins_preview.aws_connectcampaignsv2 import mixins as connectcampaignsv2_mixins

timeout_config_property = connectcampaignsv2_mixins.CfnCampaignPropsMixin.TimeoutConfigProperty(
    duration_in_seconds=123
)

Attributes

duration_in_seconds

Duration in seconds for the countdown timer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaignsv2-campaign-timeoutconfig.html#cfn-connectcampaignsv2-campaign-timeoutconfig-durationinseconds