software.amazon.awscdk.services.iotfleetwise

Class CfnCampaign

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iotfleetwise.CfnCampaign

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:50.864Z")
 @Stability(value=Stable)
public class CfnCampaign
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTFleetWise::Campaign`.

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.iotfleetwise.*;
 CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
         .action("action")
         .collectionScheme(CollectionSchemeProperty.builder()
                 .conditionBasedCollectionScheme(ConditionBasedCollectionSchemeProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .conditionLanguageVersion(123)
                         .minimumTriggerIntervalMs(123)
                         .triggerMode("triggerMode")
                         .build())
                 .timeBasedCollectionScheme(TimeBasedCollectionSchemeProperty.builder()
                         .periodMs(123)
                         .build())
                 .build())
         .name("name")
         .signalCatalogArn("signalCatalogArn")
         .targetArn("targetArn")
         // the properties below are optional
         .compression("compression")
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .description("description")
         .diagnosticsMode("diagnosticsMode")
         .expiryTime("expiryTime")
         .postTriggerCollectionDuration(123)
         .priority(123)
         .signalsToCollect(List.of(SignalInformationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .maxSampleCount(123)
                 .minimumSamplingIntervalMs(123)
                 .build()))
         .spoolingMode("spoolingMode")
         .startTime("startTime")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCampaign.Builder A fluent builder for CfnCampaign.
static interface	CfnCampaign.CollectionSchemeProperty Example:
static interface	CfnCampaign.ConditionBasedCollectionSchemeProperty Example:
static interface	CfnCampaign.SignalInformationProperty Example:
static interface	CfnCampaign.TimeBasedCollectionSchemeProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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(Construct scope, String id, CfnCampaignProps props) Create a new `AWS::IoTFleetWise::Campaign`.
protected	CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAction() `AWS::IoTFleetWise::Campaign.Action`.
String	getAttrArn()
String	getAttrCreationTime()
String	getAttrLastModificationTime()
String	getAttrStatus()
protected Map<String,Object>	getCfnProperties()
Object	getCollectionScheme() `AWS::IoTFleetWise::Campaign.CollectionScheme`.
String	getCompression() `AWS::IoTFleetWise::Campaign.Compression`.
List<String>	getDataExtraDimensions() `AWS::IoTFleetWise::Campaign.DataExtraDimensions`.
String	getDescription() `AWS::IoTFleetWise::Campaign.Description`.
String	getDiagnosticsMode() `AWS::IoTFleetWise::Campaign.DiagnosticsMode`.
String	getExpiryTime() `AWS::IoTFleetWise::Campaign.ExpiryTime`.
String	getName() `AWS::IoTFleetWise::Campaign.Name`.
Number	getPostTriggerCollectionDuration() `AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.
Number	getPriority() `AWS::IoTFleetWise::Campaign.Priority`.
String	getSignalCatalogArn() `AWS::IoTFleetWise::Campaign.SignalCatalogArn`.
Object	getSignalsToCollect() `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
String	getSpoolingMode() `AWS::IoTFleetWise::Campaign.SpoolingMode`.
String	getStartTime() `AWS::IoTFleetWise::Campaign.StartTime`.
TagManager	getTags() `AWS::IoTFleetWise::Campaign.Tags`.
String	getTargetArn() `AWS::IoTFleetWise::Campaign.TargetArn`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAction(String value) `AWS::IoTFleetWise::Campaign.Action`.
void	setCollectionScheme(CfnCampaign.CollectionSchemeProperty value) `AWS::IoTFleetWise::Campaign.CollectionScheme`.
void	setCollectionScheme(IResolvable value) `AWS::IoTFleetWise::Campaign.CollectionScheme`.
void	setCompression(String value) `AWS::IoTFleetWise::Campaign.Compression`.
void	setDataExtraDimensions(List<String> value) `AWS::IoTFleetWise::Campaign.DataExtraDimensions`.
void	setDescription(String value) `AWS::IoTFleetWise::Campaign.Description`.
void	setDiagnosticsMode(String value) `AWS::IoTFleetWise::Campaign.DiagnosticsMode`.
void	setExpiryTime(String value) `AWS::IoTFleetWise::Campaign.ExpiryTime`.
void	setName(String value) `AWS::IoTFleetWise::Campaign.Name`.
void	setPostTriggerCollectionDuration(Number value) `AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.
void	setPriority(Number value) `AWS::IoTFleetWise::Campaign.Priority`.
void	setSignalCatalogArn(String value) `AWS::IoTFleetWise::Campaign.SignalCatalogArn`.
void	setSignalsToCollect(IResolvable value) `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
void	setSignalsToCollect(List<Object> value) `AWS::IoTFleetWise::Campaign.SignalsToCollect`.
void	setSpoolingMode(String value) `AWS::IoTFleetWise::Campaign.SpoolingMode`.
void	setStartTime(String value) `AWS::IoTFleetWise::Campaign.StartTime`.
void	setTargetArn(String value) `AWS::IoTFleetWise::Campaign.TargetArn`.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnCampaignProps props)

Create a new `AWS::IoTFleetWise::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()

