software.amazon.awscdk.services.pinpoint

Interface CfnCampaignProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaignProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:38.417Z")
 @Stability(value=Stable)
public interface CfnCampaignProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Pinpoint::Campaign`.

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCampaignProps.Builder A builder for CfnCampaignProps
static class	CfnCampaignProps.Jsii$Proxy An implementation for CfnCampaignProps

Method Summary

Modifier and Type	Method and Description
static CfnCampaignProps.Builder	builder()
default Object	getAdditionalTreatments() `AWS::Pinpoint::Campaign.AdditionalTreatments`.
String	getApplicationId() `AWS::Pinpoint::Campaign.ApplicationId`.
default Object	getCampaignHook() `AWS::Pinpoint::Campaign.CampaignHook`.
default String	getDescription() `AWS::Pinpoint::Campaign.Description`.
default Number	getHoldoutPercent() `AWS::Pinpoint::Campaign.HoldoutPercent`.
default Object	getIsPaused() `AWS::Pinpoint::Campaign.IsPaused`.
default Object	getLimits() `AWS::Pinpoint::Campaign.Limits`.
Object	getMessageConfiguration() `AWS::Pinpoint::Campaign.MessageConfiguration`.
String	getName() `AWS::Pinpoint::Campaign.Name`.
Object	getSchedule() `AWS::Pinpoint::Campaign.Schedule`.
String	getSegmentId() `AWS::Pinpoint::Campaign.SegmentId`.
default Number	getSegmentVersion() `AWS::Pinpoint::Campaign.SegmentVersion`.
default Object	getTags() `AWS::Pinpoint::Campaign.Tags`.
default String	getTreatmentDescription() `AWS::Pinpoint::Campaign.TreatmentDescription`.
default String	getTreatmentName() `AWS::Pinpoint::Campaign.TreatmentName`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApplicationId

@Stability(value=Stable)
 @NotNull
String getApplicationId()

`AWS::Pinpoint::Campaign.ApplicationId`.

See Also:

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

getMessageConfiguration

@Stability(value=Stable)
 @NotNull
Object getMessageConfiguration()

`AWS::Pinpoint::Campaign.MessageConfiguration`.

See Also:

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

getName

@Stability(value=Stable)
 @NotNull
String getName()

`AWS::Pinpoint::Campaign.Name`.

See Also:

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

getSchedule

@Stability(value=Stable)
 @NotNull
Object getSchedule()

`AWS::Pinpoint::Campaign.Schedule`.

See Also:

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

getSegmentId

@Stability(value=Stable)
 @NotNull
String getSegmentId()

`AWS::Pinpoint::Campaign.SegmentId`.

See Also:

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

getAdditionalTreatments

@Stability(value=Stable)
 @Nullable
default Object getAdditionalTreatments()

`AWS::Pinpoint::Campaign.AdditionalTreatments`.

See Also:

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

getCampaignHook

@Stability(value=Stable)
 @Nullable
default Object getCampaignHook()

`AWS::Pinpoint::Campaign.CampaignHook`.

See Also:

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

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::Pinpoint::Campaign.Description`.

See Also:

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

getHoldoutPercent

@Stability(value=Stable)
 @Nullable
default Number getHoldoutPercent()

`AWS::Pinpoint::Campaign.HoldoutPercent`.

See Also:

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

getIsPaused

@Stability(value=Stable)
 @Nullable
default Object getIsPaused()

`AWS::Pinpoint::Campaign.IsPaused`.

See Also:

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

getLimits

@Stability(value=Stable)
 @Nullable
default Object getLimits()

`AWS::Pinpoint::Campaign.Limits`.

See Also:

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

getSegmentVersion

@Stability(value=Stable)
 @Nullable
default Number getSegmentVersion()

`AWS::Pinpoint::Campaign.SegmentVersion`.

See Also:

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

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

`AWS::Pinpoint::Campaign.Tags`.

See Also:

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

getTreatmentDescription

@Stability(value=Stable)
 @Nullable
default String getTreatmentDescription()

`AWS::Pinpoint::Campaign.TreatmentDescription`.

See Also:

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

getTreatmentName

@Stability(value=Stable)
 @Nullable
default String getTreatmentName()

`AWS::Pinpoint::Campaign.TreatmentName`.

See Also:

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

builder

@Stability(value=Stable)
static CfnCampaignProps.Builder builder()

Returns:

a CfnCampaignProps.Builder of CfnCampaignProps