vector/sinks/aws_s_s/
config.rs

1use std::convert::TryFrom;
2
3use snafu::{ResultExt, Snafu};
4
5use vector_lib::configurable::configurable_component;
6
7use crate::{
8    aws::AwsAuthentication,
9    codecs::EncodingConfig,
10    config::AcknowledgementsConfig,
11    sinks::util::TowerRequestConfig,
12    template::{Template, TemplateParseError},
13    tls::TlsConfig,
14};
15
16#[derive(Debug, Snafu)]
17pub(super) enum BuildError {
18    #[snafu(display("`message_group_id` should be defined for FIFO queue."))]
19    MessageGroupIdMissing,
20    #[snafu(display("`message_group_id` is not allowed with non-FIFO queue."))]
21    MessageGroupIdNotAllowed,
22    #[snafu(display("invalid topic template: {}", source))]
23    TopicTemplate { source: TemplateParseError },
24}
25
26/// Base Configuration `aws_s_s` for sns and sqs sink.
27#[configurable_component]
28#[derive(Clone, Debug)]
29#[serde(deny_unknown_fields)]
30pub(super) struct BaseSSSinkConfig {
31    #[configurable(derived)]
32    pub(super) encoding: EncodingConfig,
33
34    /// The tag that specifies that a message belongs to a specific message group.
35    ///
36    /// Can be applied only to FIFO queues.
37    #[configurable(metadata(docs::examples = "vector"))]
38    #[configurable(metadata(docs::examples = "vector-%Y-%m-%d"))]
39    pub(super) message_group_id: Option<String>,
40
41    /// The message deduplication ID value to allow AWS to identify duplicate messages.
42    ///
43    /// This value is a template which should result in a unique string for each event. See the [AWS
44    /// documentation][deduplication_id_docs] for more about how AWS does message deduplication.
45    ///
46    /// [deduplication_id_docs]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
47    #[configurable(metadata(docs::examples = "{{ transaction_id }}"))]
48    pub(super) message_deduplication_id: Option<String>,
49
50    #[configurable(derived)]
51    #[serde(default)]
52    pub(super) request: TowerRequestConfig,
53
54    #[configurable(derived)]
55    pub(super) tls: Option<TlsConfig>,
56
57    /// The ARN of an [IAM role][iam_role] to assume at startup.
58    ///
59    /// [iam_role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html
60    #[configurable(deprecated)]
61    #[configurable(metadata(docs::hidden))]
62    pub(super) assume_role: Option<String>,
63
64    #[configurable(derived)]
65    #[serde(default)]
66    pub(super) auth: AwsAuthentication,
67
68    #[configurable(derived)]
69    #[serde(
70        default,
71        deserialize_with = "crate::serde::bool_or_struct",
72        skip_serializing_if = "crate::serde::is_default"
73    )]
74    pub(super) acknowledgements: AcknowledgementsConfig,
75}
76
77pub(super) fn message_group_id(
78    message_group_id: Option<String>,
79    fifo: bool,
80) -> crate::Result<Option<Template>> {
81    match (message_group_id.as_ref(), fifo) {
82        (Some(value), true) => Ok(Some(
83            Template::try_from(value.clone()).context(TopicTemplateSnafu)?,
84        )),
85        (Some(_), false) => Err(Box::new(BuildError::MessageGroupIdNotAllowed)),
86        (None, true) => Err(Box::new(BuildError::MessageGroupIdMissing)),
87        (None, false) => Ok(None),
88    }
89}
90pub(super) fn message_deduplication_id(
91    message_deduplication_id: Option<String>,
92) -> crate::Result<Option<Template>> {
93    Ok(message_deduplication_id
94        .clone()
95        .map(Template::try_from)
96        .transpose()?)
97}
vector/sinks/aws_s_s/config.rs

vector/sinks/aws_s_s/
config.rs
