TopicSubscriptionState class
Input properties used for looking up and filtering TopicSubscription resources.
Constructors
-
TopicSubscriptionState({Input<
String?> ? arn, Input<int?> ? confirmationTimeoutInMinutes, Input<bool?> ? confirmationWasAuthenticated, Input<String?> ? deliveryPolicy, Input<String?> ? endpoint, Input<bool?> ? endpointAutoConfirms, Input<String?> ? filterPolicy, Input<String?> ? filterPolicyScope, Input<String?> ? ownerId, Input<bool?> ? pendingConfirmation, Input<String?> ? protocol, Input<bool?> ? rawMessageDelivery, Input<String?> ? redrivePolicy, Input<String?> ? region, Input<String?> ? replayPolicy, Input<String?> ? subscriptionRoleArn, Input? topic}) -
Creates a new TopicSubscriptionState.
arnARN of the subscription.confirmationTimeoutInMinutesInteger 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 is1.confirmationWasAuthenticatedWhether the subscription confirmation request was authenticated.deliveryPolicyJSON 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.endpointEndpoint to send data to. The contents vary with the protocol. See details below.endpointAutoConfirmsWhether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default isfalse.filterPolicyJSON 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.filterPolicyScopeWhether thefilterPolicyapplies toMessageAttributes(default) orMessageBody.ownerIdAWS account ID of the subscription's owner.pendingConfirmationWhether the subscription has not been confirmed.protocolProtocol to use. Valid values are:sqs,sms,lambda,firehose, andapplication. Protocolsemail,email-json,httpandhttpsare also valid but partially supported. See details below.rawMessageDeliveryWhether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default isfalse.redrivePolicyJSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.replayPolicyJSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.subscriptionRoleArnARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.topicARN of the SNS topic to subscribe to.const -
TopicSubscriptionState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the subscription.
final
-
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 -
confirmationWasAuthenticated
→ Input<
bool?> ? -
Whether the subscription confirmation request was authenticated.
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
filterPolicyapplies toMessageAttributes(default) orMessageBody.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
ownerId
→ Input<
String?> ? -
AWS account ID of the subscription's owner.
final
-
pendingConfirmation
→ Input<
bool?> ? -
Whether the subscription has not been confirmed.
final
-
protocol
→ Input<
String?> ? -
Protocol to use. Valid values are:
sqs,sms,lambda,firehose, andapplication. Protocolsemail,email-json,httpandhttpsare 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