AWS Native is in preview. AWS Classic is fully supported.
aws-native.connectcampaigns.Campaign
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Definition of AWS::ConnectCampaigns::Campaign Resource Type
Create Campaign Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Campaign(name: string, args: CampaignArgs, opts?: CustomResourceOptions);
@overload
def Campaign(resource_name: str,
args: CampaignArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Campaign(resource_name: str,
opts: Optional[ResourceOptions] = None,
connect_instance_arn: Optional[str] = None,
dialer_config: Optional[CampaignDialerConfigArgs] = None,
outbound_call_config: Optional[CampaignOutboundCallConfigArgs] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewCampaign(ctx *Context, name string, args CampaignArgs, opts ...ResourceOption) (*Campaign, error)
public Campaign(string name, CampaignArgs args, CustomResourceOptions? opts = null)
public Campaign(String name, CampaignArgs args)
public Campaign(String name, CampaignArgs args, CustomResourceOptions options)
type: aws-native:connectcampaigns:Campaign
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CampaignArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CampaignArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CampaignArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CampaignArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CampaignArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const campaignResource = new aws_native.connectcampaigns.Campaign("campaignResource", {
connectInstanceArn: "string",
dialerConfig: {
agentlessDialerConfig: {
dialingCapacity: 0,
},
predictiveDialerConfig: {
bandwidthAllocation: 0,
dialingCapacity: 0,
},
progressiveDialerConfig: {
bandwidthAllocation: 0,
dialingCapacity: 0,
},
},
outboundCallConfig: {
connectContactFlowArn: "string",
answerMachineDetectionConfig: {
enableAnswerMachineDetection: false,
},
connectQueueArn: "string",
connectSourcePhoneNumber: "string",
},
name: "string",
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
Campaign Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Campaign resource accepts the following input properties:
- Connect
Instance stringArn - Amazon Connect Instance Arn
- Dialer
Config Pulumi.Aws Native. Connect Campaigns. Inputs. Campaign Dialer Config - Outbound
Call Pulumi.Config Aws Native. Connect Campaigns. Inputs. Campaign Outbound Call Config - Name string
- Amazon Connect Campaign Name
- List<Pulumi.
Aws Native. Inputs. Tag> - One or more tags.
- Connect
Instance stringArn - Amazon Connect Instance Arn
- Dialer
Config CampaignDialer Config Args - Outbound
Call CampaignConfig Outbound Call Config Args - Name string
- Amazon Connect Campaign Name
- Tag
Args - One or more tags.
- connect
Instance StringArn - Amazon Connect Instance Arn
- dialer
Config CampaignDialer Config - outbound
Call CampaignConfig Outbound Call Config - name String
- Amazon Connect Campaign Name
- List<Tag>
- One or more tags.
- connect
Instance stringArn - Amazon Connect Instance Arn
- dialer
Config CampaignDialer Config - outbound
Call CampaignConfig Outbound Call Config - name string
- Amazon Connect Campaign Name
- Tag[]
- One or more tags.
- connect_
instance_ strarn - Amazon Connect Instance Arn
- dialer_
config CampaignDialer Config Args - outbound_
call_ Campaignconfig Outbound Call Config Args - name str
- Amazon Connect Campaign Name
- Sequence[Tag
Args] - One or more tags.
- connect
Instance StringArn - Amazon Connect Instance Arn
- dialer
Config Property Map - outbound
Call Property MapConfig - name String
- Amazon Connect Campaign Name
- List<Property Map>
- One or more tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Campaign resource produces the following output properties:
Supporting Types
CampaignAgentlessDialerConfig, CampaignAgentlessDialerConfigArgs
- Dialing
Capacity double - Allocates dialing capacity for this campaign between multiple active campaigns.
- Dialing
Capacity float64 - Allocates dialing capacity for this campaign between multiple active campaigns.
- dialing
Capacity Double - Allocates dialing capacity for this campaign between multiple active campaigns.
- dialing
Capacity number - Allocates dialing capacity for this campaign between multiple active campaigns.
- dialing_
capacity float - Allocates dialing capacity for this campaign between multiple active campaigns.
- dialing
Capacity Number - Allocates dialing capacity for this campaign between multiple active campaigns.
CampaignAnswerMachineDetectionConfig, CampaignAnswerMachineDetectionConfigArgs
- Enable
Answer boolMachine Detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
- Enable
Answer boolMachine Detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
- enable
Answer BooleanMachine Detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
- enable
Answer booleanMachine Detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
- enable_
answer_ boolmachine_ detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
- enable
Answer BooleanMachine Detection - Flag to decided whether outbound calls should have answering machine detection enabled or not
CampaignDialerConfig, CampaignDialerConfigArgs
CampaignOutboundCallConfig, CampaignOutboundCallConfigArgs
- Connect
Contact stringFlow Arn - The identifier of the contact flow for the outbound call.
- Answer
Machine Pulumi.Detection Config Aws Native. Connect Campaigns. Inputs. Campaign Answer Machine Detection Config - Connect
Queue stringArn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- Connect
Source stringPhone Number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
- Connect
Contact stringFlow Arn - The identifier of the contact flow for the outbound call.
- Answer
Machine CampaignDetection Config Answer Machine Detection Config - Connect
Queue stringArn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- Connect
Source stringPhone Number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
- connect
Contact StringFlow Arn - The identifier of the contact flow for the outbound call.
- answer
Machine CampaignDetection Config Answer Machine Detection Config - connect
Queue StringArn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- connect
Source StringPhone Number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
- connect
Contact stringFlow Arn - The identifier of the contact flow for the outbound call.
- answer
Machine CampaignDetection Config Answer Machine Detection Config - connect
Queue stringArn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- connect
Source stringPhone Number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
- connect_
contact_ strflow_ arn - The identifier of the contact flow for the outbound call.
- answer_
machine_ Campaigndetection_ config Answer Machine Detection Config - connect_
queue_ strarn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- connect_
source_ strphone_ number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
- connect
Contact StringFlow Arn - The identifier of the contact flow for the outbound call.
- answer
Machine Property MapDetection Config - connect
Queue StringArn - The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
- connect
Source StringPhone Number - The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
CampaignPredictiveDialerConfig, CampaignPredictiveDialerConfigArgs
- Bandwidth
Allocation double - The bandwidth allocation of a queue resource.
- Dialing
Capacity double - Allocates dialing capacity for this campaign between multiple active campaigns.
- Bandwidth
Allocation float64 - The bandwidth allocation of a queue resource.
- Dialing
Capacity float64 - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation Double - The bandwidth allocation of a queue resource.
- dialing
Capacity Double - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation number - The bandwidth allocation of a queue resource.
- dialing
Capacity number - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth_
allocation float - The bandwidth allocation of a queue resource.
- dialing_
capacity float - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation Number - The bandwidth allocation of a queue resource.
- dialing
Capacity Number - Allocates dialing capacity for this campaign between multiple active campaigns.
CampaignProgressiveDialerConfig, CampaignProgressiveDialerConfigArgs
- Bandwidth
Allocation double - The bandwidth allocation of a queue resource.
- Dialing
Capacity double - Allocates dialing capacity for this campaign between multiple active campaigns.
- Bandwidth
Allocation float64 - The bandwidth allocation of a queue resource.
- Dialing
Capacity float64 - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation Double - The bandwidth allocation of a queue resource.
- dialing
Capacity Double - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation number - The bandwidth allocation of a queue resource.
- dialing
Capacity number - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth_
allocation float - The bandwidth allocation of a queue resource.
- dialing_
capacity float - Allocates dialing capacity for this campaign between multiple active campaigns.
- bandwidth
Allocation Number - The bandwidth allocation of a queue resource.
- dialing
Capacity Number - Allocates dialing capacity for this campaign between multiple active campaigns.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.