aws-cdk-lib.aws_stepfunctions_tasks.MessageAttribute

MessageAttribute Struct

A message attribute to add to the SNS message.

Source

aws-stepfunctions-tasks/lib/sns/publish.ts

Example

const topic = new sns.Topic(this, 'Topic');

// Use a field from the execution data as message.
const task1 = new tasks.SnsPublish(this, 'Publish1', {
  topic,
  integrationPattern: sfn.IntegrationPattern.REQUEST_RESPONSE,
  message: sfn.TaskInput.fromDataAt('$.state.message'),
  messageAttributes: {
    place: {
      value: sfn.JsonPath.stringAt('$.place'),
    },
    pic: {
      // BINARY must be explicitly set
      dataType: tasks.MessageAttributeDataType.BINARY,
      value: sfn.JsonPath.stringAt('$.pic'),
    },
    people: {
      value: 4,
    },
    handles: {
      value: ['@kslater', '@jjf', null, '@mfanning'],
    },
  },
});

// Combine a field from the execution data with
// a literal object.
const task2 = new tasks.SnsPublish(this, 'Publish2', {
  topic,
  message: sfn.TaskInput.fromObject({
    field1: 'somedata',
    field2: sfn.JsonPath.stringAt('$.field2'),
  }),
});

Properties

dataTypeMessageAttributeDataTypedata_typeMessageAttributeDataTypedataTypeMessageAttributeDataTypeDataTypeMessageAttributeDataTypeDataTypeMessageAttributeDataType= determined by type inspection if…#

The data type for the attribute.

default

Default: determined by type inspection if possible, fallback is String

valueanyvalueAnyvalueObjectValueobjectValueinterface{}required#

The value of the attribute.