Package software.amazon.awscdk.services.connectcampaignsv2

Interface CfnCampaignProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaignProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:35.777Z")
@Stability(Stable)
public interface CfnCampaignProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCampaign.

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;
 CfnCampaignProps cfnCampaignProps = CfnCampaignProps.builder()
         .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	Interface	Description
static final class	CfnCampaignProps.Builder	A builder for CfnCampaignProps
static final class	CfnCampaignProps.Jsii$Proxy	An implementation for CfnCampaignProps

Method Summary

Modifier and Type	Method	Description
static CfnCampaignProps.Builder	builder()
Object	getChannelSubtypeConfig()	Contains channel subtype configuration for an outbound campaign.
default Object	getCommunicationLimitsOverride()	Communication limits configuration for an outbound campaign.
default Object	getCommunicationTimeConfig()	Contains communication time configuration for an outbound campaign.
default 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.
default Object	getSchedule()	Contains the schedule configuration.
default Object	getSource()	Contains source configuration.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelSubtypeConfig

@Stability(Stable)
@NotNull
Object getChannelSubtypeConfig()

Contains channel subtype configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.ChannelSubtypeConfigProperty

See Also:

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

getConnectInstanceId

@Stability(Stable)
@NotNull
String getConnectInstanceId()

The identifier of the Amazon Connect instance.

You can find the instanceId in the ARN of the instance.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the outbound campaign.

See Also:

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

getCommunicationLimitsOverride

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

Communication limits configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.CommunicationLimitsConfigProperty

See Also:

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

getCommunicationTimeConfig

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

Contains communication time configuration for an outbound campaign.

Returns union: either IResolvable or CfnCampaign.CommunicationTimeConfigProperty

See Also:

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

getConnectCampaignFlowArn

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

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

See Also:

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

getSchedule

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

Contains the schedule configuration.

Returns union: either IResolvable or CfnCampaign.ScheduleProperty

See Also:

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

getSource

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

Contains source configuration.

Returns union: either IResolvable or CfnCampaign.SourceProperty

See Also:

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

getTags

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

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

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

See Also:

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

builder

@Stability(Stable)
static CfnCampaignProps.Builder builder()

Returns:

a CfnCampaignProps.Builder of CfnCampaignProps