2.221.1

class CfnCampaign (construct)

LanguageType name
.NETAmazon.CDK.aws_connectcampaignsv2.CfnCampaign
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconnectcampaignsv2#CfnCampaign
Javasoftware.amazon.awscdk.services.connectcampaignsv2.CfnCampaign
Pythonaws_cdk.aws_connectcampaignsv2.CfnCampaign
TypeScript aws-cdk-lib » aws_connectcampaignsv2 » CfnCampaign

Implements IConstruct, IDependable, 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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connectcampaignsv2 as connectcampaignsv2 } from 'aws-cdk-lib';

declare const agentlessConfig: any;
const cfnCampaign = new connectcampaignsv2.CfnCampaign(this, 'MyCfnCampaign', {
  channelSubtypeConfig: {
    email: {
      defaultOutboundConfig: {
        connectSourceEmailAddress: 'connectSourceEmailAddress',
        wisdomTemplateArn: 'wisdomTemplateArn',

        // the properties below are optional
        sourceEmailAddressDisplayName: 'sourceEmailAddressDisplayName',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
      },

      // the properties below are optional
      capacity: 123,
    },
    sms: {
      defaultOutboundConfig: {
        connectSourcePhoneNumberArn: 'connectSourcePhoneNumberArn',
        wisdomTemplateArn: 'wisdomTemplateArn',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
      },

      // the properties below are optional
      capacity: 123,
    },
    telephony: {
      defaultOutboundConfig: {
        connectContactFlowId: 'connectContactFlowId',

        // the properties below are optional
        answerMachineDetectionConfig: {
          enableAnswerMachineDetection: false,

          // the properties below are optional
          awaitAnswerMachinePrompt: false,
        },
        connectSourcePhoneNumber: 'connectSourcePhoneNumber',
      },
      outboundMode: {
        agentlessConfig: agentlessConfig,
        predictiveConfig: {
          bandwidthAllocation: 123,
        },
        progressiveConfig: {
          bandwidthAllocation: 123,
        },
      },

      // the properties below are optional
      capacity: 123,
      connectQueueId: 'connectQueueId',
    },
  },
  connectInstanceId: 'connectInstanceId',
  name: 'name',

  // the properties below are optional
  communicationLimitsOverride: {
    allChannelsSubtypes: {
      communicationLimitList: [{
        frequency: 123,
        maxCountPerRecipient: 123,
        unit: 'unit',
      }],
    },
    instanceLimitsHandling: 'instanceLimitsHandling',
  },
  communicationTimeConfig: {
    localTimeZoneConfig: {
      defaultTimeZone: 'defaultTimeZone',
      localTimeZoneDetection: ['localTimeZoneDetection'],
    },

    // the properties below are optional
    email: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },

      // the properties below are optional
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          startDate: 'startDate',

          // the properties below are optional
          name: 'name',
        }],
      },
    },
    sms: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },

      // the properties below are optional
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          startDate: 'startDate',

          // the properties below are optional
          name: 'name',
        }],
      },
    },
    telephony: {
      openHours: {
        dailyHours: [{
          key: 'key',
          value: [{
            endTime: 'endTime',
            startTime: 'startTime',
          }],
        }],
      },

      // the properties below are optional
      restrictedPeriods: {
        restrictedPeriodList: [{
          endDate: 'endDate',
          startDate: 'startDate',

          // the properties below are optional
          name: 'name',
        }],
      },
    },
  },
  connectCampaignFlowArn: 'connectCampaignFlowArn',
  schedule: {
    endTime: 'endTime',
    startTime: 'startTime',

    // the properties below are optional
    refreshFrequency: 'refreshFrequency',
  },
  source: {
    customerProfilesSegmentArn: 'customerProfilesSegmentArn',
    eventTrigger: {
      customerProfilesDomainArn: 'customerProfilesDomainArn',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCampaign(scope: Construct, id: string, props: CfnCampaignProps)

Parameters

  • scope Construct — Scope in which this resource is defined.
  • id string — Construct identifier for this resource (unique in its scope).
  • props CfnCampaignProps — Resource properties.

Construct Props

NameTypeDescription
channelSubtypeConfigIResolvable | ChannelSubtypeConfigPropertyContains channel subtype configuration for an outbound campaign.
connectInstanceIdstringThe identifier of the Amazon Connect instance.
namestringThe name of the outbound campaign.
communicationLimitsOverride?IResolvable | CommunicationLimitsConfigPropertyCommunication limits configuration for an outbound campaign.
communicationTimeConfig?IResolvable | CommunicationTimeConfigPropertyContains communication time configuration for an outbound campaign.
connectCampaignFlowArn?stringThe Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
schedule?IResolvable | SchedulePropertyContains the schedule configuration.
source?IResolvable | SourcePropertyContains source configuration.
tags?CfnTag[]The tags used to organize, track, or control access for this resource.

channelSubtypeConfig

Type: IResolvable | ChannelSubtypeConfigProperty

Contains channel subtype configuration for an outbound campaign.

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

connectInstanceId

Type: string

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

name

Type: string

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

communicationLimitsOverride?

Type: IResolvable | CommunicationLimitsConfigProperty (optional)

Communication limits configuration for an outbound campaign.

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

communicationTimeConfig?

Type: IResolvable | CommunicationTimeConfigProperty (optional)

Contains communication time configuration for an outbound campaign.

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

connectCampaignFlowArn?

Type: string (optional)

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

schedule?

Type: IResolvable | ScheduleProperty (optional)

Contains the schedule configuration.

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

source?

Type: IResolvable | SourceProperty (optional)

Contains source configuration.

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

tags?

Type: CfnTag[] (optional)

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

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN).
campaignRefCampaignReferenceA reference to a Campaign resource.
cdkTagManagerTagManagerTag Manager which manages the tags for this resource.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
channelSubtypeConfigIResolvable | ChannelSubtypeConfigPropertyContains channel subtype configuration for an outbound campaign.
connectInstanceIdstringThe identifier of the Amazon Connect instance.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe name of the outbound campaign.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
communicationLimitsOverride?IResolvable | CommunicationLimitsConfigPropertyCommunication limits configuration for an outbound campaign.
communicationTimeConfig?IResolvable | CommunicationTimeConfigPropertyContains communication time configuration for an outbound campaign.
connectCampaignFlowArn?stringThe Amazon Resource Name (ARN) of the Amazon Connect campaign flow associated with the outbound campaign.
schedule?IResolvable | SchedulePropertyContains the schedule configuration.
source?IResolvable | SourcePropertyContains source configuration.
tags?CfnTag[]The tags used to organize, track, or control access for this resource.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN).

campaignRef

Type: CampaignReference

A reference to a Campaign resource.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

channelSubtypeConfig

Type: IResolvable | ChannelSubtypeConfigProperty

Contains channel subtype configuration for an outbound campaign.

connectInstanceId

Type: string

The identifier of the Amazon Connect instance.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the outbound campaign.

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

communicationLimitsOverride?

Type: IResolvable | CommunicationLimitsConfigProperty (optional)

Communication limits configuration for an outbound campaign.

communicationTimeConfig?

Type: IResolvable | CommunicationTimeConfigProperty (optional)

Contains communication time configuration for an outbound campaign.

connectCampaignFlowArn?

Type: string (optional)

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

schedule?

Type: IResolvable | ScheduleProperty (optional)

Contains the schedule configuration.

source?

Type: IResolvable | SourceProperty (optional)

Contains source configuration.

tags?

Type: CfnTag[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

Replaces one dependency with another.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →