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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.877Z")
 @Stability(value=Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::Campaign`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCampaign.AttributeDimensionProperty
static class	CfnCampaign.Builder A fluent builder for CfnCampaign.
static interface	CfnCampaign.CampaignEmailMessageProperty
static interface	CfnCampaign.CampaignEventFilterProperty
static interface	CfnCampaign.CampaignHookProperty
static interface	CfnCampaign.CampaignSmsMessageProperty
static interface	CfnCampaign.EventDimensionsProperty
static interface	CfnCampaign.LimitsProperty
static interface	CfnCampaign.MessageConfigurationProperty
static interface	CfnCampaign.MessageProperty
static interface	CfnCampaign.MetricDimensionProperty
static interface	CfnCampaign.QuietTimeProperty
static interface	CfnCampaign.ScheduleProperty
static interface	CfnCampaign.SetDimensionProperty
static interface	CfnCampaign.WriteTreatmentResourceProperty

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCampaign(software.constructs.Construct scope, String id, CfnCampaignProps props) Create a new `AWS::Pinpoint::Campaign`.
protected	CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdditionalTreatments() `AWS::Pinpoint::Campaign.AdditionalTreatments`.
String	getApplicationId() `AWS::Pinpoint::Campaign.ApplicationId`.
String	getAttrArn()
String	getAttrCampaignId()
Object	getCampaignHook() `AWS::Pinpoint::Campaign.CampaignHook`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::Pinpoint::Campaign.Description`.
Number	getHoldoutPercent() `AWS::Pinpoint::Campaign.HoldoutPercent`.
Object	getIsPaused() `AWS::Pinpoint::Campaign.IsPaused`.
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`.
Number	getSegmentVersion() `AWS::Pinpoint::Campaign.SegmentVersion`.
TagManager	getTags() `AWS::Pinpoint::Campaign.Tags`.
String	getTreatmentDescription() `AWS::Pinpoint::Campaign.TreatmentDescription`.
String	getTreatmentName() `AWS::Pinpoint::Campaign.TreatmentName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalTreatments(IResolvable value) `AWS::Pinpoint::Campaign.AdditionalTreatments`.
void	setAdditionalTreatments(List<Object> value) `AWS::Pinpoint::Campaign.AdditionalTreatments`.
void	setApplicationId(String value) `AWS::Pinpoint::Campaign.ApplicationId`.
void	setCampaignHook(CfnCampaign.CampaignHookProperty value) `AWS::Pinpoint::Campaign.CampaignHook`.
void	setCampaignHook(IResolvable value) `AWS::Pinpoint::Campaign.CampaignHook`.
void	setDescription(String value) `AWS::Pinpoint::Campaign.Description`.
void	setHoldoutPercent(Number value) `AWS::Pinpoint::Campaign.HoldoutPercent`.
void	setIsPaused(Boolean value) `AWS::Pinpoint::Campaign.IsPaused`.
void	setIsPaused(IResolvable value) `AWS::Pinpoint::Campaign.IsPaused`.
void	setLimits(CfnCampaign.LimitsProperty value) `AWS::Pinpoint::Campaign.Limits`.
void	setLimits(IResolvable value) `AWS::Pinpoint::Campaign.Limits`.
void	setMessageConfiguration(CfnCampaign.MessageConfigurationProperty value) `AWS::Pinpoint::Campaign.MessageConfiguration`.
void	setMessageConfiguration(IResolvable value) `AWS::Pinpoint::Campaign.MessageConfiguration`.
void	setName(String value) `AWS::Pinpoint::Campaign.Name`.
void	setSchedule(CfnCampaign.ScheduleProperty value) `AWS::Pinpoint::Campaign.Schedule`.
void	setSchedule(IResolvable value) `AWS::Pinpoint::Campaign.Schedule`.
void	setSegmentId(String value) `AWS::Pinpoint::Campaign.SegmentId`.
void	setSegmentVersion(Number value) `AWS::Pinpoint::Campaign.SegmentVersion`.
void	setTreatmentDescription(String value) `AWS::Pinpoint::Campaign.TreatmentDescription`.
void	setTreatmentName(String value) `AWS::Pinpoint::Campaign.TreatmentName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCampaign

protected CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)

CfnCampaign

protected CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCampaign

@Stability(value=Stable)
public CfnCampaign(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnCampaignProps props)

Create a new `AWS::Pinpoint::Campaign`.

Parameters:

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.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

getAttrCampaignId

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

getApplicationId

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

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

setApplicationId

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

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

getMessageConfiguration

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

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

setMessageConfiguration

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

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

setMessageConfiguration

@Stability(value=Stable)
public void setMessageConfiguration(@NotNull
                                                             IResolvable value)

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

getName

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

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

setName

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

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

getSchedule

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

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

setSchedule

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

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

setSchedule

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

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

getSegmentId

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

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

setSegmentId

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

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

getAdditionalTreatments

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

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

setAdditionalTreatments

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

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

setAdditionalTreatments

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

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

getCampaignHook

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

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

setCampaignHook

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

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

setCampaignHook

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

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

getDescription

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

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

setDescription

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

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

getHoldoutPercent

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

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

setHoldoutPercent

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

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

getIsPaused

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

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

setIsPaused

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

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

setIsPaused

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

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

getLimits

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

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

setLimits

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

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

setLimits

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

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

getSegmentVersion

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

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

setSegmentVersion

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

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

getTreatmentDescription

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

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

setTreatmentDescription

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

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

getTreatmentName

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

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

setTreatmentName

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

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