TopicState class
Input properties used for looking up and filtering Topic resources.
Constructors
-
TopicState({Input<
String?> ? applicationFailureFeedbackRoleArn, Input<String?> ? applicationSuccessFeedbackRoleArn, Input<int?> ? applicationSuccessFeedbackSampleRate, Input<String?> ? archivePolicy, Input<String?> ? arn, Input<String?> ? beginningArchiveTime, Input<bool?> ? contentBasedDeduplication, Input<String?> ? deliveryPolicy, Input<String?> ? displayName, Input<String?> ? fifoThroughputScope, Input<bool?> ? fifoTopic, Input<String?> ? firehoseFailureFeedbackRoleArn, Input<String?> ? firehoseSuccessFeedbackRoleArn, Input<int?> ? firehoseSuccessFeedbackSampleRate, Input<String?> ? httpFailureFeedbackRoleArn, Input<String?> ? httpSuccessFeedbackRoleArn, Input<int?> ? httpSuccessFeedbackSampleRate, Input<String?> ? kmsMasterKeyId, Input<String?> ? lambdaFailureFeedbackRoleArn, Input<String?> ? lambdaSuccessFeedbackRoleArn, Input<int?> ? lambdaSuccessFeedbackSampleRate, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? owner, Input<String?> ? policy, Input<String?> ? region, Input<int?> ? signatureVersion, Input<String?> ? sqsFailureFeedbackRoleArn, Input<String?> ? sqsSuccessFeedbackRoleArn, Input<int?> ? sqsSuccessFeedbackSampleRate, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? tracingConfig}) -
Creates a new TopicState.
applicationFailureFeedbackRoleArnIAM role for failure feedbackapplicationSuccessFeedbackRoleArnThe IAM role permitted to receive success feedback for this topicapplicationSuccessFeedbackSampleRatePercentage of success to samplearchivePolicyThe message archive policy for FIFO topics. More details in the AWS documentation.arnThe ARN of the SNS topic, as a more obvious property (clone of id)beginningArchiveTimeThe oldest timestamp at which a FIFO topic subscriber can start a replay.contentBasedDeduplicationEnables content-based deduplication for FIFO topics. For more information, see the related documentationdeliveryPolicyThe SNS delivery policy. More details in the AWS documentation.displayNameThe display name for the topicfifoThroughputScopeEnables higher throughput for FIFO topics by adjusting the scope of deduplication. This attribute has two possible values,TopicandMessageGroup. For more information, see the related documentation.fifoTopicBoolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default isfalse.firehoseFailureFeedbackRoleArnIAM role for failure feedbackfirehoseSuccessFeedbackRoleArnThe IAM role permitted to receive success feedback for this topicfirehoseSuccessFeedbackSampleRatePercentage of success to samplehttpFailureFeedbackRoleArnIAM role for failure feedbackhttpSuccessFeedbackRoleArnThe IAM role permitted to receive success feedback for this topichttpSuccessFeedbackSampleRatePercentage of success to samplekmsMasterKeyIdThe ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key TermslambdaFailureFeedbackRoleArnIAM role for failure feedbacklambdaSuccessFeedbackRoleArnThe IAM role permitted to receive success feedback for this topiclambdaSuccessFeedbackSampleRatePercentage of success to samplenameThe name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the.fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefixnamePrefixCreates a unique name beginning with the specified prefix. Conflicts withnameownerThe AWS Account ID of the SNS topic ownerpolicyThe fully-formed AWS policy as JSON.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.signatureVersionIfSignatureVersionshould be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.sqsFailureFeedbackRoleArnIAM role for failure feedbacksqsSuccessFeedbackRoleArnThe IAM role permitted to receive success feedback for this topicsqsSuccessFeedbackSampleRatePercentage of success to sampletagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.tracingConfigTracing mode of an Amazon SNS topic. Valid values:"PassThrough","Active".const -
TopicState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applicationFailureFeedbackRoleArn
→ Input<
String?> ? -
IAM role for failure feedback
final
-
applicationSuccessFeedbackRoleArn
→ Input<
String?> ? -
The IAM role permitted to receive success feedback for this topic
final
-
applicationSuccessFeedbackSampleRate
→ Input<
int?> ? -
Percentage of success to sample
final
-
archivePolicy
→ Input<
String?> ? -
The message archive policy for FIFO topics. More details in the AWS documentation.
final
-
arn
→ Input<
String?> ? -
The ARN of the SNS topic, as a more obvious property (clone of id)
final
-
beginningArchiveTime
→ Input<
String?> ? -
The oldest timestamp at which a FIFO topic subscriber can start a replay.
final
-
contentBasedDeduplication
→ Input<
bool?> ? -
Enables content-based deduplication for FIFO topics. For more information, see the related documentation
final
-
deliveryPolicy
→ Input<
String?> ? -
The SNS delivery policy. More details in the AWS documentation.
final
-
displayName
→ Input<
String?> ? -
The display name for the topic
final
-
fifoThroughputScope
→ Input<
String?> ? -
Enables higher throughput for FIFO topics by adjusting the scope of deduplication. This attribute has two possible values,
TopicandMessageGroup. For more information, see the related documentation.final -
fifoTopic
→ Input<
bool?> ? -
Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false.final -
firehoseFailureFeedbackRoleArn
→ Input<
String?> ? -
IAM role for failure feedback
final
-
firehoseSuccessFeedbackRoleArn
→ Input<
String?> ? -
The IAM role permitted to receive success feedback for this topic
final
-
firehoseSuccessFeedbackSampleRate
→ Input<
int?> ? -
Percentage of success to sample
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpFailureFeedbackRoleArn
→ Input<
String?> ? -
IAM role for failure feedback
final
-
httpSuccessFeedbackRoleArn
→ Input<
String?> ? -
The IAM role permitted to receive success feedback for this topic
final
-
httpSuccessFeedbackSampleRate
→ Input<
int?> ? -
Percentage of success to sample
final
-
kmsMasterKeyId
→ Input<
String?> ? -
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms
final
-
lambdaFailureFeedbackRoleArn
→ Input<
String?> ? -
IAM role for failure feedback
final
-
lambdaSuccessFeedbackRoleArn
→ Input<
String?> ? -
The IAM role permitted to receive success feedback for this topic
final
-
lambdaSuccessFeedbackSampleRate
→ Input<
int?> ? -
Percentage of success to sample
final
-
name
→ Input<
String?> ? -
The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefixfinal -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified prefix. Conflicts with
namefinal -
owner
→ Input<
String?> ? -
The AWS Account ID of the SNS topic owner
final
-
policy
→ Input<
String?> ? -
The fully-formed AWS policy as JSON.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
signatureVersion
→ Input<
int?> ? -
If
SignatureVersionshould be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.final -
sqsFailureFeedbackRoleArn
→ Input<
String?> ? -
IAM role for failure feedback
final
-
sqsSuccessFeedbackRoleArn
→ Input<
String?> ? -
The IAM role permitted to receive success feedback for this topic
final
-
sqsSuccessFeedbackSampleRate
→ Input<
int?> ? -
Percentage of success to sample
final
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
tracingConfig
→ Input<
String?> ? -
Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough","Active".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