Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnCampaignMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnCampaignMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnCampaignMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCampaignMixinProps

@Stability(Stable)
@Internal
public static final class CfnCampaignMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCampaignMixinProps

An implementation for CfnCampaignMixinProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnCampaignMixinProps

CfnCampaignMixinProps.Builder, CfnCampaignMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCampaignMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCampaignMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAdditionalTreatments()	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
final String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
final Object	getCampaignHook()	Specifies the Lambda function to use as a code hook for a campaign.
final Object	getCustomDeliveryConfiguration()	The delivery configuration settings for sending the treatment through a custom channel.
final String	getDescription()	A custom description of the campaign.
final Number	getHoldoutPercent()	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
final Object	getIsPaused()	Specifies whether to pause the campaign.
final Object	getLimits()	The messaging limits for the campaign.
final Object	getMessageConfiguration()	The message configuration settings for the treatment.
final String	getName()	The name of the campaign.
final 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.
final Object	getSchedule()	The schedule settings for the treatment.
final String	getSegmentId()	The unique identifier for the segment to associate with the campaign.
final Number	getSegmentVersion()	The version of the segment to associate with the campaign.
final Object	getTags()	An array of key-value pairs to apply to this resource.
final Object	getTemplateConfiguration()	The message template to use for the treatment.
final String	getTreatmentDescription()	A custom description of the treatment.
final String	getTreatmentName()	A custom name for the treatment.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCampaignMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCampaignMixinProps.Builder.

Method Details

getAdditionalTreatments

public final Object getAdditionalTreatments()

Description copied from interface: CfnCampaignMixinProps

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 CfnCampaignPropsMixin.WriteTreatmentResourceProperty>

Specified by:

getAdditionalTreatments in interface CfnCampaignMixinProps

See Also:

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

getApplicationId

public final String getApplicationId()

Description copied from interface: CfnCampaignMixinProps

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

Specified by:

getApplicationId in interface CfnCampaignMixinProps

See Also:

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

getCampaignHook

public final Object getCampaignHook()

Description copied from interface: CfnCampaignMixinProps

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

Returns union: either IResolvable or CfnCampaignPropsMixin.CampaignHookProperty

Specified by:

getCampaignHook in interface CfnCampaignMixinProps

See Also:

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

getCustomDeliveryConfiguration

public final Object getCustomDeliveryConfiguration()

Description copied from interface: CfnCampaignMixinProps

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

This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

Returns union: either IResolvable or CfnCampaignPropsMixin.CustomDeliveryConfigurationProperty

Specified by:

getCustomDeliveryConfiguration in interface CfnCampaignMixinProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnCampaignMixinProps

A custom description of the campaign.

Specified by:

getDescription in interface CfnCampaignMixinProps

See Also:

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

getHoldoutPercent

public final Number getHoldoutPercent()

Description copied from interface: CfnCampaignMixinProps

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

Specified by:

getHoldoutPercent in interface CfnCampaignMixinProps

See Also:

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

getIsPaused

public final Object getIsPaused()

Description copied from interface: CfnCampaignMixinProps

Specifies whether to pause the campaign.

A paused campaign doesn't run unless you resume it by changing this value to false . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

Returns union: either Boolean or IResolvable

Specified by:

getIsPaused in interface CfnCampaignMixinProps

See Also:

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

getLimits

public final Object getLimits()

Description copied from interface: CfnCampaignMixinProps

The messaging limits for the campaign.

Returns union: either IResolvable or CfnCampaignPropsMixin.LimitsProperty

Specified by:

getLimits in interface CfnCampaignMixinProps

See Also:

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

getMessageConfiguration

public final Object getMessageConfiguration()

Description copied from interface: CfnCampaignMixinProps

The message configuration settings for the treatment.

Returns union: either IResolvable or CfnCampaignPropsMixin.MessageConfigurationProperty

Specified by:

getMessageConfiguration in interface CfnCampaignMixinProps

See Also:

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

getName

public final String getName()

Description copied from interface: CfnCampaignMixinProps

The name of the campaign.

Specified by:

getName in interface CfnCampaignMixinProps

See Also:

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

getPriority

public final Number getPriority()

Description copied from interface: CfnCampaignMixinProps

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.

If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

Specified by:

getPriority in interface CfnCampaignMixinProps

See Also:

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

getSchedule

public final Object getSchedule()

Description copied from interface: CfnCampaignMixinProps

The schedule settings for the treatment.

Returns union: either IResolvable or CfnCampaignPropsMixin.ScheduleProperty

Specified by:

getSchedule in interface CfnCampaignMixinProps

See Also:

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

getSegmentId

public final String getSegmentId()

Description copied from interface: CfnCampaignMixinProps

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

Specified by:

getSegmentId in interface CfnCampaignMixinProps

See Also:

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

getSegmentVersion

public final Number getSegmentVersion()

Description copied from interface: CfnCampaignMixinProps

The version of the segment to associate with the campaign.

Specified by:

getSegmentVersion in interface CfnCampaignMixinProps

See Also:

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

getTags

public final Object getTags()

Description copied from interface: CfnCampaignMixinProps

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

For more information, see Tag .

Specified by:

getTags in interface CfnCampaignMixinProps

See Also:

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

getTemplateConfiguration

public final Object getTemplateConfiguration()

Description copied from interface: CfnCampaignMixinProps

The message template to use for the treatment.

Returns union: either IResolvable or CfnCampaignPropsMixin.TemplateConfigurationProperty

Specified by:

getTemplateConfiguration in interface CfnCampaignMixinProps

See Also:

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

getTreatmentDescription

public final String getTreatmentDescription()

Description copied from interface: CfnCampaignMixinProps

A custom description of the treatment.

Specified by:

getTreatmentDescription in interface CfnCampaignMixinProps

See Also:

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

getTreatmentName

public final String getTreatmentName()

Description copied from interface: CfnCampaignMixinProps

A custom name for the treatment.

Specified by:

getTreatmentName in interface CfnCampaignMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object