This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon Connect Outbound Campaigns
<a name="AWS_ConnectCampaigns"></a>

**Resource types**
+ [AWS::ConnectCampaigns::Campaign](aws-resource-connectcampaigns-campaign.md)

# AWS::ConnectCampaigns::Campaign
<a name="aws-resource-connectcampaigns-campaign"></a>

Contains information about an outbound campaign.

## Syntax
<a name="aws-resource-connectcampaigns-campaign-syntax"></a>

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

### JSON
<a name="aws-resource-connectcampaigns-campaign-syntax.json"></a>

```
{
  "Type" : "AWS::ConnectCampaigns::Campaign",
  "Properties" : {
      "[ConnectInstanceArn](#cfn-connectcampaigns-campaign-connectinstancearn)" : String,
      "[DialerConfig](#cfn-connectcampaigns-campaign-dialerconfig)" : DialerConfig,
      "[Name](#cfn-connectcampaigns-campaign-name)" : String,
      "[OutboundCallConfig](#cfn-connectcampaigns-campaign-outboundcallconfig)" : OutboundCallConfig,
      "[Tags](#cfn-connectcampaigns-campaign-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-connectcampaigns-campaign-syntax.yaml"></a>

```
Type: AWS::ConnectCampaigns::Campaign
Properties:
  [ConnectInstanceArn](#cfn-connectcampaigns-campaign-connectinstancearn): String
  [DialerConfig](#cfn-connectcampaigns-campaign-dialerconfig): 
    DialerConfig
  [Name](#cfn-connectcampaigns-campaign-name): String
  [OutboundCallConfig](#cfn-connectcampaigns-campaign-outboundcallconfig): 
    OutboundCallConfig
  [Tags](#cfn-connectcampaigns-campaign-tags): 
    - Tag
```

## Properties
<a name="aws-resource-connectcampaigns-campaign-properties"></a>

`ConnectInstanceArn`  <a name="cfn-connectcampaigns-campaign-connectinstancearn"></a>
The Amazon Resource Name (ARN) of the Amazon Connect instance.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DialerConfig`  <a name="cfn-connectcampaigns-campaign-dialerconfig"></a>
Contains information about the dialer configuration.  
*Required*: Yes  
*Type*: [DialerConfig](aws-properties-connectcampaigns-campaign-dialerconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-connectcampaigns-campaign-name"></a>
The name of the campaign.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutboundCallConfig`  <a name="cfn-connectcampaigns-campaign-outboundcallconfig"></a>
Contains information about the outbound call configuration.  
*Required*: Yes  
*Type*: [OutboundCallConfig](aws-properties-connectcampaigns-campaign-outboundcallconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-connectcampaigns-campaign-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-connectcampaigns-campaign-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-connectcampaigns-campaign-return-values"></a>

### Ref
<a name="aws-resource-connectcampaigns-campaign-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the campaign name. For example:

 `{ "Ref": "myCampaignName" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-connectcampaigns-campaign-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-connectcampaigns-campaign-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the high-volume outbound campaign.

# AWS::ConnectCampaigns::Campaign AgentlessDialerConfig
<a name="aws-properties-connectcampaigns-campaign-agentlessdialerconfig"></a>

Contains agentless dialer configuration for an outbound campaign.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-agentlessdialerconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-agentlessdialerconfig-syntax.json"></a>

```
{
  "[DialingCapacity](#cfn-connectcampaigns-campaign-agentlessdialerconfig-dialingcapacity)" : Number
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-agentlessdialerconfig-syntax.yaml"></a>

```
  [DialingCapacity](#cfn-connectcampaigns-campaign-agentlessdialerconfig-dialingcapacity): Number
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-agentlessdialerconfig-properties"></a>

`DialingCapacity`  <a name="cfn-connectcampaigns-campaign-agentlessdialerconfig-dialingcapacity"></a>
The allocation of dialing capacity between multiple active campaigns.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign AnswerMachineDetectionConfig
<a name="aws-properties-connectcampaigns-campaign-answermachinedetectionconfig"></a>

Contains information about answering machine detection.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-answermachinedetectionconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-answermachinedetectionconfig-syntax.json"></a>

```
{
  "[AwaitAnswerMachinePrompt](#cfn-connectcampaigns-campaign-answermachinedetectionconfig-awaitanswermachineprompt)" : Boolean,
  "[EnableAnswerMachineDetection](#cfn-connectcampaigns-campaign-answermachinedetectionconfig-enableanswermachinedetection)" : Boolean
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-answermachinedetectionconfig-syntax.yaml"></a>

```
  [AwaitAnswerMachinePrompt](#cfn-connectcampaigns-campaign-answermachinedetectionconfig-awaitanswermachineprompt): Boolean
  [EnableAnswerMachineDetection](#cfn-connectcampaigns-campaign-answermachinedetectionconfig-enableanswermachinedetection): Boolean
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-answermachinedetectionconfig-properties"></a>

`AwaitAnswerMachinePrompt`  <a name="cfn-connectcampaigns-campaign-answermachinedetectionconfig-awaitanswermachineprompt"></a>
Whether waiting for answer machine prompt is enabled.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableAnswerMachineDetection`  <a name="cfn-connectcampaigns-campaign-answermachinedetectionconfig-enableanswermachinedetection"></a>
Whether answering machine detection is enabled.   
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign DialerConfig
<a name="aws-properties-connectcampaigns-campaign-dialerconfig"></a>

Contains dialer configuration for an outbound campaign.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-dialerconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-dialerconfig-syntax.json"></a>

```
{
  "[AgentlessDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-agentlessdialerconfig)" : AgentlessDialerConfig,
  "[PredictiveDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-predictivedialerconfig)" : PredictiveDialerConfig,
  "[ProgressiveDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-progressivedialerconfig)" : ProgressiveDialerConfig
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-dialerconfig-syntax.yaml"></a>

```
  [AgentlessDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-agentlessdialerconfig): 
    AgentlessDialerConfig
  [PredictiveDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-predictivedialerconfig): 
    PredictiveDialerConfig
  [ProgressiveDialerConfig](#cfn-connectcampaigns-campaign-dialerconfig-progressivedialerconfig): 
    ProgressiveDialerConfig
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-dialerconfig-properties"></a>

`AgentlessDialerConfig`  <a name="cfn-connectcampaigns-campaign-dialerconfig-agentlessdialerconfig"></a>
The configuration of the agentless dialer.  
*Required*: No  
*Type*: [AgentlessDialerConfig](aws-properties-connectcampaigns-campaign-agentlessdialerconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PredictiveDialerConfig`  <a name="cfn-connectcampaigns-campaign-dialerconfig-predictivedialerconfig"></a>
The configuration of the predictive dialer.  
*Required*: No  
*Type*: [PredictiveDialerConfig](aws-properties-connectcampaigns-campaign-predictivedialerconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProgressiveDialerConfig`  <a name="cfn-connectcampaigns-campaign-dialerconfig-progressivedialerconfig"></a>
The configuration of the progressive dialer.  
*Required*: No  
*Type*: [ProgressiveDialerConfig](aws-properties-connectcampaigns-campaign-progressivedialerconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign OutboundCallConfig
<a name="aws-properties-connectcampaigns-campaign-outboundcallconfig"></a>

Contains outbound call configuration for an outbound campaign.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-outboundcallconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-outboundcallconfig-syntax.json"></a>

```
{
  "[AnswerMachineDetectionConfig](#cfn-connectcampaigns-campaign-outboundcallconfig-answermachinedetectionconfig)" : AnswerMachineDetectionConfig,
  "[ConnectContactFlowArn](#cfn-connectcampaigns-campaign-outboundcallconfig-connectcontactflowarn)" : String,
  "[ConnectQueueArn](#cfn-connectcampaigns-campaign-outboundcallconfig-connectqueuearn)" : String,
  "[ConnectSourcePhoneNumber](#cfn-connectcampaigns-campaign-outboundcallconfig-connectsourcephonenumber)" : String
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-outboundcallconfig-syntax.yaml"></a>

```
  [AnswerMachineDetectionConfig](#cfn-connectcampaigns-campaign-outboundcallconfig-answermachinedetectionconfig): 
    AnswerMachineDetectionConfig
  [ConnectContactFlowArn](#cfn-connectcampaigns-campaign-outboundcallconfig-connectcontactflowarn): String
  [ConnectQueueArn](#cfn-connectcampaigns-campaign-outboundcallconfig-connectqueuearn): String
  [ConnectSourcePhoneNumber](#cfn-connectcampaigns-campaign-outboundcallconfig-connectsourcephonenumber): String
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-outboundcallconfig-properties"></a>

`AnswerMachineDetectionConfig`  <a name="cfn-connectcampaigns-campaign-outboundcallconfig-answermachinedetectionconfig"></a>
Whether answering machine detection has been enabled.  
*Required*: No  
*Type*: [AnswerMachineDetectionConfig](aws-properties-connectcampaigns-campaign-answermachinedetectionconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectContactFlowArn`  <a name="cfn-connectcampaigns-campaign-outboundcallconfig-connectcontactflowarn"></a>
The Amazon Resource Name (ARN) of the flow.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectQueueArn`  <a name="cfn-connectcampaigns-campaign-outboundcallconfig-connectqueuearn"></a>
The Amazon Resource Name (ARN) of the queue.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/queue/[-a-zA-Z0-9]*$`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectSourcePhoneNumber`  <a name="cfn-connectcampaigns-campaign-outboundcallconfig-connectsourcephonenumber"></a>
The phone number associated with the outbound call. This is the caller ID that is displayed to customers when an agent calls them.  
*Required*: No  
*Type*: String  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign PredictiveDialerConfig
<a name="aws-properties-connectcampaigns-campaign-predictivedialerconfig"></a>

Contains predictive dialer configuration for an outbound campaign.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-predictivedialerconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-predictivedialerconfig-syntax.json"></a>

```
{
  "[BandwidthAllocation](#cfn-connectcampaigns-campaign-predictivedialerconfig-bandwidthallocation)" : Number,
  "[DialingCapacity](#cfn-connectcampaigns-campaign-predictivedialerconfig-dialingcapacity)" : Number
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-predictivedialerconfig-syntax.yaml"></a>

```
  [BandwidthAllocation](#cfn-connectcampaigns-campaign-predictivedialerconfig-bandwidthallocation): Number
  [DialingCapacity](#cfn-connectcampaigns-campaign-predictivedialerconfig-dialingcapacity): Number
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-predictivedialerconfig-properties"></a>

`BandwidthAllocation`  <a name="cfn-connectcampaigns-campaign-predictivedialerconfig-bandwidthallocation"></a>
Bandwidth allocation for the predictive dialer.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DialingCapacity`  <a name="cfn-connectcampaigns-campaign-predictivedialerconfig-dialingcapacity"></a>
The allocation of dialing capacity between multiple active campaigns.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign ProgressiveDialerConfig
<a name="aws-properties-connectcampaigns-campaign-progressivedialerconfig"></a>

Contains progressive dialer configuration for an outbound campaign.

## Syntax
<a name="aws-properties-connectcampaigns-campaign-progressivedialerconfig-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-progressivedialerconfig-syntax.json"></a>

```
{
  "[BandwidthAllocation](#cfn-connectcampaigns-campaign-progressivedialerconfig-bandwidthallocation)" : Number,
  "[DialingCapacity](#cfn-connectcampaigns-campaign-progressivedialerconfig-dialingcapacity)" : Number
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-progressivedialerconfig-syntax.yaml"></a>

```
  [BandwidthAllocation](#cfn-connectcampaigns-campaign-progressivedialerconfig-bandwidthallocation): Number
  [DialingCapacity](#cfn-connectcampaigns-campaign-progressivedialerconfig-dialingcapacity): Number
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-progressivedialerconfig-properties"></a>

`BandwidthAllocation`  <a name="cfn-connectcampaigns-campaign-progressivedialerconfig-bandwidthallocation"></a>
Bandwidth allocation for the progressive dialer.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DialingCapacity`  <a name="cfn-connectcampaigns-campaign-progressivedialerconfig-dialingcapacity"></a>
The allocation of dialing capacity between multiple active campaigns.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ConnectCampaigns::Campaign Tag
<a name="aws-properties-connectcampaigns-campaign-tag"></a>

<a name="aws-properties-connectcampaigns-campaign-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::ConnectCampaigns::Campaign](aws-resource-connectcampaigns-campaign.md).

## Syntax
<a name="aws-properties-connectcampaigns-campaign-tag-syntax"></a>

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

### JSON
<a name="aws-properties-connectcampaigns-campaign-tag-syntax.json"></a>

```
{
  "[Key](#cfn-connectcampaigns-campaign-tag-key)" : String,
  "[Value](#cfn-connectcampaigns-campaign-tag-value)" : String
}
```

### YAML
<a name="aws-properties-connectcampaigns-campaign-tag-syntax.yaml"></a>

```
  [Key](#cfn-connectcampaigns-campaign-tag-key): String
  [Value](#cfn-connectcampaigns-campaign-tag-value): String
```

## Properties
<a name="aws-properties-connectcampaigns-campaign-tag-properties"></a>

`Key`  <a name="cfn-connectcampaigns-campaign-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-connectcampaigns-campaign-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)