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:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.889Z")
@Stability(Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable, ITaggableV2

Definition of AWS::ConnectCampaignsV2::Campaign Resource Type.

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())
                 .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")
                 .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	The configuration used for answering machine detection during outbound calls.
static final class	CfnCampaign.Builder	A fluent builder for CfnCampaign.
static interface	CfnCampaign.ChannelSubtypeConfigProperty	The possible types of channel subtype config parameters.
static interface	CfnCampaign.CommunicationLimitProperty	Communication Limit.
static interface	CfnCampaign.CommunicationLimitsConfigProperty	Communication limits config.
static interface	CfnCampaign.CommunicationLimitsProperty	Communication limits.
static interface	CfnCampaign.CommunicationTimeConfigProperty	Campaign communication time config.
static interface	CfnCampaign.DailyHourProperty	Daily Hour.
static interface	CfnCampaign.EmailChannelSubtypeConfigProperty	Email Channel Subtype config.
static interface	CfnCampaign.EmailOutboundConfigProperty	Default SMS outbound config.
static interface	CfnCampaign.EmailOutboundModeProperty	Email Outbound Mode.
static interface	CfnCampaign.LocalTimeZoneConfigProperty	Local time zone config.
static interface	CfnCampaign.OpenHoursProperty	Open Hours config.
static interface	CfnCampaign.PredictiveConfigProperty	Predictive config.
static interface	CfnCampaign.ProgressiveConfigProperty	Progressive config.
static interface	CfnCampaign.RestrictedPeriodProperty	Restricted period.
static interface	CfnCampaign.RestrictedPeriodsProperty	Restricted period config.
static interface	CfnCampaign.ScheduleProperty	Campaign schedule.
static interface	CfnCampaign.SmsChannelSubtypeConfigProperty	SMS Channel Subtype config.
static interface	CfnCampaign.SmsOutboundConfigProperty	Default SMS outbound config.
static interface	CfnCampaign.SmsOutboundModeProperty	SMS Outbound Mode.
static interface	CfnCampaign.SourceProperty	The possible types of channel config parameters.
static interface	CfnCampaign.TelephonyChannelSubtypeConfigProperty	Telephony Channel Subtype config.
static interface	CfnCampaign.TelephonyOutboundConfigProperty	Default Telephone Outbound config.
static interface	CfnCampaign.TelephonyOutboundModeProperty	Telephony Outbound Mode.
static interface	CfnCampaign.TimeRangeProperty	Time range in 24 hour format.
static interface	CfnCampaign.TimeWindowProperty	Time window config.

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

software.amazon.jsii.JsiiObject.InitializationMode

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()	Amazon Connect Campaign Arn.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getChannelSubtypeConfig()	The possible types of channel subtype config parameters.
Object	getCommunicationLimitsOverride()	Communication limits config.
Object	getCommunicationTimeConfig()	Campaign communication time config.
String	getConnectCampaignFlowArn()	Arn.
String	getConnectInstanceId()	Amazon Connect Instance Id.
String	getName()	Campaign name.
Object	getSchedule()	Campaign schedule.
Object	getSource()	The possible types of channel config parameters.
List<CfnTag>	getTags()	One or more tags.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelSubtypeConfig(IResolvable value)	The possible types of channel subtype config parameters.
void	setChannelSubtypeConfig(CfnCampaign.ChannelSubtypeConfigProperty value)	The possible types of channel subtype config parameters.
void	setCommunicationLimitsOverride(IResolvable value)	Communication limits config.
void	setCommunicationLimitsOverride(CfnCampaign.CommunicationLimitsConfigProperty value)	Communication limits config.
void	setCommunicationTimeConfig(IResolvable value)	Campaign communication time config.
void	setCommunicationTimeConfig(CfnCampaign.CommunicationTimeConfigProperty value)	Campaign communication time config.
void	setConnectCampaignFlowArn(String value)	Arn.
void	setConnectInstanceId(String value)	Amazon Connect Instance Id.
void	setName(String value)	Campaign name.
void	setSchedule(IResolvable value)	Campaign schedule.
void	setSchedule(CfnCampaign.ScheduleProperty value)	Campaign schedule.
void	setSource(IResolvable value)	The possible types of channel config parameters.
void	setSource(CfnCampaign.SourceProperty value)	The possible types of channel config parameters.
void	setTags(List<CfnTag> value)	One or more tags.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.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()

Amazon Connect Campaign Arn.

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()

The possible types of channel subtype config parameters.

setChannelSubtypeConfig

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

The possible types of channel subtype config parameters.

setChannelSubtypeConfig

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

The possible types of channel subtype config parameters.

getConnectInstanceId

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

Amazon Connect Instance Id.

setConnectInstanceId

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

Amazon Connect Instance Id.

getName

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

Campaign name.

setName

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

Campaign name.

getCommunicationLimitsOverride

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

Communication limits config.

setCommunicationLimitsOverride

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

Communication limits config.

setCommunicationLimitsOverride

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

Communication limits config.

getCommunicationTimeConfig

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

Campaign communication time config.

setCommunicationTimeConfig

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

Campaign communication time config.

setCommunicationTimeConfig

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

Campaign communication time config.

getConnectCampaignFlowArn

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

Arn.

setConnectCampaignFlowArn

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

Arn.

getSchedule

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

Campaign schedule.

setSchedule

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

Campaign schedule.

setSchedule

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

Campaign schedule.

getSource

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

The possible types of channel config parameters.

setSource

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

The possible types of channel config parameters.

setSource

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

The possible types of channel config parameters.

getTags

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

One or more tags.

setTags

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

One or more tags.