1. Packages
  2. AWS Native
  3. API Docs
  4. connectcampaigns
  5. Campaign

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.connectcampaigns.Campaign

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    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:

    ConnectInstanceArn string
    Amazon Connect Instance Arn
    DialerConfig CampaignDialerConfigArgs
    OutboundCallConfig CampaignOutboundCallConfigArgs
    Name string
    Amazon Connect Campaign Name
    Tags TagArgs
    One or more tags.
    connectInstanceArn String
    Amazon Connect Instance Arn
    dialerConfig CampaignDialerConfig
    outboundCallConfig CampaignOutboundCallConfig
    name String
    Amazon Connect Campaign Name
    tags List<Tag>
    One or more tags.
    connectInstanceArn string
    Amazon Connect Instance Arn
    dialerConfig CampaignDialerConfig
    outboundCallConfig CampaignOutboundCallConfig
    name string
    Amazon Connect Campaign Name
    tags Tag[]
    One or more tags.
    connectInstanceArn String
    Amazon Connect Instance Arn
    dialerConfig Property Map
    outboundCallConfig Property Map
    name String
    Amazon Connect Campaign Name
    tags 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:

    Arn string
    Amazon Connect Campaign Arn
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Amazon Connect Campaign Arn
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Connect Campaign Arn
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Amazon Connect Campaign Arn
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Amazon Connect Campaign Arn
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Connect Campaign Arn
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CampaignAgentlessDialerConfig, CampaignAgentlessDialerConfigArgs

    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity number
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialing_capacity float
    Allocates dialing capacity for this campaign between multiple active campaigns.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    CampaignAnswerMachineDetectionConfig, CampaignAnswerMachineDetectionConfigArgs

    EnableAnswerMachineDetection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    EnableAnswerMachineDetection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    enableAnswerMachineDetection Boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    enableAnswerMachineDetection boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    enable_answer_machine_detection bool
    Flag to decided whether outbound calls should have answering machine detection enabled or not
    enableAnswerMachineDetection Boolean
    Flag to decided whether outbound calls should have answering machine detection enabled or not

    CampaignDialerConfig, CampaignDialerConfigArgs

    CampaignOutboundCallConfig, CampaignOutboundCallConfigArgs

    ConnectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    AnswerMachineDetectionConfig Pulumi.AwsNative.ConnectCampaigns.Inputs.CampaignAnswerMachineDetectionConfig
    ConnectQueueArn string
    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.
    ConnectSourcePhoneNumber string
    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.
    ConnectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    AnswerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    ConnectQueueArn string
    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.
    ConnectSourcePhoneNumber string
    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.
    connectContactFlowArn String
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    connectQueueArn String
    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.
    connectSourcePhoneNumber String
    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.
    connectContactFlowArn string
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig CampaignAnswerMachineDetectionConfig
    connectQueueArn string
    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.
    connectSourcePhoneNumber string
    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_flow_arn str
    The identifier of the contact flow for the outbound call.
    answer_machine_detection_config CampaignAnswerMachineDetectionConfig
    connect_queue_arn str
    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_phone_number str
    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.
    connectContactFlowArn String
    The identifier of the contact flow for the outbound call.
    answerMachineDetectionConfig Property Map
    connectQueueArn String
    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.
    connectSourcePhoneNumber String
    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

    BandwidthAllocation double
    The bandwidth allocation of a queue resource.
    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    BandwidthAllocation float64
    The bandwidth allocation of a queue resource.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Double
    The bandwidth allocation of a queue resource.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation number
    The bandwidth allocation of a queue resource.
    dialingCapacity 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.
    bandwidthAllocation Number
    The bandwidth allocation of a queue resource.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    CampaignProgressiveDialerConfig, CampaignProgressiveDialerConfigArgs

    BandwidthAllocation double
    The bandwidth allocation of a queue resource.
    DialingCapacity double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    BandwidthAllocation float64
    The bandwidth allocation of a queue resource.
    DialingCapacity float64
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation Double
    The bandwidth allocation of a queue resource.
    dialingCapacity Double
    Allocates dialing capacity for this campaign between multiple active campaigns.
    bandwidthAllocation number
    The bandwidth allocation of a queue resource.
    dialingCapacity 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.
    bandwidthAllocation Number
    The bandwidth allocation of a queue resource.
    dialingCapacity Number
    Allocates dialing capacity for this campaign between multiple active campaigns.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi