CfnCampaign

class aws_cdk.aws_connectcampaignsv2.CfnCampaign(scope, id, *, 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: CfnResource

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
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 = connectcampaignsv2.CfnCampaign(self, "MyCfnCampaign",
    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"
            ),
            outbound_mode=connectcampaignsv2.CfnCampaign.TelephonyOutboundModeProperty(
                agentless_config=agentless_config,
                predictive_config=connectcampaignsv2.CfnCampaign.PredictiveConfigProperty(
                    bandwidth_allocation=123
                ),
                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"
            )]
        )
    ),
    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"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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"} } .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ConnectCampaignsV2::Campaign'

attr_arn

The Amazon Resource Name (ARN).

CloudformationAttribute:: Arn

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

channel_subtype_config: Contains channel subtype configuration for an outbound campaign.

communication_limits_override: Communication limits configuration for an outbound campaign.

communication_time_config: Contains communication time configuration for an outbound campaign.

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

connect_instance_id: The identifier of the Amazon Connect instance.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the outbound campaign.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schedule: Contains the schedule configuration.

source: Contains source configuration.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AnswerMachineDetectionConfigProperty

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

Bases: object

Contains answering machine detection configuration.

Parameters:

enable_answer_machine_detection (Union[bool, IResolvable]) – Enables answering machine detection.
await_answer_machine_prompt (Union[bool, IResolvable, None]) – 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

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

answer_machine_detection_config_property = connectcampaignsv2.CfnCampaign.AnswerMachineDetectionConfigProperty(
    enable_answer_machine_detection=False,

    # the properties below are optional
    await_answer_machine_prompt=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 CfnCampaign.ChannelSubtypeConfigProperty(*, email=None, sms=None, telephony=None)

Bases: object

Contains channel subtype configuration for an outbound campaign.

Parameters:

email (Union[IResolvable, EmailChannelSubtypeConfigProperty, Dict[str, Any], None]) – The configuration of the email channel subtype.
sms (Union[IResolvable, SmsChannelSubtypeConfigProperty, Dict[str, Any], None]) – The configuration of the SMS channel subtype.
telephony (Union[IResolvable, TelephonyChannelSubtypeConfigProperty, Dict[str, Any], None]) – The configuration of the telephony channel subtype.

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 import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

channel_subtype_config_property = 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"
        ),
        outbound_mode=connectcampaignsv2.CfnCampaign.TelephonyOutboundModeProperty(
            agentless_config=agentless_config,
            predictive_config=connectcampaignsv2.CfnCampaign.PredictiveConfigProperty(
                bandwidth_allocation=123
            ),
            progressive_config=connectcampaignsv2.CfnCampaign.ProgressiveConfigProperty(
                bandwidth_allocation=123
            )
        ),

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

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 CfnCampaign.CommunicationLimitProperty(*, frequency, max_count_per_recipient, unit)

Bases: object

Contains information about a communication limit.

Parameters:

frequency (Union[int, float]) – The frequency of communication limit evaluation.
max_count_per_recipient (Union[int, float]) – The maximum outreaching count for each recipient.
unit (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 import aws_connectcampaignsv2 as connectcampaignsv2

communication_limit_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.CommunicationLimitsConfigProperty(*, all_channels_subtypes=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.
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 import aws_connectcampaignsv2 as connectcampaignsv2

communication_limits_config_property = connectcampaignsv2.CfnCampaign.CommunicationLimitsConfigProperty(
    all_channels_subtypes=connectcampaignsv2.CfnCampaign.CommunicationLimitsProperty(
        communication_limit_list=[connectcampaignsv2.CfnCampaign.CommunicationLimitProperty(
            frequency=123,
            max_count_per_recipient=123,
            unit="unit"
        )]
    )
)

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

CommunicationLimitsProperty

class CfnCampaign.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 import aws_connectcampaignsv2 as connectcampaignsv2

communication_limits_property = connectcampaignsv2.CfnCampaign.CommunicationLimitsProperty(
    communication_limit_list=[connectcampaignsv2.CfnCampaign.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 CfnCampaign.CommunicationTimeConfigProperty(*, local_time_zone_config, email=None, sms=None, telephony=None)

Bases: object

Communication time configuration for an outbound campaign.

Parameters:

local_time_zone_config (Union[IResolvable, LocalTimeZoneConfigProperty, Dict[str, Any]]) – The local timezone configuration.
email (Union[IResolvable, TimeWindowProperty, Dict[str, Any], None]) – The communication time configuration for the email channel subtype.
sms (Union[IResolvable, TimeWindowProperty, Dict[str, Any], None]) – The communication time configuration for the SMS channel subtype.
telephony (Union[IResolvable, TimeWindowProperty, Dict[str, Any], None]) – The communication time configuration for the telephony channel subtype.

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 import aws_connectcampaignsv2 as connectcampaignsv2

communication_time_config_property = 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"
            )]
        )
    )
)

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 CfnCampaign.DailyHourProperty(*, key=None, value=None)

Bases: object

The daily hours configuration.

Parameters:

key (Optional[str]) – The key for DailyHour.
value (Union[IResolvable, Sequence[Union[IResolvable, TimeRangeProperty, Dict[str, Any]]], None]) – The value for DailyHour.

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 import aws_connectcampaignsv2 as connectcampaignsv2

daily_hour_property = connectcampaignsv2.CfnCampaign.DailyHourProperty(
    key="key",
    value=[connectcampaignsv2.CfnCampaign.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 CfnCampaign.EmailChannelSubtypeConfigProperty(*, default_outbound_config, outbound_mode, capacity=None)

Bases: object

The configuration for the email channel subtype.

Parameters:

default_outbound_config (Union[IResolvable, EmailOutboundConfigProperty, Dict[str, Any]]) – The default email outbound configuration of an outbound campaign.
outbound_mode (Union[IResolvable, EmailOutboundModeProperty, Dict[str, Any]]) – The outbound mode for email of an outbound campaign.
capacity (Union[int, float, None]) – 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

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

email_channel_subtype_config_property = 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
)

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 CfnCampaign.EmailOutboundConfigProperty(*, connect_source_email_address, wisdom_template_arn, source_email_address_display_name=None)

Bases: object

The outbound configuration for email.

Parameters:

connect_source_email_address (str) – The Amazon Connect source email address.
wisdom_template_arn (str) – The Amazon Resource Name (ARN) of the Amazon Q in Connect template.
source_email_address_display_name (Optional[str]) – 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

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

email_outbound_config_property = connectcampaignsv2.CfnCampaign.EmailOutboundConfigProperty(
    connect_source_email_address="connectSourceEmailAddress",
    wisdom_template_arn="wisdomTemplateArn",

    # the properties below are optional
    source_email_address_display_name="sourceEmailAddressDisplayName"
)

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 CfnCampaign.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 import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

email_outbound_mode_property = connectcampaignsv2.CfnCampaign.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

LocalTimeZoneConfigProperty

class CfnCampaign.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 import aws_connectcampaignsv2 as connectcampaignsv2

local_time_zone_config_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.OpenHoursProperty(*, daily_hours)

Bases: object

Contains information about open hours.

Parameters:: daily_hours (Union[IResolvable, Sequence[Union[IResolvable, DailyHourProperty, Dict[str, Any]]]]) – 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 import aws_connectcampaignsv2 as connectcampaignsv2

open_hours_property = connectcampaignsv2.CfnCampaign.OpenHoursProperty(
    daily_hours=[connectcampaignsv2.CfnCampaign.DailyHourProperty(
        key="key",
        value=[connectcampaignsv2.CfnCampaign.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 CfnCampaign.PredictiveConfigProperty(*, bandwidth_allocation)

Bases: object

Contains predictive outbound mode configuration.

Parameters:: bandwidth_allocation (Union[int, float]) – 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 import aws_connectcampaignsv2 as connectcampaignsv2

predictive_config_property = connectcampaignsv2.CfnCampaign.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

ProgressiveConfigProperty

class CfnCampaign.ProgressiveConfigProperty(*, bandwidth_allocation)

Bases: object

Contains the progressive outbound mode configuration.

Parameters:: bandwidth_allocation (Union[int, float]) – 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 import aws_connectcampaignsv2 as connectcampaignsv2

progressive_config_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.RestrictedPeriodProperty(*, end_date, start_date, name=None)

Bases: object

Contains information about a restricted period.

Parameters:

end_date (str) – The end date of the restricted period.
start_date (str) – The start date of the restricted period.
name (Optional[str]) – The name 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 import aws_connectcampaignsv2 as connectcampaignsv2

restricted_period_property = connectcampaignsv2.CfnCampaign.RestrictedPeriodProperty(
    end_date="endDate",
    start_date="startDate",

    # the properties below are optional
    name="name"
)

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 CfnCampaign.RestrictedPeriodsProperty(*, restricted_period_list)

Bases: object

Contains information about restricted periods.

Parameters:: restricted_period_list (Union[IResolvable, Sequence[Union[IResolvable, RestrictedPeriodProperty, Dict[str, Any]]]]) – 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 import aws_connectcampaignsv2 as connectcampaignsv2

restricted_periods_property = connectcampaignsv2.CfnCampaign.RestrictedPeriodsProperty(
    restricted_period_list=[connectcampaignsv2.CfnCampaign.RestrictedPeriodProperty(
        end_date="endDate",
        start_date="startDate",

        # the properties below are optional
        name="name"
    )]
)

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 CfnCampaign.ScheduleProperty(*, end_time, start_time, refresh_frequency=None)

Bases: object

Contains the schedule configuration.

Parameters:

end_time (str) – The end time of the schedule in UTC.
start_time (str) – The start time of the schedule in UTC.
refresh_frequency (Optional[str]) – The refresh frequency of the campaign.

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 import aws_connectcampaignsv2 as connectcampaignsv2

schedule_property = connectcampaignsv2.CfnCampaign.ScheduleProperty(
    end_time="endTime",
    start_time="startTime",

    # the properties below are optional
    refresh_frequency="refreshFrequency"
)

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 CfnCampaign.SmsChannelSubtypeConfigProperty(*, default_outbound_config, outbound_mode, capacity=None)

Bases: object

The configuration for the SMS channel subtype.

Parameters:

default_outbound_config (Union[IResolvable, SmsOutboundConfigProperty, Dict[str, Any]]) – The default SMS outbound configuration of an outbound campaign.
outbound_mode (Union[IResolvable, SmsOutboundModeProperty, Dict[str, Any]]) – The outbound mode of SMS for an outbound campaign.
capacity (Union[int, float, None]) – 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

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

sms_channel_subtype_config_property = 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
)

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 CfnCampaign.SmsOutboundConfigProperty(*, connect_source_phone_number_arn, wisdom_template_arn)

Bases: object

The outbound configuration for SMS.

Parameters:

connect_source_phone_number_arn (str) – The Amazon Resource Name (ARN) of the Amazon Connect source SMS phone number.
wisdom_template_arn (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 import aws_connectcampaignsv2 as connectcampaignsv2

sms_outbound_config_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.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 import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

sms_outbound_mode_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.SourceProperty(*, customer_profiles_segment_arn)

Bases: object

Contains source configuration.

Parameters:: customer_profiles_segment_arn (str) – 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
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

source_property = connectcampaignsv2.CfnCampaign.SourceProperty(
    customer_profiles_segment_arn="customerProfilesSegmentArn"
)

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

TelephonyChannelSubtypeConfigProperty

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

Bases: object

The configuration for the telephony channel subtype.

Parameters:

default_outbound_config (Union[IResolvable, TelephonyOutboundConfigProperty, Dict[str, Any]]) – The default telephony outbound configuration of an outbound campaign.
outbound_mode (Union[IResolvable, TelephonyOutboundModeProperty, Dict[str, Any]]) – The outbound mode of telephony for an outbound campaign.
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.

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 import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

telephony_channel_subtype_config_property = 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"
    ),
    outbound_mode=connectcampaignsv2.CfnCampaign.TelephonyOutboundModeProperty(
        agentless_config=agentless_config,
        predictive_config=connectcampaignsv2.CfnCampaign.PredictiveConfigProperty(
            bandwidth_allocation=123
        ),
        progressive_config=connectcampaignsv2.CfnCampaign.ProgressiveConfigProperty(
            bandwidth_allocation=123
        )
    ),

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

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 CfnCampaign.TelephonyOutboundConfigProperty(*, connect_contact_flow_id, answer_machine_detection_config=None, connect_source_phone_number=None)

Bases: object

The outbound configuration for telephony.

Parameters:

connect_contact_flow_id (str) – The identifier of the published Amazon Connect contact flow.
answer_machine_detection_config (Union[IResolvable, AnswerMachineDetectionConfigProperty, Dict[str, Any], None]) – The answering machine detection configuration.
connect_source_phone_number (Optional[str]) – The Amazon Connect source phone number.

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 import aws_connectcampaignsv2 as connectcampaignsv2

telephony_outbound_config_property = 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"
)

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

TelephonyOutboundModeProperty

class CfnCampaign.TelephonyOutboundModeProperty(*, agentless_config=None, predictive_config=None, progressive_config=None)

Bases: object

Contains information about telephony outbound mode.

Parameters:

agentless_config (Any) – The agentless outbound mode configuration for telephony.
predictive_config (Union[IResolvable, PredictiveConfigProperty, Dict[str, Any], None]) – Contains predictive outbound mode configuration.
progressive_config (Union[IResolvable, ProgressiveConfigProperty, Dict[str, Any], None]) – Contains progressive telephony outbound mode configuration.

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 import aws_connectcampaignsv2 as connectcampaignsv2

# agentless_config: Any

telephony_outbound_mode_property = connectcampaignsv2.CfnCampaign.TelephonyOutboundModeProperty(
    agentless_config=agentless_config,
    predictive_config=connectcampaignsv2.CfnCampaign.PredictiveConfigProperty(
        bandwidth_allocation=123
    ),
    progressive_config=connectcampaignsv2.CfnCampaign.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

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 CfnCampaign.TimeRangeProperty(*, end_time, start_time)

Bases: object

Contains information about a time range.

Parameters:

end_time (str) – The end time of the time range.
start_time (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 import aws_connectcampaignsv2 as connectcampaignsv2

time_range_property = connectcampaignsv2.CfnCampaign.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 CfnCampaign.TimeWindowProperty(*, open_hours, restricted_periods=None)

Bases: object

Contains information about a time window.

Parameters:

open_hours (Union[IResolvable, OpenHoursProperty, Dict[str, Any]]) – The open hours configuration.
restricted_periods (Union[IResolvable, RestrictedPeriodsProperty, Dict[str, Any], None]) – The restricted periods configuration.

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 import aws_connectcampaignsv2 as connectcampaignsv2

time_window_property = 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"
        )]
    )
)

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