Skip to content
v2.275.0

SnsParametersProperty Struct Added in v2.275.0 ​

Parameters for publishing events to an Amazon SNS topic target.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const snsParametersProperty: eventsv2.CfnSubscriber.SnsParametersProperty = {
  messageAttributes: {
    messageAttributesKey: {
      dataType: 'dataType',

      // the properties below are optional
      binaryValue: 'binaryValue',
      stringValue: 'stringValue',
    },
  },
  messageDeduplicationId: 'messageDeduplicationId',
  messageGroupId: 'messageGroupId',
  messageStructure: 'messageStructure',
  subject: 'subject',
};

Properties ​

messageAttributesoptionalIResolvable | { [key: string]: IResolvable | CfnSubscriber.MessageAttributeValueProperty }message_attributesoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, MessageAttributeValueProperty]]]messageAttributesoptionalIResolvableMessageAttributesoptionalIResolvableMessageAttributesoptionalinterface{}#
A map of message attribute names to values, with at most 50 attributes.

Amazon SQS and Amazon SNS enforce their own per-message attribute limits on delivery.

messageDeduplicationIdoptionalstringmessage_deduplication_idoptionalstrmessageDeduplicationIdoptionalStringMessageDeduplicationIdoptionalstringMessageDeduplicationIdoptional*string#
The message deduplication ID to use when the target is a FIFO topic.

Accepts a literal value or a JSONata expression.

messageGroupIdoptionalstringmessage_group_idoptionalstrmessageGroupIdoptionalStringMessageGroupIdoptionalstringMessageGroupIdoptional*string#
The message group ID to use when the target is a FIFO topic.

Accepts a literal value or a JSONata expression.

messageStructureoptionalstringmessage_structureoptionalstrmessageStructureoptionalStringMessageStructureoptionalstringMessageStructureoptional*string#
Set to json to send a different message per delivery protocol.

Accepts a literal value or a JSONata expression.

subjectoptionalstringsubjectoptionalstrsubjectoptionalStringSubjectoptionalstringSubjectoptional*string#
The subject line to use for email-protocol subscriptions.

Accepts a literal value or a JSONata expression.