Package software.amazon.awscdk.services.pinpoint

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.pinpoint.CfnCampaign

All Implemented Interfaces:

IInspectable, ITaggable, ICampaignRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:43.155Z")
@Stability(Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable, ICampaignRef, ITaggable

Specifies the settings for a campaign.

A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

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.pinpoint.*;
 Object attributes;
 Object customConfig;
 Object metrics;
 Object tags;
 CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
         .applicationId("applicationId")
         .name("name")
         .schedule(ScheduleProperty.builder()
                 .endTime("endTime")
                 .eventFilter(CampaignEventFilterProperty.builder()
                         .dimensions(EventDimensionsProperty.builder()
                                 .attributes(attributes)
                                 .eventType(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .metrics(metrics)
                                 .build())
                         .filterType("filterType")
                         .build())
                 .frequency("frequency")
                 .isLocalTime(false)
                 .quietTime(QuietTimeProperty.builder()
                         .end("end")
                         .start("start")
                         .build())
                 .startTime("startTime")
                 .timeZone("timeZone")
                 .build())
         .segmentId("segmentId")
         // the properties below are optional
         .additionalTreatments(List.of(WriteTreatmentResourceProperty.builder()
                 .customDeliveryConfiguration(CustomDeliveryConfigurationProperty.builder()
                         .deliveryUri("deliveryUri")
                         .endpointTypes(List.of("endpointTypes"))
                         .build())
                 .messageConfiguration(MessageConfigurationProperty.builder()
                         .admMessage(MessageProperty.builder()
                                 .action("action")
                                 .body("body")
                                 .imageIconUrl("imageIconUrl")
                                 .imageSmallIconUrl("imageSmallIconUrl")
                                 .imageUrl("imageUrl")
                                 .jsonBody("jsonBody")
                                 .mediaUrl("mediaUrl")
                                 .rawContent("rawContent")
                                 .silentPush(false)
                                 .timeToLive(123)
                                 .title("title")
                                 .url("url")
                                 .build())
                         .apnsMessage(MessageProperty.builder()
                                 .action("action")
                                 .body("body")
                                 .imageIconUrl("imageIconUrl")
                                 .imageSmallIconUrl("imageSmallIconUrl")
                                 .imageUrl("imageUrl")
                                 .jsonBody("jsonBody")
                                 .mediaUrl("mediaUrl")
                                 .rawContent("rawContent")
                                 .silentPush(false)
                                 .timeToLive(123)
                                 .title("title")
                                 .url("url")
                                 .build())
                         .baiduMessage(MessageProperty.builder()
                                 .action("action")
                                 .body("body")
                                 .imageIconUrl("imageIconUrl")
                                 .imageSmallIconUrl("imageSmallIconUrl")
                                 .imageUrl("imageUrl")
                                 .jsonBody("jsonBody")
                                 .mediaUrl("mediaUrl")
                                 .rawContent("rawContent")
                                 .silentPush(false)
                                 .timeToLive(123)
                                 .title("title")
                                 .url("url")
                                 .build())
                         .customMessage(CampaignCustomMessageProperty.builder()
                                 .data("data")
                                 .build())
                         .defaultMessage(MessageProperty.builder()
                                 .action("action")
                                 .body("body")
                                 .imageIconUrl("imageIconUrl")
                                 .imageSmallIconUrl("imageSmallIconUrl")
                                 .imageUrl("imageUrl")
                                 .jsonBody("jsonBody")
                                 .mediaUrl("mediaUrl")
                                 .rawContent("rawContent")
                                 .silentPush(false)
                                 .timeToLive(123)
                                 .title("title")
                                 .url("url")
                                 .build())
                         .emailMessage(CampaignEmailMessageProperty.builder()
                                 .body("body")
                                 .fromAddress("fromAddress")
                                 .htmlBody("htmlBody")
                                 .title("title")
                                 .build())
                         .gcmMessage(MessageProperty.builder()
                                 .action("action")
                                 .body("body")
                                 .imageIconUrl("imageIconUrl")
                                 .imageSmallIconUrl("imageSmallIconUrl")
                                 .imageUrl("imageUrl")
                                 .jsonBody("jsonBody")
                                 .mediaUrl("mediaUrl")
                                 .rawContent("rawContent")
                                 .silentPush(false)
                                 .timeToLive(123)
                                 .title("title")
                                 .url("url")
                                 .build())
                         .inAppMessage(CampaignInAppMessageProperty.builder()
                                 .content(List.of(InAppMessageContentProperty.builder()
                                         .backgroundColor("backgroundColor")
                                         .bodyConfig(InAppMessageBodyConfigProperty.builder()
                                                 .alignment("alignment")
                                                 .body("body")
                                                 .textColor("textColor")
                                                 .build())
                                         .headerConfig(InAppMessageHeaderConfigProperty.builder()
                                                 .alignment("alignment")
                                                 .header("header")
                                                 .textColor("textColor")
                                                 .build())
                                         .imageUrl("imageUrl")
                                         .primaryBtn(InAppMessageButtonProperty.builder()
                                                 .android(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                                         .backgroundColor("backgroundColor")
                                                         .borderRadius(123)
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .text("text")
                                                         .textColor("textColor")
                                                         .build())
                                                 .ios(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .web(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .build())
                                         .secondaryBtn(InAppMessageButtonProperty.builder()
                                                 .android(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                                         .backgroundColor("backgroundColor")
                                                         .borderRadius(123)
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .text("text")
                                                         .textColor("textColor")
                                                         .build())
                                                 .ios(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .web(OverrideButtonConfigurationProperty.builder()
                                                         .buttonAction("buttonAction")
                                                         .link("link")
                                                         .build())
                                                 .build())
                                         .build()))
                                 .customConfig(customConfig)
                                 .layout("layout")
                                 .build())
                         .smsMessage(CampaignSmsMessageProperty.builder()
                                 .body("body")
                                 .entityId("entityId")
                                 .messageType("messageType")
                                 .originationNumber("originationNumber")
                                 .senderId("senderId")
                                 .templateId("templateId")
                                 .build())
                         .build())
                 .schedule(ScheduleProperty.builder()
                         .endTime("endTime")
                         .eventFilter(CampaignEventFilterProperty.builder()
                                 .dimensions(EventDimensionsProperty.builder()
                                         .attributes(attributes)
                                         .eventType(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .metrics(metrics)
                                         .build())
                                 .filterType("filterType")
                                 .build())
                         .frequency("frequency")
                         .isLocalTime(false)
                         .quietTime(QuietTimeProperty.builder()
                                 .end("end")
                                 .start("start")
                                 .build())
                         .startTime("startTime")
                         .timeZone("timeZone")
                         .build())
                 .sizePercent(123)
                 .templateConfiguration(TemplateConfigurationProperty.builder()
                         .emailTemplate(TemplateProperty.builder()
                                 .name("name")
                                 .version("version")
                                 .build())
                         .pushTemplate(TemplateProperty.builder()
                                 .name("name")
                                 .version("version")
                                 .build())
                         .smsTemplate(TemplateProperty.builder()
                                 .name("name")
                                 .version("version")
                                 .build())
                         .voiceTemplate(TemplateProperty.builder()
                                 .name("name")
                                 .version("version")
                                 .build())
                         .build())
                 .treatmentDescription("treatmentDescription")
                 .treatmentName("treatmentName")
                 .build()))
         .campaignHook(CampaignHookProperty.builder()
                 .lambdaFunctionName("lambdaFunctionName")
                 .mode("mode")
                 .webUrl("webUrl")
                 .build())
         .customDeliveryConfiguration(CustomDeliveryConfigurationProperty.builder()
                 .deliveryUri("deliveryUri")
                 .endpointTypes(List.of("endpointTypes"))
                 .build())
         .description("description")
         .holdoutPercent(123)
         .isPaused(false)
         .limits(LimitsProperty.builder()
                 .daily(123)
                 .maximumDuration(123)
                 .messagesPerSecond(123)
                 .session(123)
                 .total(123)
                 .build())
         .messageConfiguration(MessageConfigurationProperty.builder()
                 .admMessage(MessageProperty.builder()
                         .action("action")
                         .body("body")
                         .imageIconUrl("imageIconUrl")
                         .imageSmallIconUrl("imageSmallIconUrl")
                         .imageUrl("imageUrl")
                         .jsonBody("jsonBody")
                         .mediaUrl("mediaUrl")
                         .rawContent("rawContent")
                         .silentPush(false)
                         .timeToLive(123)
                         .title("title")
                         .url("url")
                         .build())
                 .apnsMessage(MessageProperty.builder()
                         .action("action")
                         .body("body")
                         .imageIconUrl("imageIconUrl")
                         .imageSmallIconUrl("imageSmallIconUrl")
                         .imageUrl("imageUrl")
                         .jsonBody("jsonBody")
                         .mediaUrl("mediaUrl")
                         .rawContent("rawContent")
                         .silentPush(false)
                         .timeToLive(123)
                         .title("title")
                         .url("url")
                         .build())
                 .baiduMessage(MessageProperty.builder()
                         .action("action")
                         .body("body")
                         .imageIconUrl("imageIconUrl")
                         .imageSmallIconUrl("imageSmallIconUrl")
                         .imageUrl("imageUrl")
                         .jsonBody("jsonBody")
                         .mediaUrl("mediaUrl")
                         .rawContent("rawContent")
                         .silentPush(false)
                         .timeToLive(123)
                         .title("title")
                         .url("url")
                         .build())
                 .customMessage(CampaignCustomMessageProperty.builder()
                         .data("data")
                         .build())
                 .defaultMessage(MessageProperty.builder()
                         .action("action")
                         .body("body")
                         .imageIconUrl("imageIconUrl")
                         .imageSmallIconUrl("imageSmallIconUrl")
                         .imageUrl("imageUrl")
                         .jsonBody("jsonBody")
                         .mediaUrl("mediaUrl")
                         .rawContent("rawContent")
                         .silentPush(false)
                         .timeToLive(123)
                         .title("title")
                         .url("url")
                         .build())
                 .emailMessage(CampaignEmailMessageProperty.builder()
                         .body("body")
                         .fromAddress("fromAddress")
                         .htmlBody("htmlBody")
                         .title("title")
                         .build())
                 .gcmMessage(MessageProperty.builder()
                         .action("action")
                         .body("body")
                         .imageIconUrl("imageIconUrl")
                         .imageSmallIconUrl("imageSmallIconUrl")
                         .imageUrl("imageUrl")
                         .jsonBody("jsonBody")
                         .mediaUrl("mediaUrl")
                         .rawContent("rawContent")
                         .silentPush(false)
                         .timeToLive(123)
                         .title("title")
                         .url("url")
                         .build())
                 .inAppMessage(CampaignInAppMessageProperty.builder()
                         .content(List.of(InAppMessageContentProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .bodyConfig(InAppMessageBodyConfigProperty.builder()
                                         .alignment("alignment")
                                         .body("body")
                                         .textColor("textColor")
                                         .build())
                                 .headerConfig(InAppMessageHeaderConfigProperty.builder()
                                         .alignment("alignment")
                                         .header("header")
                                         .textColor("textColor")
                                         .build())
                                 .imageUrl("imageUrl")
                                 .primaryBtn(InAppMessageButtonProperty.builder()
                                         .android(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                                 .backgroundColor("backgroundColor")
                                                 .borderRadius(123)
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .text("text")
                                                 .textColor("textColor")
                                                 .build())
                                         .ios(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .web(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .build())
                                 .secondaryBtn(InAppMessageButtonProperty.builder()
                                         .android(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                                 .backgroundColor("backgroundColor")
                                                 .borderRadius(123)
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .text("text")
                                                 .textColor("textColor")
                                                 .build())
                                         .ios(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .web(OverrideButtonConfigurationProperty.builder()
                                                 .buttonAction("buttonAction")
                                                 .link("link")
                                                 .build())
                                         .build())
                                 .build()))
                         .customConfig(customConfig)
                         .layout("layout")
                         .build())
                 .smsMessage(CampaignSmsMessageProperty.builder()
                         .body("body")
                         .entityId("entityId")
                         .messageType("messageType")
                         .originationNumber("originationNumber")
                         .senderId("senderId")
                         .templateId("templateId")
                         .build())
                 .build())
         .priority(123)
         .segmentVersion(123)
         .tags(tags)
         .templateConfiguration(TemplateConfigurationProperty.builder()
                 .emailTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .pushTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .smsTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .voiceTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .build())
         .treatmentDescription("treatmentDescription")
         .treatmentName("treatmentName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnCampaign.AttributeDimensionProperty	Example:
static final class	CfnCampaign.Builder	A fluent builder for CfnCampaign.
static interface	CfnCampaign.CampaignCustomMessageProperty	Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
static interface	CfnCampaign.CampaignEmailMessageProperty	Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
static interface	CfnCampaign.CampaignEventFilterProperty	Specifies the settings for events that cause a campaign to be sent.
static interface	CfnCampaign.CampaignHookProperty	Specifies settings for invoking an Lambda function that customizes a segment for a campaign.
static interface	CfnCampaign.CampaignInAppMessageProperty	Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.
static interface	CfnCampaign.CampaignSmsMessageProperty	Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
static interface	CfnCampaign.CustomDeliveryConfigurationProperty	Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.
static interface	CfnCampaign.DefaultButtonConfigurationProperty	Specifies the default behavior for a button that appears in an in-app message.
static interface	CfnCampaign.EventDimensionsProperty	Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
static interface	CfnCampaign.InAppMessageBodyConfigProperty	Specifies the configuration of main body text of the in-app message.
static interface	CfnCampaign.InAppMessageButtonProperty	Specifies the configuration of a button that appears in an in-app message.
static interface	CfnCampaign.InAppMessageContentProperty	Specifies the configuration and contents of an in-app message.
static interface	CfnCampaign.InAppMessageHeaderConfigProperty	Specifies the configuration and content of the header or title text of the in-app message.
static interface	CfnCampaign.LimitsProperty	Specifies the limits on the messages that a campaign can send.
static interface	CfnCampaign.MessageConfigurationProperty	Specifies the message configuration settings for a campaign.
static interface	CfnCampaign.MessageProperty	Specifies the content and settings for a push notification that's sent to recipients of a campaign.
static interface	CfnCampaign.MetricDimensionProperty	Example:
static interface	CfnCampaign.OverrideButtonConfigurationProperty	Specifies the configuration of a button with settings that are specific to a certain device type.
static interface	CfnCampaign.QuietTimeProperty	Specifies the start and end times that define a time range when messages aren't sent to endpoints.
static interface	CfnCampaign.ScheduleProperty	Specifies the schedule settings for a campaign.
static interface	CfnCampaign.SetDimensionProperty	Specifies the dimension type and values for a segment dimension.
static interface	CfnCampaign.TemplateConfigurationProperty	Specifies the message template to use for the message, for each type of channel.
static interface	CfnCampaign.TemplateProperty	Specifies the name and version of the message template to use for the message.
static interface	CfnCampaign.WriteTreatmentResourceProperty	Specifies the settings for a campaign treatment.

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.pinpoint.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.ITaggable

ITaggable.Jsii$Default, ITaggable.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
Object	getAdditionalTreatments()	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
String	getAttrArn()	The Amazon Resource Name (ARN) of the campaign.
String	getAttrCampaignId()	The unique identifier for the campaign.
Object	getCampaignHook()	Specifies the Lambda function to use as a code hook for a campaign.
CampaignReference	getCampaignRef()	A reference to a Campaign resource.
protected Map<String,Object>	getCfnProperties()
Object	getCustomDeliveryConfiguration()	The delivery configuration settings for sending the treatment through a custom channel.
String	getDescription()	A custom description of the campaign.
Number	getHoldoutPercent()	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Object	getIsPaused()	Specifies whether to pause the campaign.
Object	getLimits()	The messaging limits for the campaign.
Object	getMessageConfiguration()	The message configuration settings for the treatment.
String	getName()	The name of the campaign.
Number	getPriority()	An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.
Object	getSchedule()	The schedule settings for the treatment.
String	getSegmentId()	The unique identifier for the segment to associate with the campaign.
Number	getSegmentVersion()	The version of the segment to associate with the campaign.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Object	getTagsRaw()	An array of key-value pairs to apply to this resource.
Object	getTemplateConfiguration()	The message template to use for the treatment.
String	getTreatmentDescription()	A custom description of the treatment.
String	getTreatmentName()	A custom name for the treatment.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalTreatments(List<Object> value)	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
void	setAdditionalTreatments(IResolvable value)	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
void	setApplicationId(String value)	The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
void	setCampaignHook(IResolvable value)	Specifies the Lambda function to use as a code hook for a campaign.
void	setCampaignHook(CfnCampaign.CampaignHookProperty value)	Specifies the Lambda function to use as a code hook for a campaign.
void	setCustomDeliveryConfiguration(IResolvable value)	The delivery configuration settings for sending the treatment through a custom channel.
void	setCustomDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty value)	The delivery configuration settings for sending the treatment through a custom channel.
void	setDescription(String value)	A custom description of the campaign.
void	setHoldoutPercent(Number value)	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
void	setIsPaused(Boolean value)	Specifies whether to pause the campaign.
void	setIsPaused(IResolvable value)	Specifies whether to pause the campaign.
void	setLimits(IResolvable value)	The messaging limits for the campaign.
void	setLimits(CfnCampaign.LimitsProperty value)	The messaging limits for the campaign.
void	setMessageConfiguration(IResolvable value)	The message configuration settings for the treatment.
void	setMessageConfiguration(CfnCampaign.MessageConfigurationProperty value)	The message configuration settings for the treatment.
void	setName(String value)	The name of the campaign.
void	setPriority(Number value)	An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.
void	setSchedule(IResolvable value)	The schedule settings for the treatment.
void	setSchedule(CfnCampaign.ScheduleProperty value)	The schedule settings for the treatment.
void	setSegmentId(String value)	The unique identifier for the segment to associate with the campaign.
void	setSegmentVersion(Number value)	The version of the segment to associate with the campaign.
void	setTagsRaw(Object value)	An array of key-value pairs to apply to this resource.
void	setTemplateConfiguration(IResolvable value)	The message template to use for the treatment.
void	setTemplateConfiguration(CfnCampaign.TemplateConfigurationProperty value)	The message template to use for the treatment.
void	setTreatmentDescription(String value)	A custom description of the treatment.
void	setTreatmentName(String value)	A custom name for the treatment.

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.constructs.IConstruct

getNode

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) of the campaign.

getAttrCampaignId

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

The unique identifier for the campaign.

getCampaignRef

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

A reference to a Campaign resource.

Specified by:

getCampaignRef in interface ICampaignRef

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getApplicationId

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

The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

setApplicationId

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

The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

getName

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

The name of the campaign.

setName

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

The name of the campaign.

getSchedule

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

The schedule settings for the treatment.

Returns union: either IResolvable or CfnCampaign.ScheduleProperty

setSchedule

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

The schedule settings for the treatment.

setSchedule

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

The schedule settings for the treatment.

getSegmentId

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

The unique identifier for the segment to associate with the campaign.

setSegmentId

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

The unique identifier for the segment to associate with the campaign.

getAdditionalTreatments

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

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCampaign.WriteTreatmentResourceProperty>

setAdditionalTreatments

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

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

setAdditionalTreatments

@Stability(Stable)
public void setAdditionalTreatments(@Nullable
 List<Object> value)

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

getCampaignHook

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

Specifies the Lambda function to use as a code hook for a campaign.

Returns union: either IResolvable or CfnCampaign.CampaignHookProperty

setCampaignHook

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

Specifies the Lambda function to use as a code hook for a campaign.

setCampaignHook

@Stability(Stable)
public void setCampaignHook(@Nullable
 CfnCampaign.CampaignHookProperty value)

Specifies the Lambda function to use as a code hook for a campaign.

getCustomDeliveryConfiguration

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

The delivery configuration settings for sending the treatment through a custom channel.

Returns union: either IResolvable or CfnCampaign.CustomDeliveryConfigurationProperty

setCustomDeliveryConfiguration

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

The delivery configuration settings for sending the treatment through a custom channel.

setCustomDeliveryConfiguration

@Stability(Stable)
public void setCustomDeliveryConfiguration(@Nullable
 CfnCampaign.CustomDeliveryConfigurationProperty value)

The delivery configuration settings for sending the treatment through a custom channel.

getDescription

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

A custom description of the campaign.

setDescription

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

A custom description of the campaign.

getHoldoutPercent

@Stability(Stable)
@Nullable
public Number getHoldoutPercent()

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

setHoldoutPercent

@Stability(Stable)
public void setHoldoutPercent(@Nullable
 Number value)

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

getIsPaused

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

Specifies whether to pause the campaign.

Returns union: either Boolean or IResolvable

setIsPaused

@Stability(Stable)
public void setIsPaused(@Nullable
 Boolean value)

Specifies whether to pause the campaign.

setIsPaused

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

Specifies whether to pause the campaign.

getLimits

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

The messaging limits for the campaign.

Returns union: either IResolvable or CfnCampaign.LimitsProperty

setLimits

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

The messaging limits for the campaign.

setLimits

@Stability(Stable)
public void setLimits(@Nullable
 CfnCampaign.LimitsProperty value)

The messaging limits for the campaign.

getMessageConfiguration

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

The message configuration settings for the treatment.

Returns union: either IResolvable or CfnCampaign.MessageConfigurationProperty

setMessageConfiguration

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

The message configuration settings for the treatment.

setMessageConfiguration

@Stability(Stable)
public void setMessageConfiguration(@Nullable
 CfnCampaign.MessageConfigurationProperty value)

The message configuration settings for the treatment.

getPriority

@Stability(Stable)
@Nullable
public Number getPriority()

An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

setPriority

@Stability(Stable)
public void setPriority(@Nullable
 Number value)

An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

getSegmentVersion

@Stability(Stable)
@Nullable
public Number getSegmentVersion()

The version of the segment to associate with the campaign.

setSegmentVersion

@Stability(Stable)
public void setSegmentVersion(@Nullable
 Number value)

The version of the segment to associate with the campaign.

getTagsRaw

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

An array of key-value pairs to apply to this resource.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Object value)

An array of key-value pairs to apply to this resource.

getTemplateConfiguration

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

The message template to use for the treatment.

Returns union: either IResolvable or CfnCampaign.TemplateConfigurationProperty

setTemplateConfiguration

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

The message template to use for the treatment.

setTemplateConfiguration

@Stability(Stable)
public void setTemplateConfiguration(@Nullable
 CfnCampaign.TemplateConfigurationProperty value)

The message template to use for the treatment.

getTreatmentDescription

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

A custom description of the treatment.

setTreatmentDescription

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

A custom description of the treatment.

getTreatmentName

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

A custom name for the treatment.

setTreatmentName

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

A custom name for the treatment.