interface CfnSubscriptionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SNS.CfnSubscriptionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssns#CfnSubscriptionProps |
![]() | software.amazon.awscdk.services.sns.CfnSubscriptionProps |
![]() | aws_cdk.aws_sns.CfnSubscriptionProps |
![]() | aws-cdk-lib » aws_sns » CfnSubscriptionProps |
Properties for defining a CfnSubscription
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';
declare const deliveryPolicy: any;
declare const filterPolicy: any;
declare const redrivePolicy: any;
declare const replayPolicy: any;
const cfnSubscriptionProps: sns.CfnSubscriptionProps = {
protocol: 'protocol',
topicArn: 'topicArn',
// the properties below are optional
deliveryPolicy: deliveryPolicy,
endpoint: 'endpoint',
filterPolicy: filterPolicy,
filterPolicyScope: 'filterPolicyScope',
rawMessageDelivery: false,
redrivePolicy: redrivePolicy,
region: 'region',
replayPolicy: replayPolicy,
subscriptionRoleArn: 'subscriptionRoleArn',
};
Properties
Name | Type | Description |
---|---|---|
protocol | string | The subscription's protocol. |
topic | string | The ARN of the topic to subscribe to. |
delivery | any | The delivery policy JSON assigned to the subscription. |
endpoint? | string | The subscription's endpoint. |
filter | any | The filter policy JSON assigned to the subscription. |
filter | string | This attribute lets you choose the filtering scope by using one of the following string value types:. |
raw | boolean | IResolvable | When set to true , enables raw message delivery. |
redrive | any | When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. |
region? | string | For cross-region subscriptions, the region in which the topic resides. |
replay | any | Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes. |
subscription | string | This property applies only to Amazon Data Firehose delivery stream subscriptions. |
protocol
Type:
string
The subscription's protocol.
For more information, see the Protocol
parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .
topicArn
Type:
string
The ARN of the topic to subscribe to.
deliveryPolicy?
Type:
any
(optional)
The delivery policy JSON assigned to the subscription.
Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)
in the Amazon SNS API Reference and Message delivery retries in the Amazon SNS Developer Guide .
endpoint?
Type:
string
(optional)
The subscription's endpoint.
The endpoint value depends on the protocol that you specify. For more information, see the Endpoint
parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html)
action in the Amazon SNS API Reference .
filterPolicy?
Type:
any
(optional)
The filter policy JSON assigned to the subscription.
Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)
in the Amazon SNS API Reference and Message filtering in the Amazon SNS Developer Guide .
filterPolicyScope?
Type:
string
(optional)
This attribute lets you choose the filtering scope by using one of the following string value types:.
MessageAttributes
(default) - The filter is applied on the message attributes.MessageBody
- The filter is applied on the message body.
Null
is not a valid value forFilterPolicyScope
. To delete a filter policy, delete theFilterPolicy
property but keepFilterPolicyScope
property as is.
rawMessageDelivery?
Type:
boolean |
IResolvable
(optional)
When set to true
, enables raw message delivery.
Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)
in the Amazon SNS API Reference .
redrivePolicy?
Type:
any
(optional)
When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .
region?
Type:
string
(optional)
For cross-region subscriptions, the region in which the topic resides.
If no region is specified, AWS CloudFormation uses the region of the caller as the default.
If you perform an update operation that only updates the Region
property of a AWS::SNS::Subscription
resource, that operation will fail unless you are either:
- Updating the
Region
fromNULL
to the caller region. - Updating the
Region
from the caller region toNULL
.
replayPolicy?
Type:
any
(optional)
Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
subscriptionRoleArn?
Type:
string
(optional)
This property applies only to Amazon Data Firehose delivery stream subscriptions.
Specify the ARN of the IAM role that has the following:
- Permission to write to the Amazon Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon SNS Developer Guide.