class CfnCampaign (construct)

Language	Type name
.NET	Amazon.CDK.AWS.IoTFleetWise.CfnCampaign
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotfleetwise#CfnCampaign
Java	software.amazon.awscdk.services.iotfleetwise.CfnCampaign
Python	aws_cdk.aws_iotfleetwise.CfnCampaign
TypeScript	aws-cdk-lib » aws_iotfleetwise » CfnCampaign

Implements IConstruct, IDependable, IInspectable, ICampaignRef, ITaggable

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 { aws_iotfleetwise as iotfleetwise } from 'aws-cdk-lib';
const cfnCampaign = new iotfleetwise.CfnCampaign(this, 'MyCfnCampaign', {
  collectionScheme: {
    conditionBasedCollectionScheme: {
      expression: 'expression',

      // the properties below are optional
      conditionLanguageVersion: 123,
      minimumTriggerIntervalMs: 123,
      triggerMode: 'triggerMode',
    },
    timeBasedCollectionScheme: {
      periodMs: 123,
    },
  },
  name: 'name',
  signalCatalogArn: 'signalCatalogArn',
  targetArn: 'targetArn',

  // the properties below are optional
  action: 'action',
  compression: 'compression',
  dataDestinationConfigs: [{
    mqttTopicConfig: {
      executionRoleArn: 'executionRoleArn',
      mqttTopicArn: 'mqttTopicArn',
    },
    s3Config: {
      bucketArn: 'bucketArn',

      // the properties below are optional
      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',
    },

    // the properties below are optional
    uploadOptions: {
      expression: 'expression',

      // the properties below are optional
      conditionLanguageVersion: 123,
    },
  }],
  description: 'description',
  diagnosticsMode: 'diagnosticsMode',
  expiryTime: 'expiryTime',
  postTriggerCollectionDuration: 123,
  priority: 123,
  signalsToCollect: [{
    name: 'name',

    // the properties below are optional
    dataPartitionId: 'dataPartitionId',
    maxSampleCount: 123,
    minimumSamplingIntervalMs: 123,
  }],
  signalsToFetch: [{
    actions: ['actions'],
    fullyQualifiedName: 'fullyQualifiedName',
    signalFetchConfig: {
      conditionBased: {
        conditionExpression: 'conditionExpression',
        triggerMode: 'triggerMode',
      },
      timeBased: {
        executionFrequencyMs: 123,
      },
    },

    // the properties below are optional
    conditionLanguageVersion: 123,
  }],
  spoolingMode: 'spoolingMode',
  startTime: 'startTime',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCampaign(scope: Construct, id: string, props: CfnCampaignProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnCampaignProps — Resource properties.

Construct Props

Name	Type	Description
collectionScheme	IResolvable | CollectionSchemeProperty	The data collection scheme associated with the campaign.
name	string	The name of a campaign.
signalCatalogArn	string	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
targetArn	string	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
action?	string	Specifies how to update a campaign. The action can be one of the following:.
compression?	string	Whether to compress signals before transmitting data to AWS IoT FleetWise .
dataDestinationConfigs?	IResolvable | (IResolvable | DataDestinationConfigProperty)[]	The destination where the campaign sends data.
dataExtraDimensions?	string[]	A list of vehicle attributes to associate with a campaign.
dataPartitions?	IResolvable | (IResolvable | DataPartitionProperty)[]	The data partitions associated with the signals collected from the vehicle.
description?	string	The description of the campaign.
diagnosticsMode?	string	Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
expiryTime?	string	The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
postTriggerCollectionDuration?	number	How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
priority?	number	A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
signalsToCollect?	IResolvable | (IResolvable | SignalInformationProperty)[]	A list of information about signals to collect.
signalsToFetch?	IResolvable | (IResolvable | SignalFetchInformationProperty)[]	A list of information about signals to fetch.
spoolingMode?	string	Whether to store collected data after a vehicle lost a connection with the cloud.
startTime?	string	The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.
tags?	CfnTag[]	Metadata that can be used to manage the campaign.

---

collectionScheme

Type: IResolvable | CollectionSchemeProperty

The data collection scheme associated with the campaign.

You can specify a scheme that collects data based on time or an event.

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

---

name

Type: string

The name of a campaign.

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

---

signalCatalogArn

Type: string

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

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

---

targetArn

Type: string

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

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

---

action?

Type: string (optional)

Specifies how to update a campaign. The action can be one of the following:.

• APPROVE - To approve delivering a data collection scheme to vehicles.
• SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.
• RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.
• UPDATE - To update a campaign.

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

---

compression?

Type: string (optional, default: "OFF")

Whether to compress signals before transmitting data to AWS IoT FleetWise .

If you don't want to compress the signals, use OFF . If it's not specified, SNAPPY is used.

Default: SNAPPY

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

---

dataDestinationConfigs?

Type: IResolvable | (IResolvable | DataDestinationConfigProperty)[] (optional)

The destination where the campaign sends data.

You can choose to send data to be stored in Amazon S3 or Amazon Timestream .

Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. AWS IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple AWS IoT FleetWise servers for redundancy and high availability.

You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

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

---

dataExtraDimensions?

Type: string[] (optional)

A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream . You can then query the data against make and model .

Default: An empty array

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

---

dataPartitions?

Type: IResolvable | (IResolvable | DataPartitionProperty)[] (optional)

The data partitions associated with the signals collected from the vehicle.

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

---

description?

Type: string (optional)

The description of the campaign.

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

---

diagnosticsMode?

Type: string (optional, default: "OFF")

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS . If it's not specified, OFF is used.

Default: OFF

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

---

expiryTime?

Type: string (optional, default: "253402214400")

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

Vehicle data isn't collected after the campaign expires.

Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

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

---

postTriggerCollectionDuration?

Type: number (optional, default: 0)

How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

If it's not specified, 0 is used.

Default: 0

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

---

priority?

Type: number (optional, default: 0)

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

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

---

signalsToCollect?

Type: IResolvable | (IResolvable | SignalInformationProperty)[] (optional)

A list of information about signals to collect.

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

---

signalsToFetch?

Type: IResolvable | (IResolvable | SignalFetchInformationProperty)[] (optional)

A list of information about signals to fetch.

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

---

spoolingMode?

Type: string (optional, default: "OFF")

Whether to store collected data after a vehicle lost a connection with the cloud.

After a connection is re-established, the data is automatically forwarded to AWS IoT FleetWise . If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK . If it's not specified, OFF is used.

Default: OFF

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

---

startTime?

Type: string (optional, default: "0")

The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

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

---

tags?

Type: CfnTag[] (optional)

Metadata that can be used to manage the campaign.

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

Properties

Name	Type	Description
attrArn	string	The Amazon Resource Name (ARN) of the campaign.
attrCreationTime	string	The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
attrLastModificationTime	string	The last time the campaign was modified.
attrStatus	string	The state of the campaign.
campaignRef	CampaignReference	A reference to a Campaign resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
collectionScheme	IResolvable | CollectionSchemeProperty	The data collection scheme associated with the campaign.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
name	string	The name of a campaign.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
signalCatalogArn	string	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
targetArn	string	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
action?	string	Specifies how to update a campaign.
compression?	string	Whether to compress signals before transmitting data to AWS IoT FleetWise .
dataDestinationConfigs?	IResolvable | (IResolvable | DataDestinationConfigProperty)[]	The destination where the campaign sends data.
dataExtraDimensions?	string[]	A list of vehicle attributes to associate with a campaign.
dataPartitions?	IResolvable | (IResolvable | DataPartitionProperty)[]	The data partitions associated with the signals collected from the vehicle.
description?	string	The description of the campaign.
diagnosticsMode?	string	Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
expiryTime?	string	The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
postTriggerCollectionDuration?	number	How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
priority?	number	A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
signalsToCollect?	IResolvable | (IResolvable | SignalInformationProperty)[]	A list of information about signals to collect.
signalsToFetch?	IResolvable | (IResolvable | SignalFetchInformationProperty)[]	A list of information about signals to fetch.
spoolingMode?	string	Whether to store collected data after a vehicle lost a connection with the cloud.
startTime?	string	The time, in milliseconds, to deliver a campaign after it was approved.
tagsRaw?	CfnTag[]	Metadata that can be used to manage the campaign.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The Amazon Resource Name (ARN) of the campaign.

---

attrCreationTime

Type: string

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

---

attrLastModificationTime

Type: string

The last time the campaign was modified.

---

attrStatus

Type: string

The state of the campaign.

The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .

---

campaignRef

Type: CampaignReference

A reference to a Campaign resource.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

collectionScheme

Type: IResolvable | CollectionSchemeProperty

The data collection scheme associated with the campaign.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

name

Type: string

The name of a campaign.

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

signalCatalogArn

Type: string

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

targetArn

Type: string

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

---

action?

Type: string (optional)

Specifies how to update a campaign.

The action can be one of the following:.

---

compression?

Type: string (optional)

Whether to compress signals before transmitting data to AWS IoT FleetWise .

---

dataDestinationConfigs?

Type: IResolvable | (IResolvable | DataDestinationConfigProperty)[] (optional)

The destination where the campaign sends data.

---

dataExtraDimensions?

Type: string[] (optional)

A list of vehicle attributes to associate with a campaign.

---

dataPartitions?

Type: IResolvable | (IResolvable | DataPartitionProperty)[] (optional)

The data partitions associated with the signals collected from the vehicle.

---

description?

Type: string (optional)

The description of the campaign.

---

diagnosticsMode?

Type: string (optional)

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

---

expiryTime?

Type: string (optional)

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

---

postTriggerCollectionDuration?

Type: number (optional)

How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

---

priority?

Type: number (optional)

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

---

signalsToCollect?

Type: IResolvable | (IResolvable | SignalInformationProperty)[] (optional)

A list of information about signals to collect.

---

signalsToFetch?

Type: IResolvable | (IResolvable | SignalFetchInformationProperty)[] (optional)

A list of information about signals to fetch.

---

spoolingMode?

Type: string (optional)

Whether to store collected data after a vehicle lost a connection with the cloud.

---

startTime?

Type: string (optional)

The time, in milliseconds, to deliver a campaign after it was approved.

If it's not specified, 0 is used.

---

tagsRaw?

Type: CfnTag[] (optional)

Metadata that can be used to manage the campaign.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)
static fromCampaignArn(scope, id, arn)	Creates a new ICampaignRef from an ARN.
static fromCampaignName(scope, id, campaignName)	Creates a new ICampaignRef from a campaignName.

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): (Stack | CfnResource)[]

Returns

• (Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }

---

static fromCampaignArn(scope, id, arn)

public static fromCampaignArn(scope: Construct, id: string, arn: string): ICampaignRef

Parameters

• scope Construct
• id string
• arn string

Returns

• ICampaignRef

Creates a new ICampaignRef from an ARN.

---

static fromCampaignName(scope, id, campaignName)

public static fromCampaignName(scope: Construct, id: string, campaignName: string): ICampaignRef

Parameters

• scope Construct
• id string
• campaignName string

Returns

• ICampaignRef

Creates a new ICampaignRef from a campaignName.