Package software.amazon.awscdk.services.connectcampaigns

Class CfnCampaign

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.connectcampaigns.CfnCampaign
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.031Z") @Stability(Stable) public class CfnCampaign extends CfnResource implements IInspectable
A CloudFormation AWS::ConnectCampaigns::Campaign.

Contains information about an outbound campaign.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connectcampaigns.*;
 CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
         .connectInstanceArn("connectInstanceArn")
         .dialerConfig(DialerConfigProperty.builder()
                 .predictiveDialerConfig(PredictiveDialerConfigProperty.builder()
                         .bandwidthAllocation(123)
                         .build())
                 .progressiveDialerConfig(ProgressiveDialerConfigProperty.builder()
                         .bandwidthAllocation(123)
                         .build())
                 .build())
         .name("name")
         .outboundCallConfig(OutboundCallConfigProperty.builder()
                 .connectContactFlowArn("connectContactFlowArn")
                 .connectQueueArn("connectQueueArn")
                 // the properties below are optional
                 .answerMachineDetectionConfig(AnswerMachineDetectionConfigProperty.builder()
                         .enableAnswerMachineDetection(false)
                         .build())
                 .connectSourcePhoneNumber("connectSourcePhoneNumber")
                 .build())
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCampaign

      protected CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCampaign

      protected CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCampaign

      @Stability(Stable) public CfnCampaign(@NotNull Construct scope, @NotNull String id, @NotNull CfnCampaignProps props)
      Create a new AWS::ConnectCampaigns::Campaign.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the high-volume outbound campaign.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags used to organize, track, or control access for this resource.

      For example, { "tags": {"key1":"value1", "key2":"value2"} }.

    • getConnectInstanceArn

      @Stability(Stable) @NotNull public String getConnectInstanceArn()
      The Amazon Resource Name (ARN) of the Amazon Connect instance.

    • setConnectInstanceArn

      @Stability(Stable) public void setConnectInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the Amazon Connect instance.

    • getDialerConfig

      @Stability(Stable) @NotNull public Object getDialerConfig()
      Contains information about the dialer configuration.

    • setDialerConfig

      @Stability(Stable) public void setDialerConfig(@NotNull CfnCampaign.DialerConfigProperty value)
      Contains information about the dialer configuration.

    • setDialerConfig

      @Stability(Stable) public void setDialerConfig(@NotNull IResolvable value)
      Contains information about the dialer configuration.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the campaign.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the campaign.

    • getOutboundCallConfig

      @Stability(Stable) @NotNull public Object getOutboundCallConfig()
      Contains information about the outbound call configuration.

    • setOutboundCallConfig

      @Stability(Stable) public void setOutboundCallConfig(@NotNull IResolvable value)
      Contains information about the outbound call configuration.

    • setOutboundCallConfig

      @Stability(Stable) public void setOutboundCallConfig(@NotNull CfnCampaign.OutboundCallConfigProperty value)
      Contains information about the outbound call configuration.