CfnCampaignProps

class aws_cdk.aws_connectcampaigns.CfnCampaignProps(*, connect_instance_arn, dialer_config, name, outbound_call_config, tags=None)

Bases: object

Properties for defining a CfnCampaign.

Parameters:
  • connect_instance_arn (str) – The Amazon Resource Name (ARN) of the Amazon Connect instance.

  • dialer_config (Union[IResolvable, DialerConfigProperty, Dict[str, Any]]) – Contains information about the dialer configuration.

  • name (str) – The name of the campaign.

  • outbound_call_config (Union[IResolvable, OutboundCallConfigProperty, Dict[str, Any]]) – Contains information about the outbound call 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-connectcampaigns-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_connectcampaigns as connectcampaigns

cfn_campaign_props = connectcampaigns.CfnCampaignProps(
    connect_instance_arn="connectInstanceArn",
    dialer_config=connectcampaigns.CfnCampaign.DialerConfigProperty(
        agentless_dialer_config=connectcampaigns.CfnCampaign.AgentlessDialerConfigProperty(
            dialing_capacity=123
        ),
        predictive_dialer_config=connectcampaigns.CfnCampaign.PredictiveDialerConfigProperty(
            bandwidth_allocation=123,

            # the properties below are optional
            dialing_capacity=123
        ),
        progressive_dialer_config=connectcampaigns.CfnCampaign.ProgressiveDialerConfigProperty(
            bandwidth_allocation=123,

            # the properties below are optional
            dialing_capacity=123
        )
    ),
    name="name",
    outbound_call_config=connectcampaigns.CfnCampaign.OutboundCallConfigProperty(
        connect_contact_flow_arn="connectContactFlowArn",

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

            # the properties below are optional
            await_answer_machine_prompt=False
        ),
        connect_queue_arn="connectQueueArn",
        connect_source_phone_number="connectSourcePhoneNumber"
    ),

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

connect_instance_arn

The Amazon Resource Name (ARN) of the Amazon Connect instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaigns-campaign.html#cfn-connectcampaigns-campaign-connectinstancearn

dialer_config

Contains information about the dialer configuration.

See:

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

name

The name of the campaign.

See:

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

outbound_call_config

Contains information about the outbound call configuration.

See:

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

tags

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-connectcampaigns-campaign.html#cfn-connectcampaigns-campaign-tags