TopicSubscriptionArgs class

The set of arguments for TopicSubscription. The set of arguments for TopicSubscription.

Constructors

TopicSubscriptionArgs({Input<int?>? confirmationTimeoutInMinutes, Input<String?>? deliveryPolicy, required Input<String> endpoint, Input<bool?>? endpointAutoConfirms, Input<String?>? filterPolicy, Input<String?>? filterPolicyScope, required Input<String> protocol, Input<bool?>? rawMessageDelivery, Input<String?>? redrivePolicy, Input<String?>? region, Input<String?>? replayPolicy, Input<String?>? subscriptionRoleArn, required Input topic})
Creates a new TopicSubscriptionArgs. confirmationTimeoutInMinutes Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1. deliveryPolicy JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details. endpoint Endpoint to send data to. The contents vary with the protocol. See details below. endpointAutoConfirms Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false. filterPolicy JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details. filterPolicyScope Whether the filterPolicy applies to MessageAttributes (default) or MessageBody. protocol Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below. rawMessageDelivery Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false. redrivePolicy JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. replayPolicy JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details. subscriptionRoleArn ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs. topic ARN of the SNS topic to subscribe to.
const
TopicSubscriptionArgs.fromMap(Map<String, dynamic> map)
factory

Properties

confirmationTimeoutInMinutes → Input<int?>?
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
final
deliveryPolicy → Input<String?>?
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
final
endpoint → Input<String>
Endpoint to send data to. The contents vary with the protocol. See details below.
final
endpointAutoConfirms → Input<bool?>?
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
final
filterPolicy → Input<String?>?
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
final
filterPolicyScope → Input<String?>?
Whether the filterPolicy applies to MessageAttributes (default) or MessageBody.
final
hashCode → int
The hash code for this object.
no setterinherited
protocol → Input<String>
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
final
rawMessageDelivery → Input<bool?>?
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
final
redrivePolicy → Input<String?>?
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replayPolicy → Input<String?>?
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subscriptionRoleArn → Input<String?>?
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
final
topic → Input
ARN of the SNS topic to subscribe to.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited