AWS::ConnectCampaignsV2::Campaign - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ConnectCampaignsV2::Campaign

Creates an outbound campaign.

Note

  • 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ConnectCampaignsV2::Campaign",
  "Properties" : {
      "ChannelSubtypeConfig" : ChannelSubtypeConfig,
      "CommunicationLimitsOverride" : CommunicationLimitsConfig,
      "CommunicationTimeConfig" : CommunicationTimeConfig,
      "ConnectCampaignFlowArn" : String,
      "ConnectInstanceId" : String,
      "Name" : String,
      "Schedule" : Schedule,
      "Source" : Source,
      "Tags" : [ Tag, ... ]
    }
}

Properties

ChannelSubtypeConfig

Contains channel subtype configuration for an outbound campaign.

Required: Yes

Type: ChannelSubtypeConfig

Update requires: No interruption

CommunicationLimitsOverride

Communication limits configuration for an outbound campaign.

Required: No

Type: CommunicationLimitsConfig

Update requires: No interruption

CommunicationTimeConfig

Contains communication time configuration for an outbound campaign.

Required: No

Type: CommunicationTimeConfig

Update requires: No interruption

ConnectCampaignFlowArn

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

Required: No

Type: String

Pattern: ^arn:.*$

Minimum: 20

Maximum: 500

Update requires: No interruption

ConnectInstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_\-.]*$

Minimum: 0

Maximum: 256

Update requires: Replacement

Name

The name of the outbound campaign.

Required: Yes

Type: String

Minimum: 1

Maximum: 127

Update requires: No interruption

Schedule

Contains the schedule configuration.

Required: No

Type: Schedule

Update requires: No interruption

Source

Contains source configuration.

Required: No

Type: Source

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN).