Package software.amazon.awscdk.services.connectcampaignsv2

Class CfnCampaign

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.connectcampaignsv2.CfnCampaign

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITaggableV2, ICampaignRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:37.627Z")
@Stability(Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable, ICampaignRef, ITaggableV2

Creates an outbound campaign.

• For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag. For example, { "tags": {"owner": "arn:aws:connect:{REGION}:{AWS_ACCOUNT_ID}:instance/{CONNECT_INSTANCE_ID}"}} .
• After a campaign is created, you can't add/remove source.

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.connectcampaignsv2.*;
 Object agentlessConfig;
 CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
         .channelSubtypeConfig(ChannelSubtypeConfigProperty.builder()
                 .email(EmailChannelSubtypeConfigProperty.builder()
                         .defaultOutboundConfig(EmailOutboundConfigProperty.builder()
                                 .connectSourceEmailAddress("connectSourceEmailAddress")
                                 .wisdomTemplateArn("wisdomTemplateArn")
                                 // the properties below are optional
                                 .sourceEmailAddressDisplayName("sourceEmailAddressDisplayName")
                                 .build())
                         .outboundMode(EmailOutboundModeProperty.builder()
                                 .agentlessConfig(agentlessConfig)
                                 .build())
                         // the properties below are optional
                         .capacity(123)
                         .build())
                 .sms(SmsChannelSubtypeConfigProperty.builder()
                         .defaultOutboundConfig(SmsOutboundConfigProperty.builder()
                                 .connectSourcePhoneNumberArn("connectSourcePhoneNumberArn")
                                 .wisdomTemplateArn("wisdomTemplateArn")
                                 .build())
                         .outboundMode(SmsOutboundModeProperty.builder()
                                 .agentlessConfig(agentlessConfig)
                                 .build())
                         // the properties below are optional
                         .capacity(123)
                         .build())
                 .telephony(TelephonyChannelSubtypeConfigProperty.builder()
                         .defaultOutboundConfig(TelephonyOutboundConfigProperty.builder()
                                 .connectContactFlowId("connectContactFlowId")
                                 // the properties below are optional
                                 .answerMachineDetectionConfig(AnswerMachineDetectionConfigProperty.builder()
                                         .enableAnswerMachineDetection(false)
                                         // the properties below are optional
                                         .awaitAnswerMachinePrompt(false)
                                         .build())
                                 .connectSourcePhoneNumber("connectSourcePhoneNumber")
                                 .build())
                         .outboundMode(TelephonyOutboundModeProperty.builder()
                                 .agentlessConfig(agentlessConfig)
                                 .predictiveConfig(PredictiveConfigProperty.builder()
                                         .bandwidthAllocation(123)
                                         .build())
                                 .progressiveConfig(ProgressiveConfigProperty.builder()
                                         .bandwidthAllocation(123)
                                         .build())
                                 .build())
                         // the properties below are optional
                         .capacity(123)
                         .connectQueueId("connectQueueId")
                         .build())
                 .build())
         .connectInstanceId("connectInstanceId")
         .name("name")
         // the properties below are optional
         .communicationLimitsOverride(CommunicationLimitsConfigProperty.builder()
                 .allChannelsSubtypes(CommunicationLimitsProperty.builder()
                         .communicationLimitList(List.of(CommunicationLimitProperty.builder()
                                 .frequency(123)
                                 .maxCountPerRecipient(123)
                                 .unit("unit")
                                 .build()))
                         .build())
                 .instanceLimitsHandling("instanceLimitsHandling")
                 .build())
         .communicationTimeConfig(CommunicationTimeConfigProperty.builder()
                 .localTimeZoneConfig(LocalTimeZoneConfigProperty.builder()
                         .defaultTimeZone("defaultTimeZone")
                         .localTimeZoneDetection(List.of("localTimeZoneDetection"))
                         .build())
                 // the properties below are optional
                 .email(TimeWindowProperty.builder()
                         .openHours(OpenHoursProperty.builder()
                                 .dailyHours(List.of(DailyHourProperty.builder()
                                         .key("key")
                                         .value(List.of(TimeRangeProperty.builder()
                                                 .endTime("endTime")
                                                 .startTime("startTime")
                                                 .build()))
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .restrictedPeriods(RestrictedPeriodsProperty.builder()
                                 .restrictedPeriodList(List.of(RestrictedPeriodProperty.builder()
                                         .endDate("endDate")
                                         .startDate("startDate")
                                         // the properties below are optional
                                         .name("name")
                                         .build()))
                                 .build())
                         .build())
                 .sms(TimeWindowProperty.builder()
                         .openHours(OpenHoursProperty.builder()
                                 .dailyHours(List.of(DailyHourProperty.builder()
                                         .key("key")
                                         .value(List.of(TimeRangeProperty.builder()
                                                 .endTime("endTime")
                                                 .startTime("startTime")
                                                 .build()))
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .restrictedPeriods(RestrictedPeriodsProperty.builder()
                                 .restrictedPeriodList(List.of(RestrictedPeriodProperty.builder()
                                         .endDate("endDate")
                                         .startDate("startDate")
                                         // the properties below are optional
                                         .name("name")
                                         .build()))
                                 .build())
                         .build())
                 .telephony(TimeWindowProperty.builder()
                         .openHours(OpenHoursProperty.builder()
                                 .dailyHours(List.of(DailyHourProperty.builder()
                                         .key("key")
                                         .value(List.of(TimeRangeProperty.builder()
                                                 .endTime("endTime")
                                                 .startTime("startTime")
                                                 .build()))
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .restrictedPeriods(RestrictedPeriodsProperty.builder()
                                 .restrictedPeriodList(List.of(RestrictedPeriodProperty.builder()
                                         .endDate("endDate")
                                         .startDate("startDate")
                                         // the properties below are optional
                                         .name("name")
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .connectCampaignFlowArn("connectCampaignFlowArn")
         .schedule(ScheduleProperty.builder()
                 .endTime("endTime")
                 .startTime("startTime")
                 // the properties below are optional
                 .refreshFrequency("refreshFrequency")
                 .build())
         .source(SourceProperty.builder()
                 .customerProfilesSegmentArn("customerProfilesSegmentArn")
                 .eventTrigger(EventTriggerProperty.builder()
                         .customerProfilesDomainArn("customerProfilesDomainArn")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connectcampaignsv2-campaign.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnCampaign.AnswerMachineDetectionConfigProperty	Contains answering machine detection configuration.
static final class	CfnCampaign.Builder	A fluent builder for CfnCampaign.
static interface	CfnCampaign.ChannelSubtypeConfigProperty	Contains channel subtype configuration for an outbound campaign.
static interface	CfnCampaign.CommunicationLimitProperty	Contains information about a communication limit.
static interface	CfnCampaign.CommunicationLimitsConfigProperty	Contains the communication limits configuration for an outbound campaign.
static interface	CfnCampaign.CommunicationLimitsProperty	Contains information about communication limits.
static interface	CfnCampaign.CommunicationTimeConfigProperty	Communication time configuration for an outbound campaign.
static interface	CfnCampaign.DailyHourProperty	The daily hours configuration.
static interface	CfnCampaign.EmailChannelSubtypeConfigProperty	The configuration for the email channel subtype.
static interface	CfnCampaign.EmailOutboundConfigProperty	The outbound configuration for email.
static interface	CfnCampaign.EmailOutboundModeProperty	Contains information about email outbound mode.
static interface	CfnCampaign.EventTriggerProperty	The event trigger of the campaign.
static interface	CfnCampaign.LocalTimeZoneConfigProperty	The configuration of timezone for recipient.
static interface	CfnCampaign.OpenHoursProperty	Contains information about open hours.
static interface	CfnCampaign.PredictiveConfigProperty	Contains predictive outbound mode configuration.
static interface	CfnCampaign.ProgressiveConfigProperty	Contains the progressive outbound mode configuration.
static interface	CfnCampaign.RestrictedPeriodProperty	Contains information about a restricted period.
static interface	CfnCampaign.RestrictedPeriodsProperty	Contains information about restricted periods.
static interface	CfnCampaign.ScheduleProperty	Contains the schedule configuration.
static interface	CfnCampaign.SmsChannelSubtypeConfigProperty	The configuration for the SMS channel subtype.
static interface	CfnCampaign.SmsOutboundConfigProperty	The outbound configuration for SMS.
static interface	CfnCampaign.SmsOutboundModeProperty	Contains information about the SMS outbound mode.
static interface	CfnCampaign.SourceProperty	Contains source configuration.
static interface	CfnCampaign.TelephonyChannelSubtypeConfigProperty	The configuration for the telephony channel subtype.
static interface	CfnCampaign.TelephonyOutboundConfigProperty	The outbound configuration for telephony.
static interface	CfnCampaign.TelephonyOutboundModeProperty	Contains information about telephony outbound mode.
static interface	CfnCampaign.TimeRangeProperty	Contains information about a time range.
static interface	CfnCampaign.TimeWindowProperty	Contains information about a time window.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.connectcampaignsv2.ICampaignRef

ICampaignRef.Jsii$Default, ICampaignRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCampaign(software.constructs.Construct scope, String id, CfnCampaignProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN).
CampaignReference	getCampaignRef()	A reference to a Campaign resource.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getChannelSubtypeConfig()	Contains channel subtype configuration for an outbound campaign.
Object	getCommunicationLimitsOverride()	Communication limits configuration for an outbound campaign.
Object	getCommunicationTimeConfig()	Contains communication time configuration for an outbound campaign.
String	getConnectCampaignFlowArn()	The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
String	getConnectInstanceId()	The identifier of the Amazon Connect instance.
String	getName()	The name of the outbound campaign.
Object	getSchedule()	Contains the schedule configuration.
Object	getSource()	Contains source configuration.
List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelSubtypeConfig(IResolvable value)	Contains channel subtype configuration for an outbound campaign.
void	setChannelSubtypeConfig(CfnCampaign.ChannelSubtypeConfigProperty value)	Contains channel subtype configuration for an outbound campaign.
void	setCommunicationLimitsOverride(IResolvable value)	Communication limits configuration for an outbound campaign.
void	setCommunicationLimitsOverride(CfnCampaign.CommunicationLimitsConfigProperty value)	Communication limits configuration for an outbound campaign.
void	setCommunicationTimeConfig(IResolvable value)	Contains communication time configuration for an outbound campaign.
void	setCommunicationTimeConfig(CfnCampaign.CommunicationTimeConfigProperty value)	Contains communication time configuration for an outbound campaign.
void	setConnectCampaignFlowArn(String value)	The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
void	setConnectInstanceId(String value)	The identifier of the Amazon Connect instance.
void	setName(String value)	The name of the outbound campaign.
void	setSchedule(IResolvable value)	Contains the schedule configuration.
void	setSchedule(CfnCampaign.ScheduleProperty value)	Contains the schedule configuration.
void	setSource(IResolvable value)	Contains source configuration.
void	setSource(CfnCampaign.SourceProperty value)	Contains source configuration.
void	setTags(List<CfnTag> value)	The tags used to organize, track, or control access for this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCampaignProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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).

getCampaignRef

@Stability(Stable)
@NotNull
public CampaignReference getCampaignRef()

A reference to a Campaign resource.

Specified by:

getCampaignRef in interface ICampaignRef

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getChannelSubtypeConfig

@Stability(Stable)
@NotNull
public Object getChannelSubtypeConfig()

Contains channel subtype configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.ChannelSubtypeConfigProperty

setChannelSubtypeConfig

@Stability(Stable)
public void setChannelSubtypeConfig(@NotNull
 IResolvable value)

Contains channel subtype configuration for an outbound campaign.

setChannelSubtypeConfig

@Stability(Stable)
public void setChannelSubtypeConfig(@NotNull
 CfnCampaign.ChannelSubtypeConfigProperty value)

Contains channel subtype configuration for an outbound campaign.

getConnectInstanceId

@Stability(Stable)
@NotNull
public String getConnectInstanceId()

The identifier of the Amazon Connect instance.

setConnectInstanceId

@Stability(Stable)
public void setConnectInstanceId(@NotNull
 String value)

The identifier of the Amazon Connect instance.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the outbound campaign.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the outbound campaign.

getCommunicationLimitsOverride

@Stability(Stable)
@Nullable
public Object getCommunicationLimitsOverride()

Communication limits configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.CommunicationLimitsConfigProperty

setCommunicationLimitsOverride

@Stability(Stable)
public void setCommunicationLimitsOverride(@Nullable
 IResolvable value)

Communication limits configuration for an outbound campaign.

setCommunicationLimitsOverride

@Stability(Stable)
public void setCommunicationLimitsOverride(@Nullable
 CfnCampaign.CommunicationLimitsConfigProperty value)

Communication limits configuration for an outbound campaign.

getCommunicationTimeConfig

@Stability(Stable)
@Nullable
public Object getCommunicationTimeConfig()

Contains communication time configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.CommunicationTimeConfigProperty

setCommunicationTimeConfig

@Stability(Stable)
public void setCommunicationTimeConfig(@Nullable
 IResolvable value)

Contains communication time configuration for an outbound campaign.

setCommunicationTimeConfig

@Stability(Stable)
public void setCommunicationTimeConfig(@Nullable
 CfnCampaign.CommunicationTimeConfigProperty value)

Contains communication time configuration for an outbound campaign.

getConnectCampaignFlowArn

@Stability(Stable)
@Nullable
public String getConnectCampaignFlowArn()

The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.

setConnectCampaignFlowArn

@Stability(Stable)
public void setConnectCampaignFlowArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.

getSchedule

@Stability(Stable)
@Nullable
public Object getSchedule()

Contains the schedule configuration.

Returns union: either IResolvable or CfnCampaign.ScheduleProperty

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 IResolvable value)

Contains the schedule configuration.

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 CfnCampaign.ScheduleProperty value)

Contains the schedule configuration.

getSource

@Stability(Stable)
@Nullable
public Object getSource()

Contains source configuration.

Returns union: either IResolvable or CfnCampaign.SourceProperty

setSource

@Stability(Stable)
public void setSource(@Nullable
 IResolvable value)

Contains source configuration.

setSource

@Stability(Stable)
public void setSource(@Nullable
 CfnCampaign.SourceProperty value)

Contains source configuration.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

The tags used to organize, track, or control access for this resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags used to organize, track, or control access for this resource.