We recommend new projects start with resources from the AWS provider.
aws-native.connectcampaignsv2.Campaign
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::ConnectCampaignsV2::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,
             channel_subtype_config: Optional[CampaignChannelSubtypeConfigArgs] = None,
             connect_instance_id: Optional[str] = None,
             communication_limits_override: Optional[CampaignCommunicationLimitsConfigArgs] = None,
             communication_time_config: Optional[CampaignCommunicationTimeConfigArgs] = None,
             connect_campaign_flow_arn: Optional[str] = None,
             name: Optional[str] = None,
             schedule: Optional[CampaignScheduleArgs] = None,
             source: Optional[CampaignSourceArgs] = 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:connectcampaignsv2: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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Campaign resource accepts the following input properties:
- ChannelSubtype Pulumi.Config Aws Native. Connect Campaigns V2. Inputs. Campaign Channel Subtype Config 
- ConnectInstance stringId 
- CommunicationLimits Pulumi.Override Aws Native. Connect Campaigns V2. Inputs. Campaign Communication Limits Config 
- CommunicationTime Pulumi.Config Aws Native. Connect Campaigns V2. Inputs. Campaign Communication Time Config 
- ConnectCampaign stringFlow Arn 
- Name string
- Schedule
Pulumi.Aws Native. Connect Campaigns V2. Inputs. Campaign Schedule 
- Source
Pulumi.Aws Native. Connect Campaigns V2. Inputs. Campaign Source 
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- One or more tags.
- ChannelSubtype CampaignConfig Channel Subtype Config Args 
- ConnectInstance stringId 
- CommunicationLimits CampaignOverride Communication Limits Config Args 
- CommunicationTime CampaignConfig Communication Time Config Args 
- ConnectCampaign stringFlow Arn 
- Name string
- Schedule
CampaignSchedule Args 
- Source
CampaignSource Args 
- 
TagArgs 
- One or more tags.
- channelSubtype CampaignConfig Channel Subtype Config 
- connectInstance StringId 
- communicationLimits CampaignOverride Communication Limits Config 
- communicationTime CampaignConfig Communication Time Config 
- connectCampaign StringFlow Arn 
- name String
- schedule
CampaignSchedule 
- source
CampaignSource 
- List<Tag>
- One or more tags.
- channel_subtype_ Campaignconfig Channel Subtype Config Args 
- connect_instance_ strid 
- communication_limits_ Campaignoverride Communication Limits Config Args 
- communication_time_ Campaignconfig Communication Time Config Args 
- connect_campaign_ strflow_ arn 
- name str
- schedule
CampaignSchedule Args 
- source
CampaignSource Args 
- 
Sequence[TagArgs] 
- 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
CampaignAnswerMachineDetectionConfig, CampaignAnswerMachineDetectionConfigArgs          
- EnableAnswer boolMachine Detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- AwaitAnswer boolMachine Prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
- EnableAnswer boolMachine Detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- AwaitAnswer boolMachine Prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
- enableAnswer BooleanMachine Detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- awaitAnswer BooleanMachine Prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
- enableAnswer booleanMachine Detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- awaitAnswer booleanMachine Prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
- enable_answer_ boolmachine_ detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- await_answer_ boolmachine_ prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
- enableAnswer BooleanMachine Detection 
- Flag to decided whether outbound calls should have answering machine detection enabled or not
- awaitAnswer BooleanMachine Prompt 
- Enables detection of prompts (e.g., beep after after a voicemail greeting)
CampaignChannelSubtypeConfig, CampaignChannelSubtypeConfigArgs        
CampaignCommunicationLimit, CampaignCommunicationLimitArgs      
- frequency Integer
- maxCount IntegerPer Recipient 
- unit
CampaignCommunication Limit Time Unit 
- frequency Number
- maxCount NumberPer Recipient 
- unit "DAY"
CampaignCommunicationLimitTimeUnit, CampaignCommunicationLimitTimeUnitArgs          
- Day
- DAY
- CampaignCommunication Limit Time Unit Day 
- DAY
- Day
- DAY
- Day
- DAY
- DAY
- DAY
- "DAY"
- DAY
CampaignCommunicationLimits, CampaignCommunicationLimitsArgs      
CampaignCommunicationLimitsConfig, CampaignCommunicationLimitsConfigArgs        
CampaignCommunicationTimeConfig, CampaignCommunicationTimeConfigArgs        
CampaignDailyHour, CampaignDailyHourArgs      
CampaignDayOfWeek, CampaignDayOfWeekArgs        
- Monday
- MONDAY
- Tuesday
- TUESDAY
- Wednesday
- WEDNESDAY
- Thursday
- THURSDAY
- Friday
- FRIDAY
- Saturday
- SATURDAY
- Sunday
- SUNDAY
- CampaignDay Of Week Monday 
- MONDAY
- CampaignDay Of Week Tuesday 
- TUESDAY
- CampaignDay Of Week Wednesday 
- WEDNESDAY
- CampaignDay Of Week Thursday 
- THURSDAY
- CampaignDay Of Week Friday 
- FRIDAY
- CampaignDay Of Week Saturday 
- SATURDAY
- CampaignDay Of Week Sunday 
- SUNDAY
- Monday
- MONDAY
- Tuesday
- TUESDAY
- Wednesday
- WEDNESDAY
- Thursday
- THURSDAY
- Friday
- FRIDAY
- Saturday
- SATURDAY
- Sunday
- SUNDAY
- Monday
- MONDAY
- Tuesday
- TUESDAY
- Wednesday
- WEDNESDAY
- Thursday
- THURSDAY
- Friday
- FRIDAY
- Saturday
- SATURDAY
- Sunday
- SUNDAY
- MONDAY
- MONDAY
- TUESDAY
- TUESDAY
- WEDNESDAY
- WEDNESDAY
- THURSDAY
- THURSDAY
- FRIDAY
- FRIDAY
- SATURDAY
- SATURDAY
- SUNDAY
- SUNDAY
- "MONDAY"
- MONDAY
- "TUESDAY"
- TUESDAY
- "WEDNESDAY"
- WEDNESDAY
- "THURSDAY"
- THURSDAY
- "FRIDAY"
- FRIDAY
- "SATURDAY"
- SATURDAY
- "SUNDAY"
- SUNDAY
CampaignEmailChannelSubtypeConfig, CampaignEmailChannelSubtypeConfigArgs          
CampaignEmailOutboundConfig, CampaignEmailOutboundConfigArgs        
- ConnectSource stringEmail Address 
- WisdomTemplate stringArn 
- SourceEmail stringAddress Display Name 
- ConnectSource stringEmail Address 
- WisdomTemplate stringArn 
- SourceEmail stringAddress Display Name 
- connectSource StringEmail Address 
- wisdomTemplate StringArn 
- sourceEmail StringAddress Display Name 
- connectSource stringEmail Address 
- wisdomTemplate stringArn 
- sourceEmail stringAddress Display Name 
- connectSource StringEmail Address 
- wisdomTemplate StringArn 
- sourceEmail StringAddress Display Name 
CampaignEmailOutboundMode, CampaignEmailOutboundModeArgs        
CampaignLocalTimeZoneConfig, CampaignLocalTimeZoneConfigArgs          
CampaignLocalTimeZoneDetectionType, CampaignLocalTimeZoneDetectionTypeArgs            
- ZipCode 
- ZIP_CODE
- AreaCode 
- AREA_CODE
- CampaignLocal Time Zone Detection Type Zip Code 
- ZIP_CODE
- CampaignLocal Time Zone Detection Type Area Code 
- AREA_CODE
- ZipCode 
- ZIP_CODE
- AreaCode 
- AREA_CODE
- ZipCode 
- ZIP_CODE
- AreaCode 
- AREA_CODE
- ZIP_CODE
- ZIP_CODE
- AREA_CODE
- AREA_CODE
- "ZIP_CODE"
- ZIP_CODE
- "AREA_CODE"
- AREA_CODE
CampaignOpenHours, CampaignOpenHoursArgs      
CampaignPredictiveConfig, CampaignPredictiveConfigArgs      
- BandwidthAllocation double
- BandwidthAllocation float64
- bandwidthAllocation Double
- bandwidthAllocation number
- bandwidth_allocation float
- bandwidthAllocation Number
CampaignProgressiveConfig, CampaignProgressiveConfigArgs      
- BandwidthAllocation double
- BandwidthAllocation float64
- bandwidthAllocation Double
- bandwidthAllocation number
- bandwidth_allocation float
- bandwidthAllocation Number
CampaignRestrictedPeriod, CampaignRestrictedPeriodArgs      
- end_date str
- start_date str
- name str
- The name of a restricted period
CampaignRestrictedPeriods, CampaignRestrictedPeriodsArgs      
CampaignSchedule, CampaignScheduleArgs    
- EndTime string
- StartTime string
- RefreshFrequency string
- EndTime string
- StartTime string
- RefreshFrequency string
- endTime String
- startTime String
- refreshFrequency String
- endTime string
- startTime string
- refreshFrequency string
- end_time str
- start_time str
- refresh_frequency str
- endTime String
- startTime String
- refreshFrequency String
CampaignSmsChannelSubtypeConfig, CampaignSmsChannelSubtypeConfigArgs          
CampaignSmsOutboundConfig, CampaignSmsOutboundConfigArgs        
- ConnectSource stringPhone Number Arn 
- WisdomTemplate stringArn 
- ConnectSource stringPhone Number Arn 
- WisdomTemplate stringArn 
- connectSource StringPhone Number Arn 
- wisdomTemplate StringArn 
- connectSource stringPhone Number Arn 
- wisdomTemplate stringArn 
- connectSource StringPhone Number Arn 
- wisdomTemplate StringArn 
CampaignSmsOutboundMode, CampaignSmsOutboundModeArgs        
CampaignSource, CampaignSourceArgs    
- CustomerProfiles stringSegment Arn 
- CustomerProfiles stringSegment Arn 
- customerProfiles StringSegment Arn 
- customerProfiles stringSegment Arn 
- customerProfiles StringSegment Arn 
CampaignTelephonyChannelSubtypeConfig, CampaignTelephonyChannelSubtypeConfigArgs          
CampaignTelephonyOutboundConfig, CampaignTelephonyOutboundConfigArgs        
CampaignTelephonyOutboundMode, CampaignTelephonyOutboundModeArgs        
CampaignTimeRange, CampaignTimeRangeArgs      
- end_time str
- start_time str
CampaignTimeWindow, CampaignTimeWindowArgs      
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.