class CfnCampaignPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTFleetWise.Mixins.CfnCampaignPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotfleetwise/mixins#CfnCampaignPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iotfleetwise.mixins.CfnCampaignPropsMixin
Python	aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnCampaignPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iotfleetwise » mixins » CfnCampaignPropsMixin

Implements IMixin

Extends Mixin

Creates an orchestration of data collection rules.

The AWS IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, AWS IoT FleetWise automatically deploys them to vehicles.

For more information, see Campaigns in the AWS IoT FleetWise Developer Guide .

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as iotfleetwise_mixins } from '@aws-cdk/mixins-preview/aws-iotfleetwise';
const cfnCampaignPropsMixin = new iotfleetwise_mixins.CfnCampaignPropsMixin({
  action: 'action',
  collectionScheme: {
    conditionBasedCollectionScheme: {
      conditionLanguageVersion: 123,
      expression: 'expression',
      minimumTriggerIntervalMs: 123,
      triggerMode: 'triggerMode',
    },
    timeBasedCollectionScheme: {
      periodMs: 123,
    },
  },
  compression: 'compression',
  dataDestinationConfigs: [{
    mqttTopicConfig: {
      executionRoleArn: 'executionRoleArn',
      mqttTopicArn: 'mqttTopicArn',
    },
    s3Config: {
      bucketArn: 'bucketArn',
      dataFormat: 'dataFormat',
      prefix: 'prefix',
      storageCompressionFormat: 'storageCompressionFormat',
    },
    timestreamConfig: {
      executionRoleArn: 'executionRoleArn',
      timestreamTableArn: 'timestreamTableArn',
    },
  }],
  dataExtraDimensions: ['dataExtraDimensions'],
  dataPartitions: [{
    id: 'id',
    storageOptions: {
      maximumSize: {
        unit: 'unit',
        value: 123,
      },
      minimumTimeToLive: {
        unit: 'unit',
        value: 123,
      },
      storageLocation: 'storageLocation',
    },
    uploadOptions: {
      conditionLanguageVersion: 123,
      expression: 'expression',
    },
  }],
  description: 'description',
  diagnosticsMode: 'diagnosticsMode',
  expiryTime: 'expiryTime',
  name: 'name',
  postTriggerCollectionDuration: 123,
  priority: 123,
  signalCatalogArn: 'signalCatalogArn',
  signalsToCollect: [{
    dataPartitionId: 'dataPartitionId',
    maxSampleCount: 123,
    minimumSamplingIntervalMs: 123,
    name: 'name',
  }],
  signalsToFetch: [{
    actions: ['actions'],
    conditionLanguageVersion: 123,
    fullyQualifiedName: 'fullyQualifiedName',
    signalFetchConfig: {
      conditionBased: {
        conditionExpression: 'conditionExpression',
        triggerMode: 'triggerMode',
      },
      timeBased: {
        executionFrequencyMs: 123,
      },
    },
  }],
  spoolingMode: 'spoolingMode',
  startTime: 'startTime',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetArn: 'targetArn',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnCampaignPropsMixin(props: CfnCampaignMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCampaignMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.

Properties

Name	Type	Description
props	CfnCampaignMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCampaignMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.