getAttrCreationTime

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

getAttrLastModificationTime

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

getAttrStatus

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::IoTFleetWise::Campaign.Tags`.

getAction

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

`AWS::IoTFleetWise::Campaign.Action`.

setAction

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

`AWS::IoTFleetWise::Campaign.Action`.

getCollectionScheme

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

`AWS::IoTFleetWise::Campaign.CollectionScheme`.

setCollectionScheme

@Stability(value=Stable)
public void setCollectionScheme(@NotNull
                                                         CfnCampaign.CollectionSchemeProperty value)

`AWS::IoTFleetWise::Campaign.CollectionScheme`.

setCollectionScheme

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

`AWS::IoTFleetWise::Campaign.CollectionScheme`.

getName

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

`AWS::IoTFleetWise::Campaign.Name`.

setName

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

`AWS::IoTFleetWise::Campaign.Name`.

getSignalCatalogArn

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

`AWS::IoTFleetWise::Campaign.SignalCatalogArn`.

setSignalCatalogArn

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

`AWS::IoTFleetWise::Campaign.SignalCatalogArn`.

getTargetArn

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

`AWS::IoTFleetWise::Campaign.TargetArn`.

setTargetArn

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

`AWS::IoTFleetWise::Campaign.TargetArn`.

getCompression

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

`AWS::IoTFleetWise::Campaign.Compression`.

setCompression

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

`AWS::IoTFleetWise::Campaign.Compression`.

getDataExtraDimensions

@Stability(value=Stable)
 @Nullable
public List<String> getDataExtraDimensions()

`AWS::IoTFleetWise::Campaign.DataExtraDimensions`.

setDataExtraDimensions

@Stability(value=Stable)
public void setDataExtraDimensions(@Nullable
                                                            List<String> value)

`AWS::IoTFleetWise::Campaign.DataExtraDimensions`.

getDescription

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

`AWS::IoTFleetWise::Campaign.Description`.

setDescription

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

`AWS::IoTFleetWise::Campaign.Description`.

getDiagnosticsMode

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

`AWS::IoTFleetWise::Campaign.DiagnosticsMode`.

setDiagnosticsMode

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

`AWS::IoTFleetWise::Campaign.DiagnosticsMode`.

getExpiryTime

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

`AWS::IoTFleetWise::Campaign.ExpiryTime`.

setExpiryTime

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

`AWS::IoTFleetWise::Campaign.ExpiryTime`.

getPostTriggerCollectionDuration

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

`AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.

setPostTriggerCollectionDuration

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

`AWS::IoTFleetWise::Campaign.PostTriggerCollectionDuration`.

getPriority

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

`AWS::IoTFleetWise::Campaign.Priority`.

setPriority

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

`AWS::IoTFleetWise::Campaign.Priority`.

getSignalsToCollect

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

`AWS::IoTFleetWise::Campaign.SignalsToCollect`.

setSignalsToCollect

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

`AWS::IoTFleetWise::Campaign.SignalsToCollect`.

setSignalsToCollect

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

`AWS::IoTFleetWise::Campaign.SignalsToCollect`.

getSpoolingMode

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

`AWS::IoTFleetWise::Campaign.SpoolingMode`.

setSpoolingMode

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

`AWS::IoTFleetWise::Campaign.SpoolingMode`.

getStartTime

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

`AWS::IoTFleetWise::Campaign.StartTime`.

setStartTime

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

`AWS::IoTFleetWise::Campaign.StartTime`.