@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.651Z") public class CfnCampaign extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnCampaign.AnswerMachineDetectionConfigProperty
Contains information about answering machine detection.
|
static class |
CfnCampaign.Builder
A fluent builder for
CfnCampaign . |
static interface |
CfnCampaign.DialerConfigProperty
Contains dialer configuration for an outbound campaign.
|
static interface |
CfnCampaign.OutboundCallConfigProperty
Contains outbound call configuration for an outbound campaign.
|
static interface |
CfnCampaign.PredictiveDialerConfigProperty
Contains predictive dialer configuration for an outbound campaign.
|
static interface |
CfnCampaign.ProgressiveDialerConfigProperty
Contains progressive dialer configuration for an outbound campaign.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCampaign(Construct scope,
java.lang.String id,
CfnCampaignProps props)
Create a new `AWS::ConnectCampaigns::Campaign`.
|
protected |
CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the high-volume outbound campaign.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getConnectInstanceArn()
The Amazon Resource Name (ARN) of the Amazon Connect instance.
|
java.lang.Object |
getDialerConfig()
Contains information about the dialer configuration.
|
java.lang.String |
getName()
The name of the campaign.
|
java.lang.Object |
getOutboundCallConfig()
Contains information about the outbound call configuration.
|
TagManager |
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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setConnectInstanceArn(java.lang.String value)
The Amazon Resource Name (ARN) of the Amazon Connect instance.
|
void |
setDialerConfig(CfnCampaign.DialerConfigProperty value)
Contains information about the dialer configuration.
|
void |
setDialerConfig(IResolvable value)
Contains information about the dialer configuration.
|
void |
setName(java.lang.String value)
The name of the campaign.
|
void |
setOutboundCallConfig(CfnCampaign.OutboundCallConfigProperty value)
Contains information about the outbound call configuration.
|
void |
setOutboundCallConfig(IResolvable value)
Contains information about the outbound call configuration.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCampaign(Construct scope, java.lang.String id, CfnCampaignProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For example, { "tags": {"key1":"value1", "key2":"value2"} }.
public java.lang.String getConnectInstanceArn()
public void setConnectInstanceArn(java.lang.String value)
public java.lang.Object getDialerConfig()
public void setDialerConfig(CfnCampaign.DialerConfigProperty value)
public void setDialerConfig(IResolvable value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getOutboundCallConfig()
public void setOutboundCallConfig(IResolvable value)
public void setOutboundCallConfig(CfnCampaign.OutboundCallConfigProperty value)