CfnCampaignPropsMixin

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

Bases: Mixin

Contains information about an outbound campaign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaigns-campaign.html
CloudformationResource:: AWS::ConnectCampaigns::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_connectcampaigns import mixins as connectcampaigns_mixins

cfn_campaign_props_mixin = connectcampaigns_mixins.CfnCampaignPropsMixin(connectcampaigns_mixins.CfnCampaignMixinProps(
    connect_instance_arn="connectInstanceArn",
    dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.DialerConfigProperty(
        agentless_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.AgentlessDialerConfigProperty(
            dialing_capacity=123
        ),
        predictive_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.PredictiveDialerConfigProperty(
            bandwidth_allocation=123,
            dialing_capacity=123
        ),
        progressive_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.ProgressiveDialerConfigProperty(
            bandwidth_allocation=123,
            dialing_capacity=123
        )
    ),
    name="name",
    outbound_call_config=connectcampaigns_mixins.CfnCampaignPropsMixin.OutboundCallConfigProperty(
        answer_machine_detection_config=connectcampaigns_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
            await_answer_machine_prompt=False,
            enable_answer_machine_detection=False
        ),
        connect_contact_flow_arn="connectContactFlowArn",
        connect_queue_arn="connectQueueArn",
        connect_source_phone_number="connectSourcePhoneNumber"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ConnectCampaigns::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 = ['connectInstanceArn', 'dialerConfig', 'name', 'outboundCallConfig', '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

AgentlessDialerConfigProperty

class CfnCampaignPropsMixin.AgentlessDialerConfigProperty(*, dialing_capacity=None)

Bases: object

Contains agentless dialer configuration for an outbound campaign.

Parameters:: dialing_capacity (Union[int, float, None]) – The allocation of dialing capacity between multiple active campaigns.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-agentlessdialerconfig.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_connectcampaigns import mixins as connectcampaigns_mixins

agentless_dialer_config_property = connectcampaigns_mixins.CfnCampaignPropsMixin.AgentlessDialerConfigProperty(
    dialing_capacity=123
)

Attributes

dialing_capacity

The allocation of dialing capacity between multiple active campaigns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-agentlessdialerconfig.html#cfn-connectcampaigns-campaign-agentlessdialerconfig-dialingcapacity

AnswerMachineDetectionConfigProperty

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

Bases: object

Contains information about answering machine detection.

Parameters:

await_answer_machine_prompt (Union[bool, IResolvable, None]) – Whether waiting for answer machine prompt is enabled.
enable_answer_machine_detection (Union[bool, IResolvable, None]) – Whether answering machine detection is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-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_connectcampaigns import mixins as connectcampaigns_mixins

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

Attributes

await_answer_machine_prompt

Whether waiting for answer machine prompt is enabled.

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

enable_answer_machine_detection

Whether answering machine detection is enabled.

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

DialerConfigProperty

class CfnCampaignPropsMixin.DialerConfigProperty(*, agentless_dialer_config=None, predictive_dialer_config=None, progressive_dialer_config=None)

Bases: object

Contains dialer configuration for an outbound campaign.

Parameters:

agentless_dialer_config (Union[IResolvable, AgentlessDialerConfigProperty, Dict[str, Any], None]) – The configuration of the agentless dialer.
predictive_dialer_config (Union[IResolvable, PredictiveDialerConfigProperty, Dict[str, Any], None]) – The configuration of the predictive dialer.
progressive_dialer_config (Union[IResolvable, ProgressiveDialerConfigProperty, Dict[str, Any], None]) – The configuration of the progressive dialer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.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_connectcampaigns import mixins as connectcampaigns_mixins

dialer_config_property = connectcampaigns_mixins.CfnCampaignPropsMixin.DialerConfigProperty(
    agentless_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.AgentlessDialerConfigProperty(
        dialing_capacity=123
    ),
    predictive_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.PredictiveDialerConfigProperty(
        bandwidth_allocation=123,
        dialing_capacity=123
    ),
    progressive_dialer_config=connectcampaigns_mixins.CfnCampaignPropsMixin.ProgressiveDialerConfigProperty(
        bandwidth_allocation=123,
        dialing_capacity=123
    )
)

Attributes

agentless_dialer_config

The configuration of the agentless dialer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html#cfn-connectcampaigns-campaign-dialerconfig-agentlessdialerconfig

predictive_dialer_config

The configuration of the predictive dialer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html#cfn-connectcampaigns-campaign-dialerconfig-predictivedialerconfig

progressive_dialer_config

The configuration of the progressive dialer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html#cfn-connectcampaigns-campaign-dialerconfig-progressivedialerconfig

OutboundCallConfigProperty

class CfnCampaignPropsMixin.OutboundCallConfigProperty(*, answer_machine_detection_config=None, connect_contact_flow_arn=None, connect_queue_arn=None, connect_source_phone_number=None)

Bases: object

Contains outbound call configuration for an outbound campaign.

Parameters:

answer_machine_detection_config (Union[IResolvable, AnswerMachineDetectionConfigProperty, Dict[str, Any], None]) – Whether answering machine detection has been enabled.
connect_contact_flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the flow.
connect_queue_arn (Optional[str]) – The Amazon Resource Name (ARN) of the queue.
connect_source_phone_number (Optional[str]) – The phone number associated with the outbound call. This is the caller ID that is displayed to customers when an agent calls them.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.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_connectcampaigns import mixins as connectcampaigns_mixins

outbound_call_config_property = connectcampaigns_mixins.CfnCampaignPropsMixin.OutboundCallConfigProperty(
    answer_machine_detection_config=connectcampaigns_mixins.CfnCampaignPropsMixin.AnswerMachineDetectionConfigProperty(
        await_answer_machine_prompt=False,
        enable_answer_machine_detection=False
    ),
    connect_contact_flow_arn="connectContactFlowArn",
    connect_queue_arn="connectQueueArn",
    connect_source_phone_number="connectSourcePhoneNumber"
)

Attributes

answer_machine_detection_config

Whether answering machine detection has been enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html#cfn-connectcampaigns-campaign-outboundcallconfig-answermachinedetectionconfig

connect_contact_flow_arn

The Amazon Resource Name (ARN) of the flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html#cfn-connectcampaigns-campaign-outboundcallconfig-connectcontactflowarn

connect_queue_arn

The Amazon Resource Name (ARN) of the queue.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html#cfn-connectcampaigns-campaign-outboundcallconfig-connectqueuearn

connect_source_phone_number

The phone number associated with the outbound call.

This is the caller ID that is displayed to customers when an agent calls them.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html#cfn-connectcampaigns-campaign-outboundcallconfig-connectsourcephonenumber

PredictiveDialerConfigProperty

class CfnCampaignPropsMixin.PredictiveDialerConfigProperty(*, bandwidth_allocation=None, dialing_capacity=None)

Bases: object

Contains predictive dialer configuration for an outbound campaign.

Parameters:

bandwidth_allocation (Union[int, float, None]) – Bandwidth allocation for the predictive dialer.
dialing_capacity (Union[int, float, None]) – The allocation of dialing capacity between multiple active campaigns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.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_connectcampaigns import mixins as connectcampaigns_mixins

predictive_dialer_config_property = connectcampaigns_mixins.CfnCampaignPropsMixin.PredictiveDialerConfigProperty(
    bandwidth_allocation=123,
    dialing_capacity=123
)

Attributes

bandwidth_allocation

Bandwidth allocation for the predictive dialer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.html#cfn-connectcampaigns-campaign-predictivedialerconfig-bandwidthallocation

dialing_capacity

The allocation of dialing capacity between multiple active campaigns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.html#cfn-connectcampaigns-campaign-predictivedialerconfig-dialingcapacity

ProgressiveDialerConfigProperty

class CfnCampaignPropsMixin.ProgressiveDialerConfigProperty(*, bandwidth_allocation=None, dialing_capacity=None)

Bases: object

Contains progressive dialer configuration for an outbound campaign.

Parameters:

bandwidth_allocation (Union[int, float, None]) – Bandwidth allocation for the progressive dialer.
dialing_capacity (Union[int, float, None]) – The allocation of dialing capacity between multiple active campaigns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.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_connectcampaigns import mixins as connectcampaigns_mixins

progressive_dialer_config_property = connectcampaigns_mixins.CfnCampaignPropsMixin.ProgressiveDialerConfigProperty(
    bandwidth_allocation=123,
    dialing_capacity=123
)

Attributes

bandwidth_allocation

Bandwidth allocation for the progressive dialer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.html#cfn-connectcampaigns-campaign-progressivedialerconfig-bandwidthallocation

dialing_capacity

The allocation of dialing capacity between multiple active campaigns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.html#cfn-connectcampaigns-campaign-progressivedialerconfig-dialingcapacity